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

Fix return value annotations for methods returning copies #1880

Open
wants to merge 1 commit into
base: stable
Choose a base branch
from

Conversation

viccie30
Copy link

These methods always return a new object of the same type as the object they are bound to, even if this is a subclass. Change the annotations to reflect that.

I have not opened an issue, because it's not a functional bug. It just causes issues with static type checkers.

Checklist:

  • Add tests that demonstrate the correct behavior of the change. Tests should fail without the change. (N/A)
  • Add or update relevant docs, in the docs folder and in code. (N/A)
  • Add an entry in CHANGES.rst summarizing the change and linking to the issue.
  • Add .. versionchanged:: entries in any relevant code docs. (N/A)
  • Run pre-commit hooks and fix any issues.
  • Run pytest and tox, no tests failed.

These methods always return a new object of the same type as the object
they are bound to, even if this is a subclass. Change the annotations to
reflect that.
@viccie30
Copy link
Author

The pre-commit failure is not related to the changes in the PR and also happens with the current state of the branch.

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