Add types

[hynek]

So far I've tested it with a bunch of my own projects and it seems to be working great. Not sure if I'm missing something?

The big concession we've had to make is adding a few wrapper methods/functions that only add correct types:

• structlog.stdlib.get_logger()
• structlog.stdlib.BoundLogger.bind() (and the whole rest)

I think that's tolerable from a performance stance.

[hynek]

I've added a chapter with some thoughts: https://structlog--282.org.readthedocs.build/en/282/types.html

And a quick workaround if it breaks your CI.

[asottile]

I time-boxed myself 15 minutes to look at this, so sorry for the incomplete review -- hope some of this is helpful <3 a typing nerd

additionally, you might want to check out flake8-typing-imports:

$ flake8 --min-python-version 3.6.0 src/
src/structlog/testing.py:14:1: TYP001 guard import by `if TYPE_CHECKING:`: NoReturn (not in 3.6.0, 3.6.1)

(notably, NoReturn doesn't exist in 3.6.0 and 3.6.1 but those are compatible with your python_requires)

[hynek]

I time-boxed myself 15 minutes to look at this

Thank you so much! ❤️

NoReturn

This shouldn't be a problem because I depend on typing-extensions on Python < 3.8! I need it for Protocol…

[asottile]

I time-boxed myself 15 minutes to look at this

Thank you so much! ❤️

NoReturn

This shouldn't be a problem because I depend on typing-extensions on Python < 3.8! I need it for Protocol…

you can cheese protocol with (example):

if TYPE_CHECKING:
    from typing import Protocol
else:
    Protocol = object

though if you're already committed to typing-extensions as a dependency then nbd!

[hynek]

For everyone following along: I've noticed that the type hints of structlog.get_logger() were bogus: BindableLogger is useless if you want to log something and everybody would have to cast. So now it's Any. More on that in the updated https://structlog--282.org.readthedocs.build/en/282/types.html (I hope it will keep updating today…)

[Zac-HD]

This looks great 😁

[hynek]

Thanks everyone! If something else comes up, feel free to open new issues.