Skip to content

Adding parse and DecodedURL docs #126

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
mahmoud merged 9 commits into from
Apr 16, 2020
Merged

Adding parse and DecodedURL docs #126

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a06eedb
adding initial draft of parse and DecodedURL API docs. Also added def…
mahmoud Apr 10, 2020
1f57a36
switch intersphinx to py3.7
mahmoud Apr 10, 2020
4afeb55
add parse doctest and 'new in' messages
mahmoud Apr 10, 2020
6682bd9
remove extra space in doctest
mahmoud Apr 10, 2020
b086352
bunch of minor doctest fixups
mahmoud Apr 11, 2020
182f834
fix a lint error
mahmoud Apr 11, 2020
2bae6f6
use versionadded
mahmoud Apr 11, 2020
ca40c74
Merge branch 'master' into add-parse-and-decodedurl-docs
mahmoud Apr 15, 2020
2d21b70
sigh, GitHub's 'resolve conflicts' editor left whitespace on a blank …
Apr 15, 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
Prev Previous commit
Next Next commit
use versionadded
  • Loading branch information
@mahmoud
mahmoud committed Apr 11, 2020
commit 2bae6f641696934eafb447c162d4905471d766fc
4 changes: 2 additions & 2 deletions src/hyperlink/_url.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1787,7 +1787,7 @@ class DecodedURL(object):
... host=u'pypi.org', path=(u'projects', u'hyperlink')).to_text())
https://pypi.org/projects/hyperlink

*(New in 18.0.0)*
.. versionadded:: 18.0.0
"""
def __init__(self, url=_EMPTY_URL, lazy=False):
Comment thread
mahmoud marked this conversation as resolved.

@wsanchez wsanchez Apr 15, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why the default? Perhaps merits discussion outside of doc changes.

@mahmoud mahmoud Apr 15, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Sure, a couple reasons:

  1. It's more parallel with URL(), which can be instantiated without arguments to get an empty URL.
  2. This way to programmatically construct a DecodedURL, you don't need to also import URL. You can do DecodedURL().replace(...).

@mahmoud mahmoud Apr 15, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ah, and the reason for including it in these changes was because I really wanted to avoid people programmatically constructing the newly-exposed DecodedURL by doing

from hyperlink import URL, DecodedURL
DecodedURL(URL(...))

Without realizing that URL's initializer arguments aren't as rigorously decoded/encoded as the rest of DecodedURL's API.

I proposed adding a .build() or .from_parts() if we want to shift to a better pattern. For now it's either that or parse('').replace(...). I figured a default arg at least lets you explicitly use the type without an extra parse()/from_text() step.

@twm twm Apr 16, 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.

from_parts() sounds like a good addition. I have written DecodedURL(URL()) — it's a bit awkward. Perhaps I am worrying too much (this is Python, everything is slow...) but I tend to look for APIs that avoid temporaries.

@wsanchez wsanchez Apr 17, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OK makes sense, and yes to from_parts.

# type: (URL, bool) -> None
Expand Down Expand Up @@ -2137,7 +2137,7 @@ def parse(url, decoded=True, lazy=False):
default, `lazy=False`, checks all encoded parts of the URL
for decodability.

*(New in 18.0.0)*
.. versionadded:: 18.0.0
"""
enc_url = EncodedURL.from_text(url)
if not decoded:
Expand Down