Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexcjohnson merged 2 commits into from
Mar 20, 2020
Merged

Adds DASH and PORT env vars #1134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1bbe729
Adds DASH and PORT env vars to run_server
OwenMatsuda Feb 27, 2020
5f72204
Adds port env var tests
OwenMatsuda Mar 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down
2 changes: 2 additions & 0 deletions dash/_configs.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
"DASH_SILENCE_ROUTES_LOGGING",
"DASH_PRUNE_ERRORS",
"DASH_COMPRESS",
"HOST",
"PORT",
)
}
)
Expand Down
21 changes: 18 additions & 3 deletions dash/dash.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

def run_server(
self,
port=8050,
host=os.getenv("HOST", "127.0.0.1"),
port=os.getenv("PORT", "8050"),
debug=False,
dev_tools_ui=None,
dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
If a parameter can be set by an environment variable, that is listed
too. Values provided here take precedence over environment variables.

:param host: Host IP used to serve the application
env: ``HOST``
:type host: string

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

@alexcjohnsonalexcjohnsonMar 4, 2020

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")


:param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
dev_tools_prune_errors,
)

# Verify port value
try:
port = int(port)
assert port in range(1, 65536)
except Exception as e:
e.args = [
"Expecting an integer from 1 to 65535, found port={}".format(repr(port))
]
raise

if self._dev_tools.silence_routes_logging:
# Since it's silenced, the address doesn't show anymore.
host = flask_run_options.get("host", "127.0.0.1")
ssl_context = flask_run_options.get("ssl_context")
self.logger.info(
"Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

self.logger.info("Debugger PIN: %s", debugger_pin)

self.server.run(port=port, debug=debug, **flask_run_options)
self.server.run(host=host, port=port, debug=debug, **flask_run_options)
8 changes: 8 additions & 0 deletions tests/integration/test_integration.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
@app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
def h(a):
return a


def test_inin_024_port_env_success(dash_duo):
app = Dash(__name__)
app.layout = html.Div("hi", "out")
dash_duo.start_server(app, port="12345")
assert dash_duo.server_url == "http://localhost:12345"
dash_duo.wait_for_text_to_equal("#out", "hi")
27 changes: 27 additions & 0 deletions tests/unit/test_configs.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
with pytest.raises(_exc.UnsupportedRelativePath):
strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
app = Dash()
with pytest.raises(Exception) as excinfo:
app.run_server(port="garbage")
assert (
excinfo.exconly()
== "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
)


def test_port_env_fail_range(empty_environ):
app = Dash()
with pytest.raises(Exception) as excinfo:
app.run_server(port="0")
assert (
excinfo.exconly()
== "AssertionError: Expecting an integer from 1 to 65535, found port=0"
)

with pytest.raises(Exception) as excinfo:
app.run_server(port="65536")
assert (
excinfo.exconly()
== "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 2 commits into

from

Mar 20, 2020
 Merged


Adds DASH and PORT env vars
#1134
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1bbe729

Adds DASH and PORT env vars to run_server


OwenMatsuda Feb 27, 2020
5f72204

Adds port env var tests


OwenMatsuda Mar 4, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down

2 changes: 2 additions & 0 deletions
dash/_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
 "DASH_SILENCE_ROUTES_LOGGING",
 "DASH_PRUNE_ERRORS",
 "DASH_COMPRESS",
 "HOST",
 "PORT",
 )
 }
 )
Expand Down

21 changes: 18 additions & 3 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

 def run_server(
 self,
 port=8050,
 host=os.getenv("HOST", "127.0.0.1"),
 port=os.getenv("PORT", "8050"),
 debug=False,
 dev_tools_ui=None,
 dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
 If a parameter can be set by an environment variable, that is listed
 too. Values provided here take precedence over environment variables.

 :param host: Host IP used to serve the application
 env: ``HOST``
 :type host: string

 :param port: Port used to serve the application
 env: ``PORT``
 :type port: int
@alexcjohnsonalexcjohnsonMar 4, 2020

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")

 :param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
 dev_tools_prune_errors,
 )

 # Verify port value
 try:
 port = int(port)
 assert port in range(1, 65536)
 except Exception as e:
 e.args = [
 "Expecting an integer from 1 to 65535, found port={}".format(repr(port))
 ]
 raise

 if self._dev_tools.silence_routes_logging:
 # Since it's silenced, the address doesn't show anymore.
 host = flask_run_options.get("host", "127.0.0.1")
 ssl_context = flask_run_options.get("ssl_context")
 self.logger.info(
 "Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

 self.logger.info("Debugger PIN: %s", debugger_pin)

 self.server.run(port=port, debug=debug, **flask_run_options)
 self.server.run(host=host, port=port, debug=debug, **flask_run_options)

8 changes: 8 additions & 0 deletions
tests/integration/test_integration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
 @app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
 def h(a):
 return a


def test_inin_024_port_env_success(dash_duo):
 app = Dash(__name__)
 app.layout = html.Div("hi", "out")
 dash_duo.start_server(app, port="12345")
 assert dash_duo.server_url == "http://localhost:12345"
 dash_duo.wait_for_text_to_equal("#out", "hi")

27 changes: 27 additions & 0 deletions
tests/unit/test_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
 with pytest.raises(_exc.UnsupportedRelativePath):
 strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="garbage")
 assert (
 excinfo.exconly()
 == "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
 )


def test_port_env_fail_range(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="0")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=0"
 )

 with pytest.raises(Exception) as excinfo:
 app.run_server(port="65536")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 2 commits into

from

Mar 20, 2020
 Merged


Adds DASH and PORT env vars
#1134
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1bbe729

Adds DASH and PORT env vars to run_server


OwenMatsuda Feb 27, 2020
5f72204

Adds port env var tests


OwenMatsuda Mar 4, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down

2 changes: 2 additions & 0 deletions
dash/_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
 "DASH_SILENCE_ROUTES_LOGGING",
 "DASH_PRUNE_ERRORS",
 "DASH_COMPRESS",
 "HOST",
 "PORT",
 )
 }
 )
Expand Down

21 changes: 18 additions & 3 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

 def run_server(
 self,
 port=8050,
 host=os.getenv("HOST", "127.0.0.1"),
 port=os.getenv("PORT", "8050"),
 debug=False,
 dev_tools_ui=None,
 dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
 If a parameter can be set by an environment variable, that is listed
 too. Values provided here take precedence over environment variables.

 :param host: Host IP used to serve the application
 env: ``HOST``
 :type host: string

 :param port: Port used to serve the application
 env: ``PORT``
 :type port: int
@alexcjohnsonalexcjohnsonMar 4, 2020

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")

 :param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
 dev_tools_prune_errors,
 )

 # Verify port value
 try:
 port = int(port)
 assert port in range(1, 65536)
 except Exception as e:
 e.args = [
 "Expecting an integer from 1 to 65535, found port={}".format(repr(port))
 ]
 raise

 if self._dev_tools.silence_routes_logging:
 # Since it's silenced, the address doesn't show anymore.
 host = flask_run_options.get("host", "127.0.0.1")
 ssl_context = flask_run_options.get("ssl_context")
 self.logger.info(
 "Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

 self.logger.info("Debugger PIN: %s", debugger_pin)

 self.server.run(port=port, debug=debug, **flask_run_options)
 self.server.run(host=host, port=port, debug=debug, **flask_run_options)

8 changes: 8 additions & 0 deletions
tests/integration/test_integration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
 @app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
 def h(a):
 return a


def test_inin_024_port_env_success(dash_duo):
 app = Dash(__name__)
 app.layout = html.Div("hi", "out")
 dash_duo.start_server(app, port="12345")
 assert dash_duo.server_url == "http://localhost:12345"
 dash_duo.wait_for_text_to_equal("#out", "hi")

27 changes: 27 additions & 0 deletions
tests/unit/test_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
 with pytest.raises(_exc.UnsupportedRelativePath):
 strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="garbage")
 assert (
 excinfo.exconly()
 == "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
 )


def test_port_env_fail_range(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="0")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=0"
 )

 with pytest.raises(Exception) as excinfo:
 app.run_server(port="65536")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
 )

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

Skip to content
Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 2 commits into

from

Mar 20, 2020
 Merged


Adds DASH and PORT env vars
#1134
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1bbe729

Adds DASH and PORT env vars to run_server


OwenMatsuda Feb 27, 2020
5f72204

Adds port env var tests


OwenMatsuda Mar 4, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down

2 changes: 2 additions & 0 deletions
dash/_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
 "DASH_SILENCE_ROUTES_LOGGING",
 "DASH_PRUNE_ERRORS",
 "DASH_COMPRESS",
 "HOST",
 "PORT",
 )
 }
 )
Expand Down

21 changes: 18 additions & 3 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

 def run_server(
 self,
 port=8050,
 host=os.getenv("HOST", "127.0.0.1"),
 port=os.getenv("PORT", "8050"),
 debug=False,
 dev_tools_ui=None,
 dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
 If a parameter can be set by an environment variable, that is listed
 too. Values provided here take precedence over environment variables.

 :param host: Host IP used to serve the application
 env: ``HOST``
 :type host: string

 :param port: Port used to serve the application
 env: ``PORT``
 :type port: int
@alexcjohnsonalexcjohnsonMar 4, 2020

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")

 :param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
 dev_tools_prune_errors,
 )

 # Verify port value
 try:
 port = int(port)
 assert port in range(1, 65536)
 except Exception as e:
 e.args = [
 "Expecting an integer from 1 to 65535, found port={}".format(repr(port))
 ]
 raise

 if self._dev_tools.silence_routes_logging:
 # Since it's silenced, the address doesn't show anymore.
 host = flask_run_options.get("host", "127.0.0.1")
 ssl_context = flask_run_options.get("ssl_context")
 self.logger.info(
 "Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

 self.logger.info("Debugger PIN: %s", debugger_pin)

 self.server.run(port=port, debug=debug, **flask_run_options)
 self.server.run(host=host, port=port, debug=debug, **flask_run_options)

8 changes: 8 additions & 0 deletions
tests/integration/test_integration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
 @app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
 def h(a):
 return a


def test_inin_024_port_env_success(dash_duo):
 app = Dash(__name__)
 app.layout = html.Div("hi", "out")
 dash_duo.start_server(app, port="12345")
 assert dash_duo.server_url == "http://localhost:12345"
 dash_duo.wait_for_text_to_equal("#out", "hi")

27 changes: 27 additions & 0 deletions
tests/unit/test_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
 with pytest.raises(_exc.UnsupportedRelativePath):
 strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="garbage")
 assert (
 excinfo.exconly()
 == "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
 )


def test_port_env_fail_range(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="0")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=0"
 )

 with pytest.raises(Exception) as excinfo:
 app.run_server(port="65536")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 2 commits into

from

Mar 20, 2020
 Merged


Adds DASH and PORT env vars
#1134
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1bbe729

Adds DASH and PORT env vars to run_server


OwenMatsuda Feb 27, 2020
5f72204

Adds port env var tests


OwenMatsuda Mar 4, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down

2 changes: 2 additions & 0 deletions
dash/_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
 "DASH_SILENCE_ROUTES_LOGGING",
 "DASH_PRUNE_ERRORS",
 "DASH_COMPRESS",
 "HOST",
 "PORT",
 )
 }
 )
Expand Down

21 changes: 18 additions & 3 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

 def run_server(
 self,
 port=8050,
 host=os.getenv("HOST", "127.0.0.1"),
 port=os.getenv("PORT", "8050"),
 debug=False,
 dev_tools_ui=None,
 dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
 If a parameter can be set by an environment variable, that is listed
 too. Values provided here take precedence over environment variables.

 :param host: Host IP used to serve the application
 env: ``HOST``
 :type host: string

 :param port: Port used to serve the application
 env: ``PORT``
 :type port: int
@alexcjohnsonalexcjohnsonMar 4, 2020

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")

 :param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
 dev_tools_prune_errors,
 )

 # Verify port value
 try:
 port = int(port)
 assert port in range(1, 65536)
 except Exception as e:
 e.args = [
 "Expecting an integer from 1 to 65535, found port={}".format(repr(port))
 ]
 raise

 if self._dev_tools.silence_routes_logging:
 # Since it's silenced, the address doesn't show anymore.
 host = flask_run_options.get("host", "127.0.0.1")
 ssl_context = flask_run_options.get("ssl_context")
 self.logger.info(
 "Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

 self.logger.info("Debugger PIN: %s", debugger_pin)

 self.server.run(port=port, debug=debug, **flask_run_options)
 self.server.run(host=host, port=port, debug=debug, **flask_run_options)

8 changes: 8 additions & 0 deletions
tests/integration/test_integration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
 @app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
 def h(a):
 return a


def test_inin_024_port_env_success(dash_duo):
 app = Dash(__name__)
 app.layout = html.Div("hi", "out")
 dash_duo.start_server(app, port="12345")
 assert dash_duo.server_url == "http://localhost:12345"
 dash_duo.wait_for_text_to_equal("#out", "hi")

27 changes: 27 additions & 0 deletions
tests/unit/test_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
 with pytest.raises(_exc.UnsupportedRelativePath):
 strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="garbage")
 assert (
 excinfo.exconly()
 == "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
 )


def test_port_env_fail_range(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="0")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=0"
 )

 with pytest.raises(Exception) as excinfo:
 app.run_server(port="65536")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 2 commits into

from

Mar 20, 2020
 Merged


Adds DASH and PORT env vars
#1134
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1bbe729

Adds DASH and PORT env vars to run_server


OwenMatsuda Feb 27, 2020
5f72204

Adds port env var tests


OwenMatsuda Mar 4, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down

2 changes: 2 additions & 0 deletions
dash/_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
 "DASH_SILENCE_ROUTES_LOGGING",
 "DASH_PRUNE_ERRORS",
 "DASH_COMPRESS",
 "HOST",
 "PORT",
 )
 }
 )
Expand Down

21 changes: 18 additions & 3 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

 def run_server(
 self,
 port=8050,
 host=os.getenv("HOST", "127.0.0.1"),
 port=os.getenv("PORT", "8050"),
 debug=False,
 dev_tools_ui=None,
 dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
 If a parameter can be set by an environment variable, that is listed
 too. Values provided here take precedence over environment variables.

 :param host: Host IP used to serve the application
 env: ``HOST``
 :type host: string

 :param port: Port used to serve the application
 env: ``PORT``
 :type port: int
@alexcjohnsonalexcjohnsonMar 4, 2020

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")

 :param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
 dev_tools_prune_errors,
 )

 # Verify port value
 try:
 port = int(port)
 assert port in range(1, 65536)
 except Exception as e:
 e.args = [
 "Expecting an integer from 1 to 65535, found port={}".format(repr(port))
 ]
 raise

 if self._dev_tools.silence_routes_logging:
 # Since it's silenced, the address doesn't show anymore.
 host = flask_run_options.get("host", "127.0.0.1")
 ssl_context = flask_run_options.get("ssl_context")
 self.logger.info(
 "Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

 self.logger.info("Debugger PIN: %s", debugger_pin)

 self.server.run(port=port, debug=debug, **flask_run_options)
 self.server.run(host=host, port=port, debug=debug, **flask_run_options)

8 changes: 8 additions & 0 deletions
tests/integration/test_integration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
 @app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
 def h(a):
 return a


def test_inin_024_port_env_success(dash_duo):
 app = Dash(__name__)
 app.layout = html.Div("hi", "out")
 dash_duo.start_server(app, port="12345")
 assert dash_duo.server_url == "http://localhost:12345"
 dash_duo.wait_for_text_to_equal("#out", "hi")

27 changes: 27 additions & 0 deletions
tests/unit/test_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
 with pytest.raises(_exc.UnsupportedRelativePath):
 strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="garbage")
 assert (
 excinfo.exconly()
 == "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
 )


def test_port_env_fail_range(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="0")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=0"
 )

 with pytest.raises(Exception) as excinfo:
 app.run_server(port="65536")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 2 commits into

from

Mar 20, 2020
 Merged


Adds DASH and PORT env vars
#1134
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1bbe729

Adds DASH and PORT env vars to run_server


OwenMatsuda Feb 27, 2020
5f72204

Adds port env var tests


OwenMatsuda Mar 4, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down

2 changes: 2 additions & 0 deletions
dash/_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
 "DASH_SILENCE_ROUTES_LOGGING",
 "DASH_PRUNE_ERRORS",
 "DASH_COMPRESS",
 "HOST",
 "PORT",
 )
 }
 )
Expand Down

21 changes: 18 additions & 3 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

 def run_server(
 self,
 port=8050,
 host=os.getenv("HOST", "127.0.0.1"),
 port=os.getenv("PORT", "8050"),
 debug=False,
 dev_tools_ui=None,
 dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
 If a parameter can be set by an environment variable, that is listed
 too. Values provided here take precedence over environment variables.

 :param host: Host IP used to serve the application
 env: ``HOST``
 :type host: string

 :param port: Port used to serve the application
 env: ``PORT``
 :type port: int
@alexcjohnsonalexcjohnsonMar 4, 2020

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")

 :param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
 dev_tools_prune_errors,
 )

 # Verify port value
 try:
 port = int(port)
 assert port in range(1, 65536)
 except Exception as e:
 e.args = [
 "Expecting an integer from 1 to 65535, found port={}".format(repr(port))
 ]
 raise

 if self._dev_tools.silence_routes_logging:
 # Since it's silenced, the address doesn't show anymore.
 host = flask_run_options.get("host", "127.0.0.1")
 ssl_context = flask_run_options.get("ssl_context")
 self.logger.info(
 "Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

 self.logger.info("Debugger PIN: %s", debugger_pin)

 self.server.run(port=port, debug=debug, **flask_run_options)
 self.server.run(host=host, port=port, debug=debug, **flask_run_options)

8 changes: 8 additions & 0 deletions
tests/integration/test_integration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
 @app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
 def h(a):
 return a


def test_inin_024_port_env_success(dash_duo):
 app = Dash(__name__)
 app.layout = html.Div("hi", "out")
 dash_duo.start_server(app, port="12345")
 assert dash_duo.server_url == "http://localhost:12345"
 dash_duo.wait_for_text_to_equal("#out", "hi")

27 changes: 27 additions & 0 deletions
tests/unit/test_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
 with pytest.raises(_exc.UnsupportedRelativePath):
 strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="garbage")
 assert (
 excinfo.exconly()
 == "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
 )


def test_port_env_fail_range(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="0")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=0"
 )

 with pytest.raises(Exception) as excinfo:
 app.run_server(port="65536")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
 )

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

Skip to content
Adds DASH and PORT env vars#1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 2 commits into

from

Mar 20, 2020
 Merged


Adds DASH and PORT env vars
#1134
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1bbe729

Adds DASH and PORT env vars to run_server


OwenMatsuda Feb 27, 2020
5f72204

Adds port env var tests


OwenMatsuda Mar 4, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- [#1134](https://github.com/plotly/dash/pull/1134) Allow `dash.run_server()` host and port parameters to be set with environment variables HOST & PORT, respectively

### Changed
- [#1145](https://github.com/plotly/dash/pull/1145) Update from React 16.8.6 to 16.13.0

Expand Down

2 changes: 2 additions & 0 deletions
dash/_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@ def load_dash_env_vars():
 "DASH_SILENCE_ROUTES_LOGGING",
 "DASH_PRUNE_ERRORS",
 "DASH_COMPRESS",
 "HOST",
 "PORT",
 )
 }
 )
Expand Down

21 changes: 18 additions & 3 deletions
dash/dash.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1841,7 +1841,8 @@ def delete_resource(resources):

 def run_server(
 self,
 port=8050,
 host=os.getenv("HOST", "127.0.0.1"),
 port=os.getenv("PORT", "8050"),
 debug=False,
 dev_tools_ui=None,
 dev_tools_props_check=None,
Expand All@@ -1860,7 +1861,12 @@ def run_server(
 If a parameter can be set by an environment variable, that is listed
 too. Values provided here take precedence over environment variables.

 :param host: Host IP used to serve the application
 env: ``HOST``
 :type host: string

 :param port: Port used to serve the application
 env: ``PORT``
 :type port: int
@alexcjohnsonalexcjohnsonMar 4, 2020

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")

 :param debug: Set Flask debug mode and enable dev tools.
Expand DownExpand Up@@ -1933,9 +1939,18 @@ def run_server(
 dev_tools_prune_errors,
 )

 # Verify port value
 try:
 port = int(port)
 assert port in range(1, 65536)
 except Exception as e:
 e.args = [
 "Expecting an integer from 1 to 65535, found port={}".format(repr(port))
 ]
 raise

 if self._dev_tools.silence_routes_logging:
 # Since it's silenced, the address doesn't show anymore.
 host = flask_run_options.get("host", "127.0.0.1")
 ssl_context = flask_run_options.get("ssl_context")
 self.logger.info(
 "Running on %s://%s:%s%s",
Expand All@@ -1955,4 +1970,4 @@ def run_server(

 self.logger.info("Debugger PIN: %s", debugger_pin)

 self.server.run(port=port, debug=debug, **flask_run_options)
 self.server.run(host=host, port=port, debug=debug, **flask_run_options)

8 changes: 8 additions & 0 deletions
tests/integration/test_integration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -974,3 +974,11 @@ def g2(a):
 @app.callback(Output("inner-div", "children"), [Input("inner-input", "value")])
 def h(a):
 return a


def test_inin_024_port_env_success(dash_duo):
 app = Dash(__name__)
 app.layout = html.Div("hi", "out")
 dash_duo.start_server(app, port="12345")
 assert dash_duo.server_url == "http://localhost:12345"
 dash_duo.wait_for_text_to_equal("#out", "hi")

27 changes: 27 additions & 0 deletions
tests/unit/test_configs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,3 +231,30 @@ def test_strip_relative_path(prefix, partial_path, expected):
def test_invalid_strip_relative_path(prefix, partial_path):
 with pytest.raises(_exc.UnsupportedRelativePath):
 strip_relative_path(prefix, partial_path)


def test_port_env_fail_str(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="garbage")
 assert (
 excinfo.exconly()
 == "ValueError: Expecting an integer from 1 to 65535, found port='garbage'"
 )


def test_port_env_fail_range(empty_environ):
 app = Dash()
 with pytest.raises(Exception) as excinfo:
 app.run_server(port="0")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=0"
 )

 with pytest.raises(Exception) as excinfo:
 app.run_server(port="65536")
 assert (
 excinfo.exconly()
 == "AssertionError: Expecting an integer from 1 to 65535, found port=65536"
 )