feat: type annotations #28
Conversation
ada_url/ada_adapter.py
Outdated
| @@ -290,7 +320,9 @@ def normalize_url(s): | |||
| return parse_url(s, attributes=('href',))['href'] | |||
|
|
|||
|
|
|||
| def parse_url(s, attributes=PARSE_ATTRIBUTES): | |||
| # FIXME constrain `attributes`` | |||
There was a problem hiding this comment.
| # FIXME constrain `attributes`` | |
| # FIXME constrain `attributes` |
There was a problem hiding this comment.
Same here - the docstring says unrecognized requests are ignored; we need not constrain with the type if we preserve that behavior.
ada_url/ada_adapter.py
Outdated
| @@ -354,7 +386,8 @@ def parse_url(s, attributes=PARSE_ATTRIBUTES): | |||
| return ret | |||
|
|
|||
|
|
|||
| def replace_url(s, **kwargs): | |||
| # FIXME constrain key of `**kwargs` by `URL_ATTRIBUTES` | |||
There was a problem hiding this comment.
The docstring says that unknown keys are ignored; I'd like to preserve this behavior.
There was a problem hiding this comment.
I see, but typing isn't just about error checking; constraints make auto suggestions work better.
If you insist, I'll just delete the comment; or I'll use Union[Literal["href"], ...].
There was a problem hiding this comment.
Let's remove the comments and create a GitHub issue to help make auto suggestions (what editor?) better.
|
Is it ready to merge? |
|
I'd like to add tests of the annotations with mypy, but we can do that in another PR. |
|
🚀 |
Fix #27