feat: type more falcon modules

[copalco]

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3b35eea) to head (e630a2e).

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #2171   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           63        63           
  Lines         6849      6889   +40     
  Branches      1260      1260           
=========================================
+ Hits          6849      6889   +40     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[CaselIT]

Great work.

• "from future annotation" is missing from a few modules
• in general I'm not a fan of the type alias union that include None, like RawHeaders for example, since it's a bit strange to read headers: RawHeaders = None. That said it's my preference, as they are it's also ok
• i'm not convinced we need the new modules that were added, it seems that we could just use the existing typing one. But I think it's better to wait the input of @vytas7 for this one

[CaselIT]

thanks for the update, I've repried to the open messages.

I'll try taking a better look locally to se if we can avoid some of the circular imports

[CaselIT]

Thanks @copalco for the update, I'll try taking a look by the weekend!

[CaselIT]

Thanks for the updates. In general this looks mostly ok.

While it works on definition when using future annotation, I'm not sure if it has unintended consequences at runtime for older python

[CaselIT]

I've pushed an update to avoid the imports in the functions, using if TYPE_CHECKING

[vytas7]

Looks great, it's a massive chunk of work (bar a couple of nitpicks)!

I'm just not 100% convinced by these new base classes inside typing.py 🤔 Do we really need these? It would be easier to get this review merged if it did not introduce any changes to the codebase's behaviour/performance (which in turn needs more extensive testing), just annotations.
Or maybe we could split these into a separate PR?

[kgriffs]

Thanks for your help on this! Retrofitting type hints is a lot of work and we really appreciate it. I still need to finish reviewing several of the modules, but wanted to share my comments so far to get you unblocked.

[CaselIT]

@copalco let us know if you plan on continuing this or if we should take this over the finishing lie. In any case thanks a lot for the effort on this!

[copalco]

@copalco let us know if you plan on continuing this or if we should take this over the finishing lie. In any case thanks a lot for the effort on this!

Sure I can continue. Also I don't mind if you will just propose the actual change as a comment.

[CaselIT]

thanks for updating it

[vytas7]

Thanks, this looks like a really great start toward better typing! 💯

The only part that looks slightly inconsistent, or at least I don't understand why it needs to be done this way, is typing of media Handlers in request.py, response.py, and media/ itself.

[CaselIT]

Will look

[vytas7]

LGTM now