chore: deprecate func compile_uri_template()

[nix010]

Summary of Changes

First timer, I don't know if this is a correct for this so please advise.

Add deprecated warning for func compile_uri_template()

Related Issues

1967

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.

• [x] Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
• [x] Added tests for changed code.
• [x] Prefixed code comments with GitHub nick and an appropriate prefix.
• [x] Coding style is consistent with the rest of the framework.
• [x] Updated documentation for changed code.
  • [x] Added docstrings for any new classes, functions, or modules.
  • [x] Updated docstrings for any modifications to existing code.
  • [x] Updated both WSGI and ASGI docs (where applicable).
  • [x] Added references to new classes, functions, or modules to the relevant RST file under docs/.
  • [x] Updated all relevant supporting documentation files under docs/.
  • [x] A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
  • [x] Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
• [x] 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[bot]]

Codecov Report

Merging #1971 (5384248) into master (c99972e) will not change coverage. The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #1971   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           63        63           
  Lines         6677      6678    +1     
  Branches      1239      1239           
=========================================
+ Hits          6677      6678    +1     

Impacted Files	Coverage Δ
falcon/response.py	100.00% <100.00%> (ø)
falcon/routing/util.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update c99972e...5384248. Read the comment docs.

[CaselIT]

Thanks for the pr!

[CaselIT]

Furthermore, we need to either wrap all tests in tests/test_uri_templates_legacy.py with pytest.warns(...), or add a rule to ignore this warning, because we don't want to get spam in the test output about this.

it may make sense to make pytest fail the test if a warning gets raised, so that's explicitly handled

[vytas7]

it may make sense to make pytest fail the test if a warning gets raised, so that's explicitly handled

That would be great if we could restrict this only to warnings originating from Falcon's codebase. Otherwise it might incur extra amount of CI fighting whenever there's a new warning in a 3rd party package.

[vytas7]

@nix010 Just checking whether you are still working on this PR? We'd need to clean up the tests etc to make all CI gates pass as a first step, and check there are no new warnings introduced.