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

adjust type hint for filename parameter in open_file to also take an os.PathLike #2725

Merged
merged 1 commit into from
May 20, 2024

Conversation

danwuSBU
Copy link

@danwuSBU danwuSBU commented May 20, 2024

Underlying functions the parameter filename is passed to has the type str | os.PathLike, but filename accepts only str. Changed the filename type hint to reflect this so that type checking won't complain if, for example, a user passes in a pathlib.Path.

Closes #2717

Checklist:

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

@aenglander aenglander merged commit 74ab60a into pallets:8.1.x May 20, 2024
13 checks passed
@danwuSBU danwuSBU deleted the click#2717 branch May 21, 2024 02:39
@davidism davidism added this to the 8.1.8 milestone May 22, 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.

None yet

3 participants