Skip to content
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.

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

Switch base methods to return Self instead of BoundLoggerBase #658

Closed
wants to merge 1 commit into from

Conversation

aThorp96
Copy link
Contributor

@aThorp96 aThorp96 commented Oct 3, 2024

Summary

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 specifically self.__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:
Screenshot 2024-10-03 at 4 48 17 PM

After this change:
Screenshot 2024-10-03 at 4 48 54 PM

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 deprecated directives.
      • 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.
  • Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

@aThorp96
Copy link
Contributor Author

aThorp96 commented Oct 3, 2024

Forgot to switch PR from my main branch to my non-main branch

@aThorp96 aThorp96 closed this Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant