Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Issue 480 - Add .map file extension support to dash by Marc-Andre-Rivet · Pull Request #478 · plotly/dash · GitHub
Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Issue 480 - Add .map file extension support to dash by Marc-Andre-Rivet · Pull Request #478 · plotly/dash · GitHub
Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Issue 480 - Add .map file extension support to dash by Marc-Andre-Rivet · Pull Request #478 · plotly/dash · GitHub
Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Issue 480 - Add .map file extension support to dash by Marc-Andre-Rivet · Pull Request #478 · plotly/dash · GitHub
Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Issue 480 - Add .map file extension support to dash by Marc-Andre-Rivet · Pull Request #478 · plotly/dash · GitHub
Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Issue 480 - Add .map file extension support to dash by Marc-Andre-Rivet · Pull Request #478 · plotly/dash · GitHub
Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Issue 480 - Add .map file extension support to dash by Marc-Andre-Rivet · Pull Request #478 · plotly/dash · GitHub
Skip to content

Issue 480 - Add .map file extension support to dash - #478

Merged
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files
Dec 7, 2018
Merged

Issue 480 - Add .map file extension support to dash#478
Marc-Andre-Rivet merged 8 commits into
masterfrom
dash-support-map-files

Conversation

@Marc-Andre-Rivet

@Marc-Andre-RivetMarc-Andre-Rivet commented Dec 5, 2018

Copy link
Copy Markdown
Contributor

Fixes#480.

Adding support for .js.map files in Dash so source map file is accessible from browser when available

Also, adding basic support for dynamic file loading. Otherwise the map gets injected as a script in the page, killing perf and just being generally useless!

Comment threaddash/dash.py
Comment threaddash/dash.py
@Marc-Andre-RivetMarc-Andre-Rivet changed the title add map file support to dashIssue 480 - Add .map file extension support to dashDec 6, 2018
@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n I've created an issue to track this PR in a more normal manner and linking it above in the description. Also updated the changelog. As it should have been done from the start :)

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

@T4rk1n Created #481 for followup discussion on supporting arbitrary file extensions.

Comment threaddash/dash.py Outdated
is_dynamic_resource = (
'dynamic' in resource and
resource['dynamic'] is True
)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred indentation pattern is for Python -- went with something that seemed natural with the syntax

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No () and single line, we prefer explicit: if 'dynamic' in resources and resource.get('dynamic'). Also .get over [key] to avoid unnecessary KeyErrors. Only use is for comparing pointer references, ie is None to assert null and not just falsy.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this because the line is too long for flake8's taste.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I one line this and make flake8 happy? Apart from an actual function, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break them using \ at the end of the line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the same error from pylint

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now this.. dash/dash.py:355:4: R0912: Too many branches (13/12) (too-many-branches

I guess the additional if triggered this rule.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer if cond to is True, is True is when you need to assert that it the actual True and not another type that evaluate to True in a condition like a string.

@Marc-Andre-RivetMarc-Andre-RivetDec 6, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Misread! No need for the explicit comparison... all good haha

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add # pylint: disable=too-many-branches to the start of the function.

Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
)
if not is_dynamic_resource:
srcs.append(path)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here..

Comment threaddash/dash.py Outdated

full = os.path.join(current, f)

print(f)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups! Will remove

Comment threaddash/resources.py
for s in all_resources:
filtered_resource = {}
if 'dynamic' in s:
filtered_resource['dynamic'] = s['dynamic']

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic property needs to survive the sanitation process -- adding it to the list

@rmarren1rmarren1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few code style suggestions -- nothing critical. Also I made a few comments on previous discussions.

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Comment threaddash/dash.py Outdated
resource.get('dynamic')

if 'relative_package_path' in resource:
if isinstance(resource['relative_package_path'], str):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternate way might solve the too-many-branches 🐫

paths = resource['relative_package_path']
paths = [paths] if isinstance(paths, str) else paths
for rel_path in paths:
... the logic that is repeated twice ...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.. I'm in, if only because it makes me learn the language haha!

Comment threaddash/dash.py Outdated

srcs = []
for resource in resources:
is_dynamic_resource = 'dynamic' in resource and \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps resource.get('dynamic', False) so it is not split

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dictionary entry with default I guess?

Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py
Comment threaddash/dash.py Outdated
))
else:
for rel_path in resource['relative_package_path']:
self.registered_paths[resource['namespace']]\

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmarren1 Not sure this is considered correct (escaping with '' in the middle of a chain (as opposed to an 'if' as I've done elsewhere)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean using the \? That is standard to do

Comment threaddash/dash.py
# track the registered packages
self.registered_paths[namespace].add(relative_package_path)

module_path = os.path.join(

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As suggested, moved the side-effect outside of the path calculator and calling it directly below

@Marc-Andre-Rivet

Marc-Andre-Rivet commented Dec 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@rmarren1

I'm also curious what the motivation behind 'dynamic' is? Do the .map files change at run-time independently of the bundles? I always thought they were static content, just static content that shouldn't be added to the <script> tag of a Dash app. Although, I am not sure what a good short word for that is which can be used as a variable name.

Good question. This is 'dynamic' in the same sense as Babel and Webpack defines it -- these files are loaded on a "per need" basis, or dynamically -- not to be confused with the other meaning of dynamic where the files would change at runtime. In that sense 'dynamic' really is the correct word vs. static, as opposed to say 'async'.

This is useful for source maps but also when splitting code into chunks that are only needed if certain features / behaviors are activated. Imagine a hypothetical component that could connect to provider A or B based on some settings -- if these libraries are big, it makes sense to delay the loading of these dependencies to when (and if!) they are needed. This need is already foreseen in the dash-table where certain features will require us to load libraries that are bigger than the table's bundle itself :) Or the more mundane case where you would have images, icon libraries or fonts bigger than a certain threshold not be included in the main chunk but rather stand beside it.

That being said -- I see your point that this could be confusing to users but I don't have a good alternative either. ... 'load_dynamically' or 'dynamic_load' maybe?

@rmarren1

Copy link
Copy Markdown
Contributor

Okay, thanks for the detailed explanation. I didn't know that terminology, but it makes sense to me now: 'dynamic' meaning roughly 'this resource will be dynamically loaded from the front-end when it is needed, so it is not included in the initial <script> tag load'

Thanks for making those changes, looks a lot cleaner now!

💃

@Marc-Andre-Rivet

Copy link
Copy Markdown
ContributorAuthor

Since this evolved from being a small modification (.map support) to adding an entirely new feature (dynamic support) I think we should make this a minor version bump instead of a patch.

@rmarren1

Copy link
Copy Markdown
Contributor

^ Agreed

- update changelog with dynamic
@Marc-Andre-Rivet
Marc-Andre-Rivet merged commit b0ea2f4 into masterDec 7, 2018
@Marc-Andre-Rivet
Marc-Andre-Rivet deleted the dash-support-map-files branch September 25, 2019 10:02
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this pull request Jan 6, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Marc-Andre-Rivet@rmarren1@T4rk1n