Address issue #197 re: handshake customization docs. #199
Conversation
websockets/server.py
Outdated
| ``HTTPStatus.UNAUTHORIZED`` or ``HTTPStatus.FORBIDDEN``. | ||
| ``HTTPStatus.UNAUTHORIZED`` or ``HTTPStatus.FORBIDDEN``. The | ||
| current request path can be accessed from within this method | ||
| as ``self.path``. |
There was a problem hiding this comment.
It may be useful to describe how to access headers (request_headers, raw_request_headers) as well, which doesn't quite belong to a docstring.
Perhaps it would be best to add a section to the docs about customizing the handshake process and give all the details there. What do you think?
(I also need to look at the other related issue.)
There was a problem hiding this comment.
A section like that in the docs makes sense, though I think I'd like to wait until after #116 is resolved to do that since it may require rewriting a portion those docs.
I do think the fact that self.path and self.request_headers are guaranteed to be available should be stated in the same place developers are told the method is overridable (currently stated in the docstring). That way implementers are clearer on what they can / should be relying on when they override.
There was a problem hiding this comment.
Note to self: self.origin is also available.
|
Patch updated based on feedback. |
cjerdonek
force-pushed
the
issue-197-handshake-docs
branch
from
488033b to
49e6e26
Compare
|
This looks pretty good, thanks a lot for your work. I'll take the time to review next week-end (hopefully). |
cjerdonek
force-pushed
the
issue-197-handshake-docs
branch
from
e62c9a3 to
bd809d7
Compare
|
Rebased after PR #236. |
|
This needs updating after #248. |
|
I'm closing this PR because it's out of date. The corresponding issue #197 is still open. |
Addresses #197.