[PR #10880/3c9d7abf backport][3.12] Add invalid content type test docs #10886
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.
This is a backport of PR #10880 as merged into master (3c9d7ab).
What do these changes do?
This PR adds test coverage for invalid content type handling and documents the expected behavior. The changes include:
web.Response
, thecontent_type
property correctly defaults totext/plain
as per RFC 2045text/plain
by defaultAre there changes in behavior for the user?
No breaking changes. This PR only adds test coverage and documentation for existing behavior. Users will not experience any functional changes:
content_type
property still defaults totext/plain
for invalid valuesIs it a substantial burden for the maintainers to support this?
No, this is a minimal maintenance burden. The changes are:
The test and documentation help prevent future regressions and improve developer understanding, which actually reduces maintenance burden by making the codebase more self-documenting.
Related issue number
Fixes #9522
Checklist
CONTRIBUTORS.txt
CHANGES/
folder<issue_or_pr_num>.<type>.rst
(e.g.588.bugfix.rst
)number after creating the PR
.bugfix
: A bug fix for something the maintainers deemed animproper undesired behavior that got corrected to match
pre-agreed expectations.
.feature
: A new behavior, public APIs. That sort of stuff..deprecation
: A declaration of future API removals and breakingchanges in behavior.
.breaking
: When something public is removed in a breaking way.Could be deprecated in an earlier release.
.doc
: Notable updates to the documentation structure or buildprocess.
.packaging
: Notes for downstreams about unobvious side effectsand tooling. Changes in the test invocation considerations and
runtime assumptions.
.contrib
: Stuff that affects the contributor experience. e.g.Running tests, building the docs, setting up the development
environment.
.misc
: Changes that are hard to assign to any of the abovecategories.
for example:
referring to what's changed compared to the last released version
of this project.