feat: add domain argument to SessionMiddleware #2280
Merged
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
Kludex
approved these changes
Nov 3, 2023
starlette/middleware/sessions.py
Outdated
| @@ -20,6 +20,7 @@ def __init__( | |||
| path: str = "/", | |||
| same_site: typing.Literal["lax", "strict", "none"] = "lax", | |||
| https_only: bool = False, | |||
| domain: str = "", | |||
There was a problem hiding this comment.
Suggested change
| domain: str = "", | |
| domain: typing.Optional[str] = None, |
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
This PR introduces an optional
domainparameter to the SessionMiddleware constructor. Users can include this parameter when initializing SessionMiddleware to specify the desireddomainfor cookie scoping. More information about it can be found, for example, here.The feature has been discussed in Discussions #1603
Impact
domainparameter when initializing SessionMiddleware, ensuring that it does not affect those who do not use it.Checklist