VimPlug/django-stubs
1
0
Fork 0
mirror of https://github.com/davidhalter/django-stubs.git synced 2025-12-12 23:16:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Type samesite values as literals 'Lax', 'Strict' or 'None' (#1110)

Browse Source 
* Type `samesite` values as literals 'Lax', 'Strict' or 'None'

- Adjusts supported `SESSION_COOKIE_SAMESITE` values
- Adjusts supported `CSRF_COOKIE_SAMESITE` values

* Update django-stubs/conf/global_settings.pyi

* Update response.pyi

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
This commit is contained in:
Petter Friberg
2022-08-27 01:02:47 +02:00
committed by GitHub
parent 6b39050d52
commit 8bd00ba25a
2 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
django-stubs/conf/global_settings.pyi
View File

@@ -7,6 +7,8 @@ by the DJANGO_SETTINGS_MODULE environment variable.
# django.utils.translation -- that module depends on the settings. # django.utils.translation -- that module depends on the settings.
from typing import Any, Dict, List, Optional, Pattern, Protocol, Sequence, Tuple, Union from typing import Any, Dict, List, Optional, Pattern, Protocol, Sequence, Tuple, Union
from typing_extensions import Literal
#################### ####################
# CORE # # CORE #
#################### ####################
@@ -340,8 +342,8 @@ SESSION_COOKIE_PATH: str = ...
# Whether to use the non-RFC standard httpOnly flag (IE, FF3+, others) # Whether to use the non-RFC standard httpOnly flag (IE, FF3+, others)
SESSION_COOKIE_HTTPONLY: bool = ... SESSION_COOKIE_HTTPONLY: bool = ...
# Whether to set the flag restricting cookie leaks on cross-site requests. # Whether to set the flag restricting cookie leaks on cross-site requests.
# This can be 'Lax', 'Strict', or None to disable the flag. # This can be 'Lax', 'Strict', 'None', or False to disable the flag.
SESSION_COOKIE_SAMESITE: Optional[str] = ... SESSION_COOKIE_SAMESITE: Literal["Lax", "Strict", "None", False] = ...
# Whether to save the session data on every request. # Whether to save the session data on every request.
SESSION_SAVE_EVERY_REQUEST: bool = ... SESSION_SAVE_EVERY_REQUEST: bool = ...
# Whether a user's session cookie expires when the Web browser is closed. # Whether a user's session cookie expires when the Web browser is closed.
@@ -409,7 +411,7 @@ CSRF_COOKIE_DOMAIN: Optional[str] = ...
CSRF_COOKIE_PATH: str = ... CSRF_COOKIE_PATH: str = ...
CSRF_COOKIE_SECURE: bool = ... CSRF_COOKIE_SECURE: bool = ...
CSRF_COOKIE_HTTPONLY: bool = ... CSRF_COOKIE_HTTPONLY: bool = ...
CSRF_COOKIE_SAMESITE: Optional[str] = ... CSRF_COOKIE_SAMESITE: Literal["Lax", "Strict", "None", False] = ...
CSRF_HEADER_NAME: str = ... CSRF_HEADER_NAME: str = ...
CSRF_TRUSTED_ORIGINS: List[str] = ... CSRF_TRUSTED_ORIGINS: List[str] = ...
CSRF_USE_SESSIONS: bool = ... CSRF_USE_SESSIONS: bool = ...

9
django-stubs/http/response.pyi
View File

@@ -5,6 +5,7 @@ from typing import Any, Dict, Iterable, Iterator, List, Optional, Tuple, Type, T
from django.http.cookie import SimpleCookie from django.http.cookie import SimpleCookie
from django.utils.datastructures import CaseInsensitiveMapping, _PropertyDescriptor from django.utils.datastructures import CaseInsensitiveMapping, _PropertyDescriptor
from typing_extensions import Literal
class BadHeaderError(ValueError): ... class BadHeaderError(ValueError): ...
@@ -62,12 +63,16 @@ class HttpResponseBase:
domain: Optional[str] = ..., domain: Optional[str] = ...,
secure: bool = ..., secure: bool = ...,
httponly: bool = ..., httponly: bool = ...,
samesite: str = ..., samesite: Optional[Literal["Lax", "Strict", "None"]] = ...,
) -> None: ... ) -> None: ...
def setdefault(self, key: str, value: str) -> None: ... def setdefault(self, key: str, value: str) -> None: ...
def set_signed_cookie(self, key: str, value: str, salt: str = ..., **kwargs: Any) -> None: ... def set_signed_cookie(self, key: str, value: str, salt: str = ..., **kwargs: Any) -> None: ...
def delete_cookie( def delete_cookie(
self, key: str, path: str = ..., domain: Optional[str] = ..., samesite: Optional[str] = ... self,
key: str,
path: str = ...,
domain: Optional[str] = ...,
samesite: Optional[Literal["Lax", "Strict", "None"]] = ...,
) -> None: ... ) -> None: ...
def make_bytes(self, value: object) -> bytes: ... def make_bytes(self, value: object) -> bytes: ...
def close(self) -> None: ... def close(self) -> None: ...