This Pull Request switches several BoundLoggerBase methods to annotate a return type of typing_extensions.Self instead of BoundLoggerBase. This change is consistent with the code which returns specificallyself.__class__() and with the tests that ensure the type is preserved when .bind() is called.
This should not have any runtime changes, but instead fixes a typing bug which caused the following code to incorrectly fail type-checking:
from structlog import get_logger, BoundLogger
log: BoundLogger = get_logger()
log.info("This is OK")
log = log.bind() # error: Type "BoundLoggerBase" is not assignable to declared type "BoundLogger"
log.info("This should also be okay")
Before this change:
After this change:
Pull Request Check List
It does not appear to me that any of these apply, but I am happy to make any necessary changes to the PR or do any upkeep tasks
[ ] Do not open pull requests from your main branch – use a separate branch!
There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch.
This is not a pre-requisite for your pull request to be accepted, but you have been warned.
[ ] Added tests for changed code.
The CI fails with less than 100% coverage.
[ ] New APIs are added to our typing tests in api.py.
[ ] Updated documentation for changed code.
[ ] New functions/classes have to be added to docs/api.rst by hand.
[ ] Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecateddirectives.
The next version is the second number in the current release + 1. The first number represents the current year. So if the current version on PyPI is 23.1.0, the next version is gonna be 23.2.0. If the next version is the first in the new year, it'll be 24.1.0.
[ ] Documentation in .rst and .md files is written using semantic newlines.
[ ] Changes (and possible deprecations) are documented in the changelog.
Summary
This Pull Request switches several
BoundLoggerBase
methods to annotate a return type oftyping_extensions.Self
instead ofBoundLoggerBase
. This change is consistent with the code which returns specificallyself.__class__()
and with the tests that ensure the type is preserved when.bind()
is called.This should not have any runtime changes, but instead fixes a typing bug which caused the following code to incorrectly fail type-checking:
Before this change:
After this change:
Pull Request Check List
It does not appear to me that any of these apply, but I am happy to make any necessary changes to the PR or do any upkeep tasks
main
branch – use a separate branch!api.py
.docs/api.rst
by hand.versionadded
,versionchanged
, ordeprecated
directives..rst
and.md
files is written using semantic newlines.