feat(typing): type util package

[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

Merging #2170 (8f3478a) into master (f00722a) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 8f3478a differs from pull request most recent head a8b18a4. Consider uploading reports for the commit a8b18a4 to get more accurate results

@@            Coverage Diff            @@
##            master     #2170   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           62        62           
  Lines         6833      6875   +42     
  Branches      1098      1098           
=========================================
+ Hits          6833      6875   +42     

Files Changed	Coverage Δ
falcon/util/__init__.py	100.00% <100.00%> (ø)
falcon/util/deprecation.py	100.00% <100.00%> (ø)
falcon/util/misc.py	100.00% <100.00%> (ø)
falcon/util/reader.py	100.00% <100.00%> (ø)
falcon/util/structures.py	100.00% <100.00%> (ø)
falcon/util/sync.py	100.00% <100.00%> (ø)
falcon/util/uri.py	100.00% <100.00%> (ø)

[vytas7]

Looks great, thanks a ton!

[CaselIT]

Great work, I've left a few comments.

Also sometimes to denote a callable Callable[..., Any] is used while in other places Callable is used. I'm not sure if they are equivalent, but it may make sense to unify them

[CaselIT]

Also another question.
Does it make sense to add future-annotation to all modules that have typing?
Personally I think it makes sense, and it should also limit the performance impact of adding typing on the import of a module.
@vytas7 do you have a preference here?

[vytas7]

What do you mean by performance impact @CaselIT? Annotations shouldn't affect code perf once they are parsed... or do you mean import times?

And re future-annotations, if you mean from __future__ import annotations, I'm not very opinionated; but AFAICT I can only see the positives since we don't (ab)use annotations for anything else than providing type hints. So effectively we would need to import less stuff just for typing?

[CaselIT]

Yes I meant the import time of a module

[CaselIT]

thanks. looks ok for me