Permission to generate stubs for structlog in typeshed #165
Comments
|
Actually I would prefer if you’d contribute them to structlog proper! Packages can ship their own stubs now. If you’d agree to do that, I’d add an AbstractBoundLogger first. |
|
@hynek Good to know that packages can ship their own stubs now. Will surely go in that way. However I didn't get what you meant by
|
|
Re: AbstractBoundLogger: I suspect it’s easier to build stubs if there’s an abstract interface that fits all bound loggers. The docs for stubs-via-package are here btw: http://mypy.readthedocs.io/en/latest/installed_packages.html |
|
@hynek Thanks for the link It would surely be efficient if there's an abstract interface for bound loggers. So what all loggers do you think would be better to abstract out? |
|
So I just noticed that untypically for me, I already have a base class that all loggers derive from: So just use that, I may or may not add an abc at some point, but it’s nothing you need to wait for. One more thing: unless you can come up with a good reason, I’d say we don’t use a Let me know if you need anything or anything is unclear. |
|
Any progress? 😇 |
|
Good day guys, |
|
@waseem18 any progress on this ? |
|
Sorry folks, I couldn't get to work on it. Anyone interested can pick it up. Thanks |
|
@waseem18 ok thanks for the update. I might pick it :) |
|
Concerning the preference of Python 2-style type comments over |
|
I honestly don't have too strong feelings about it, so if you have good reasons, go wild. |
Now we explicitly ignore specific imports instead of a blanket ignore on all missing types. Upgraded databases and pytest to get their latest versions which include types, for the rest we're ignoring them explicitly. see #485 - arrow doesn't have types but we can replace it with std library calls - requests_async deprecated in favor of httpx, so we'd need to upgrade to get types. The API of httpx is a little different as well. - structlog doesn't have types currently hynek/structlog#165 - rure No stubs yet davidblewett/rure-python#23 - pytest_mock types recently added to the typeshed so we'll need to wait for the next release of mypy. pytest-dev/pytest-mock#152 - markdown_html_finder Wrapper around some Rust code. Needs stubs to be added. chdsbd/markdown-html-finder#5 - asyncio_redis We're our own fork of it, but adding types would be rather manual. Granted we aren't using that much of the API surface. https://github.com/chdsbd/asyncio-redis - zstandard No stubs yet, so we're ignoring for the time being indygreg/python-zstandard#120 - inflection Types, but I think they're misconfigured, once they're fixed we can unignore. jpvanhal/inflection#49 - django Need to setup django-stubs for this to work since django doesn't have any static types. https://github.com/TypedDjango/django-stubs - dj_database_url Doesn't have any static types yet jazzband/dj-database-url#135 - responses No types yet getsentry/responses#339 - stripe Plan for types, but they don't exist currently stripe/stripe-python#650
Now we explicitly ignore specific imports instead of a blanket ignore on all missing types. Upgraded databases and pytest to get their latest versions which include types, for the rest we're ignoring them explicitly. see #485 - arrow doesn't have types but we can replace it with std library calls - requests_async deprecated in favor of httpx, so we'd need to upgrade to get types. The API of httpx is a little different as well. - structlog doesn't have types currently hynek/structlog#165 - rure No stubs yet davidblewett/rure-python#23 - pytest_mock types recently added to the typeshed so we'll need to wait for the next release of mypy. pytest-dev/pytest-mock#152 - markdown_html_finder Wrapper around some Rust code. Needs stubs to be added. chdsbd/markdown-html-finder#5 - asyncio_redis We're using our own fork of it, but adding types would be rather manual. Granted we aren't using that much of the API surface. https://github.com/chdsbd/asyncio-redis - zstandard No stubs yet, so we're ignoring for the time being indygreg/python-zstandard#120 - inflection Types, but I think they're misconfigured, once they're fixed we can unignore. jpvanhal/inflection#49 - django Need to setup django-stubs for this to work since django doesn't have any static types. https://github.com/TypedDjango/django-stubs - dj_database_url Doesn't have any static types yet jazzband/dj-database-url#135 - responses No types yet getsentry/responses#339 - stripe Plan for types, but they don't exist currently stripe/stripe-python#650
|
Isn't this issue moot given #282 was merged? |
|
Very much so! I wasn't aware it's still open – thank you for pointing it out. |
Hi Hynek,
I would like to add stubs for structlog to https://github.com/python/typeshed, a repository used to store PEP 484 type signatures for the Python stdlib and popular third party libraries. As per PEP 484, permission is required from the library owner before merging type signatures into typeshed - https://www.python.org/dev/peps/pep-0484/#the-typeshed-repo
These stubs will be used by mypy and Pycharm. I'll start working on creating stubs after I get permission from you and do let me know if you have any suggestions.
Thanks
The text was updated successfully, but these errors were encountered: