gh-100463: Add handling for extensionless URLs in http.server #100464
Conversation
This file contains 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
A common pattern in URL design is to omit the file extension for pages, as this both makes the URL look nicer and makes it technology agnostic (it doesn't matter if the page is written in PHP or HTML). This commit adds a special case for URLs without any extension that will check common extensions before returning a 404 error. The motivation for this change is the common use case of the python HTTP server for static website development, especially amongst those learning HTML/CSS. This change allows them to use the best practice of omitting extensions in links and still having navigation between multiple pages working. Extensionless files are checked first for an exact match, then sequentially for the defined default_extensions (which unless overridden are .html and .htm), before returning a Not Found error if none exist. The list of default extensions can be changed at runtime my passing a list of extensions to SimpleHTTPRequestHandler initiation.
Checks that it will read /spam.html for path /spam and checks that if /spam does exist that it will be read with priority.
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
|
All commit authors signed the Contributor License Agreement. |
|
@jfrost-mo Can you sign the CLA, please? |
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.
Adds handling for extensionless URLs in http.server, where they will translated into the same filename with the
.htmlextension. This PR adds a special case for URLs without any extension that will check common extensions before returning a 404 error.Extensionless files are checked first for an exact match, then sequentially for the defined default_extensions (which unless overridden are .html and .htm), before returning a Not Found error if none exist.
The list of default extensions can be changed at runtime my passing a list of extensions to SimpleHTTPRequestHandler initiation.
Fixes #100463