-
Notifications
You must be signed in to change notification settings - Fork 120
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.
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
PR for issue #674 #675
Open
Darnethal0z
wants to merge
5
commits into
twisted:trunk
Choose a base branch
from
Darnethal0z:trunk
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
PR for issue #674 #675
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a59c881
Added `installSignalHandlers` parameter on `klein.run()`
Darnethal0z 9a2b72b
Adding example
Darnethal0z adf0a10
Added code example for `Klein.run()` `installSignalHandlers` paramete…
Darnethal0z 78ae117
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 5518013
Merge branch 'trunk' into trunk
glyph File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
================================================ | ||
Example -- Disabling signal handler installation | ||
================================================ | ||
|
||
You have the possibility to print raised errors directly in the file descriptor specified in the ``Klein.run()`` ``logFile`` parameter, it can be useful for troubleshooting or logging fins. | ||
|
||
Below is an example of such implementation, the raised errors will be printed in ``sys.stdout`` by default : | ||
|
||
|
||
.. code-block:: python | ||
|
||
from klein import route, run | ||
|
||
|
||
@route("/") | ||
def home(request): | ||
return "Hello, world!" | ||
|
||
|
||
run("localhost", 8080, installSignalHandlers=False) | ||
|
||
This is an addition of the ``Klein.handle_errors`` method. |
9 changes: 9 additions & 0 deletions
9
docs/introduction/codeexamples/helloWorldNoSignalInstallation.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
from klein import route, run | ||
|
||
|
||
@route("/") | ||
def home(request): | ||
return "Hello, world!" | ||
|
||
|
||
run("localhost", 8080, installSignalHandlers=False) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are reasons to want to have this parameter exposed, but … this is not one of them. Twisted logs raised errors automatically already, so this documentation just seems inaccurate? You also don't actually use the
logFile
parameter here, despite describing it. So this seems like an odd corner of the documentation.It might be better to document how to call
reactor.run
or integrate Klein withtwisted.internet.task.react
directly, rather than copying every possible parameter into therun
convenience function.