feat: pluggable URL parsing #41
Open
Conversation
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
graingert
reviewed
Aug 15, 2019
requests_unixsocket/__init__.py
Outdated
| DEFAULT_SCHEME = 'http+unix://' | ||
|
|
||
| def default_urlparse(url): | ||
| return UnixAdapter.Settings.ParseResult( |
There was a problem hiding this comment.
Seems a bit of a waste to urlparse url three times
how about:
parsed = urlparse(url)
return UnixAdapter...
There was a problem hiding this comment.
Yep, you're right. I will definitely update that. Thanks!
msabramo
force-pushed
the
pluggable-urlparse
branch
from
f43c18d
to
17b07ed
Compare
msabramo
force-pushed
the
pluggable-urlparse
branch
2 times, most recently
from
49b9339
to
cef606f
Compare
msabramo
changed the title
|
Example of usage: import json
from requests.compat import urlparse
from requests_unixsocket import Session, UnixAdapter
def custom_urlparse(url):
parsed_url = urlparse(url)
return UnixAdapter.Settings.ParseResult(
sockpath=parsed_url.path,
reqpath=parsed_url.fragment,
)
session = Session(settings=UnixAdapter.Settings(urlparse=custom_urlparse))
r = session.get('http+unix://sock.localhost/var/run/docker.sock#/info')
registry_config = r.json()['RegistryConfig']
print(json.dumps(registry_config, indent=4)) |
msabramo
force-pushed
the
pluggable-urlparse
branch
from
58c4061
to
365b053
Compare
This way people can customize it to their liking, as there a lot of opinions about this, as evidenced by the comments on GH-34. The default parsing is still the same as before, so new versions don't break existing code. But the user has the option of passing in a settings object, which has a `urlparse` attribute that can be set to a custom function that processes the URL and splits it into a `sockpath` and a `reqpath`. Sem-Ver: feature
Example of using customizable `urlparse` function
This new test tests using the `UnixAdapter` directly, like [httpie-unixsocket](https://github.com/httpie/httpie-unixsocket) does. I wrote this test because I found a case, on the `pluggable-urlparse` branch, where tests were passing, but executing: ``` http http+unix://%2Fvar%2Frun%2Fdocker.sock/info ``` was failing.
so it doesn't choke when used directly (e.g.: like [httpie-unixsocket](https://github.com/httpie/httpie-unixsocket) does) and no explicit settings are provided.
msabramo
force-pushed
the
pluggable-urlparse
branch
from
81e89a5
to
afbc9fd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This way people can customize it to their liking, as there a lot of
opinions about this, as evidenced by the comments on GH-34.
The default parsing is still the same as before, so new version don't
break existing code. But the user has the option of passing in a
settings object, which has a
urlparseattribute that can be set to acustom function that processes the URL and splits into a
sockpathanda
reqpath.Sem-Ver: feature