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

feat(typing): add type hints to hooks #2183

Merged
merged 69 commits into from
Aug 21, 2024
Merged

Conversation

copalco
Copy link
Contributor

@copalco copalco commented Nov 5, 2023

Summary of Changes

Replace this text with a high-level summary of the changes included in this PR.

Related Issues

Please reference here any issue #'s that are relevant to this PR, or simply enter "N/A" if this PR does not relate to any existing issues.

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

  • Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
  • Added tests for changed code.
  • Prefixed code comments with GitHub nick and an appropriate prefix.
  • Coding style is consistent with the rest of the framework.
  • Updated documentation for changed code.
    • Added docstrings for any new classes, functions, or modules.
    • Updated docstrings for any modifications to existing code.
    • Updated both WSGI and ASGI docs (where applicable).
    • Added references to new classes, functions, or modules to the relevant RST file under docs/.
    • Updated all relevant supporting documentation files under docs/.
    • A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
  • Changes (and possible deprecations) have towncrier news fragments under docs/_newsfragments/, with the file name format {issue_number}.{fragment_type}.rst. (Run towncrier --draft to ensure it renders correctly.)

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

PR template inspired by the attrs project.

CaselIT
CaselIT previously approved these changes Aug 12, 2024
@CaselIT CaselIT requested a review from vytas7 August 12, 2024 15:59
@CaselIT CaselIT changed the title feat: add more type hints feat: add type hint to hooks Aug 12, 2024
@CaselIT CaselIT mentioned this pull request Aug 12, 2024
13 tasks
CaselIT
CaselIT previously approved these changes Aug 12, 2024
Copy link
Member

@vytas7 vytas7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, we just need to decide how the users should consume typing.py. Maybe it would be nice if it is importable without TYPE_CHECKING too? Should we document any aliases?

setup.cfg Outdated Show resolved Hide resolved
falcon/typing.py Outdated Show resolved Hide resolved
@CaselIT
Copy link
Member

CaselIT commented Aug 21, 2024

Since we dropped 3.7 we can probably avoid having everything inside a type check block. Will do

@CaselIT
Copy link
Member

CaselIT commented Aug 21, 2024

Maybe it would be nice if it is importable without TYPE_CHECKING too? Should we document any aliases?

For the moment I mentioned in the v4 chance log that any type alias should be treated as private, since it can change between releases.

I think once we are adding typing we can do a bit of cleanup and maybe provide a public set to aliaes

@vytas7 vytas7 changed the title feat: add type hint to hooks feat(typing): add type hints to hooks Aug 21, 2024
Copy link
Member

@vytas7 vytas7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM now 👍
Thanks for the effort @copalco & @CaselIT!

.coveragerc Show resolved Hide resolved
@vytas7 vytas7 merged commit e0f731a into falconry:master Aug 21, 2024
38 checks passed
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.

3 participants