docs(recipes): add type hints to request_id and custom media handler snippets#2665
Open
Aydeing wants to merge 2 commits into
Open
docs(recipes): add type hints to request_id and custom media handler snippets#2665Aydeing wants to merge 2 commits into
Aydeing wants to merge 2 commits into
Conversation
…examples Annotate the recipe snippet files referenced from the docs so they demonstrate the type-hinted style described in falconry#1820: - examples/recipes/request_id_context.py - examples/recipes/request_id_log.py - examples/recipes/request_id_middleware.py - examples/recipes/request_id_structlog.py - examples/recipes/plain_text_main.py - examples/recipes/pretty_json_main.py No runtime behavior changes. Refs: falconry#1820
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2665 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 64 64
Lines 7985 7985
Branches 1103 1103
=========================================
Hits 7985 7985 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Changes
Adds type annotations to a small, self-contained batch of recipe snippet files under
examples/recipes/, as a step toward the rolling work in #1820:examples/recipes/request_id_context.pyexamples/recipes/request_id_log.pyexamples/recipes/request_id_middleware.pyexamples/recipes/request_id_structlog.pyexamples/recipes/plain_text_main.pyexamples/recipes/pretty_json_main.pyAll changes are purely additive type annotations (plus an isort fix on two snippet imports that
ruff check --fixproduced). No runtime behavior changes; signatures only.A
docs/_newsfragments/1820.misc.rsttowncrier entry is included.Related Issues
Refs #1820
Pull Request Checklist
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. Reading our contribution guide at least once 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.
tox. (Ranruff formatandruff checkon the touched files locally —All checks passed!. AST parse + runtime import smoke-checked on Python 3.13.)docs/. (N/A.)docs/. (N/A — the recipe.rstfilesliteralincludethese snippets unchanged.)versionadded,versionchanged, ordeprecateddirectives. (N/A — annotations only.)docs/_newsfragments/, with the file name format{issue_number}.{fragment_type}.rst. (Addeddocs/_newsfragments/1820.misc.rst.)ruff, and re-validated locally.)