Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson
, '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" + '
Adds DASH and PORT env vars by OwenMatsuda · Pull Request #1134 · plotly/dash · GitHub
Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson
, '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('^' + ".*" + ' Adds DASH and PORT env vars by OwenMatsuda · Pull Request #1134 · plotly/dash · GitHub
Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson
, '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('^' + ".*" + ' Adds DASH and PORT env vars by OwenMatsuda · Pull Request #1134 · plotly/dash · GitHub
Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson
, '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" + ' Adds DASH and PORT env vars by OwenMatsuda · Pull Request #1134 · plotly/dash · GitHub
Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson
, '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('^' + ".*" + ' Adds DASH and PORT env vars by OwenMatsuda · Pull Request #1134 · plotly/dash · GitHub
Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson
, '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('^' + ".*" + ' Adds DASH and PORT env vars by OwenMatsuda · Pull Request #1134 · plotly/dash · GitHub
Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson
, '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); } })(); })(); Adds DASH and PORT env vars by OwenMatsuda · Pull Request #1134 · plotly/dash · GitHub
Skip to content

Adds DASH and PORT env vars - #1134

Merged
alexcjohnson merged 2 commits into
devfrom
host-port-env
Mar 20, 2020
Merged

Adds DASH and PORT env vars#1134
alexcjohnson merged 2 commits into
devfrom
host-port-env

Conversation

@OwenMatsuda

Copy link
Copy Markdown
Contributor

This PR adds the ability to set a DASH_HOST environment variable to change the host value when running the server.

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Alright, after way too much discussion with @josegonzalez and @rpkyle I'm on board with this change. Looks like you just have to adjust the usage re the test failure:

dash/dash.py:1913:13: W1508: os.getenv default type is builtins.int. Expected str or None. (invalid-envvar-default)

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int. Then we just need a CHANGELOG entry for the new options and I think this will be ready to 💃

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

And let's give it some helpful behavior if you fail to provide an int or a string that can be coerced to an int.

@alexcjohnson What kind of helpful behavior do you think? Should it just default to the 8050 port, or should it throw an error?

@alexcjohnson

Copy link
Copy Markdown
Collaborator

Throw an error like "Expecting an integer from 1 to 65535, found {}".format(repr(port)) (only including the range if you actually verify that, which would be a nice touch)

@OwenMatsuda
OwenMatsudaforce-pushed the host-port-env branch 3 times, most recently from 846f445 to da3f4ffCompareMarch 3, 2020 20:18
@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I think this is ready for review. My only potential concern is that for port, when the user inputs it as a parameter within app.runserver(port=8050), port is an int. However, when grabbing it from an environment variable, port is a string that is later coerced into an int within the try/except block.

Comment threaddash/dash.py

:param port: Port used to serve the application
env: ``PORT``
:type port: int

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just mark port here as either an int or a string containing an int, and we should be covered re: data types. Your coercion and try/except below looks great!

Can you please add a couple of tests of the failure cases, and maybe one of setting an integer string port and verifying that an app shows up there? These can probably all go in https://github.com/plotly/dash/blob/dev/tests/unit/test_configs.py

The failures can just be something like:

app=Dash()
app.layout=html.Div()
withpytest.raises(...) asexcinfo:
app.run_server(port="garbage")
assertexcinfo.value== ...

And the pass case can be something like:

app=Dash()
app.layout=html.Div("hi", id="out")
dash_duo.run_server(app, port="12345")
assertdash_duo.server_url=="https://127.0.0.1:12345"dash_duo.wait_for_text_to_equal("out", "hi")

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I'm trying to use pytest's monkeypatch to mock env vars, but I'm running into a bug: pytest-dev/pytest#6858

@alexcjohnson

Copy link
Copy Markdown
Collaborator

There's a fixture empty_environ at the top of the test_configs file - does that help?

@OwenMatsuda

Copy link
Copy Markdown
ContributorAuthor

I saw that, but that would mean adding the env vars HOST AND PORT to dash/_configs.py. At first, I thought that would make more sense than the setup I have now, but then I noticed a problem:

env=load_dash_env_vars().get('DASH_{}'.format(name.upper()))
ifenvisNone:
returndefault

Unless we wanted to add another function specific to HOST and PORT, we would have to rename them to DASH_HOST, and DASH_PORT, respectively, which would be misaligned with plotly/dashR#167.

Along those same lines, I was wondering what the "parity" with Dash for Python was since the HOST and PORT didn't previously exist.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Beautiful. 💃

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.

2 participants

@OwenMatsuda@alexcjohnson