cache_control.pyi 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. from collections.abc import Callable
  2. from collections.abc import Iterable
  3. from collections.abc import Mapping
  4. from typing import TypeVar
  5. from .mixins import ImmutableDictMixin
  6. from .mixins import UpdateDictMixin
  7. T = TypeVar("T")
  8. _CPT = TypeVar("_CPT", str, int, bool)
  9. def cache_control_property(
  10. key: str, empty: _CPT | None, type: type[_CPT]
  11. ) -> property: ...
  12. class _CacheControl(
  13. UpdateDictMixin[str, str | int | bool | None], dict[str, str | int | bool | None]
  14. ):
  15. provided: bool
  16. def __init__(
  17. self,
  18. values: Mapping[str, str | int | bool | None]
  19. | Iterable[tuple[str, str | int | bool | None]] = (),
  20. on_update: Callable[[_CacheControl], None] | None = None,
  21. ) -> None: ...
  22. @property
  23. def no_cache(self) -> bool | None: ...
  24. @no_cache.setter
  25. def no_cache(self, value: bool | None) -> None: ...
  26. @no_cache.deleter
  27. def no_cache(self) -> None: ...
  28. @property
  29. def no_store(self) -> bool | None: ...
  30. @no_store.setter
  31. def no_store(self, value: bool | None) -> None: ...
  32. @no_store.deleter
  33. def no_store(self) -> None: ...
  34. @property
  35. def max_age(self) -> int | None: ...
  36. @max_age.setter
  37. def max_age(self, value: int | None) -> None: ...
  38. @max_age.deleter
  39. def max_age(self) -> None: ...
  40. @property
  41. def no_transform(self) -> bool | None: ...
  42. @no_transform.setter
  43. def no_transform(self, value: bool | None) -> None: ...
  44. @no_transform.deleter
  45. def no_transform(self) -> None: ...
  46. def _get_cache_value(self, key: str, empty: T | None, type: type[T]) -> T: ...
  47. def _set_cache_value(self, key: str, value: T | None, type: type[T]) -> None: ...
  48. def _del_cache_value(self, key: str) -> None: ...
  49. def to_header(self) -> str: ...
  50. @staticmethod
  51. def cache_property(key: str, empty: _CPT | None, type: type[_CPT]) -> property: ...
  52. class RequestCacheControl( # type: ignore[misc]
  53. ImmutableDictMixin[str, str | int | bool | None], _CacheControl
  54. ):
  55. @property
  56. def max_stale(self) -> int | None: ...
  57. @max_stale.setter
  58. def max_stale(self, value: int | None) -> None: ...
  59. @max_stale.deleter
  60. def max_stale(self) -> None: ...
  61. @property
  62. def min_fresh(self) -> int | None: ...
  63. @min_fresh.setter
  64. def min_fresh(self, value: int | None) -> None: ...
  65. @min_fresh.deleter
  66. def min_fresh(self) -> None: ...
  67. @property
  68. def only_if_cached(self) -> bool | None: ...
  69. @only_if_cached.setter
  70. def only_if_cached(self, value: bool | None) -> None: ...
  71. @only_if_cached.deleter
  72. def only_if_cached(self) -> None: ...
  73. class ResponseCacheControl(_CacheControl):
  74. @property
  75. def public(self) -> bool | None: ...
  76. @public.setter
  77. def public(self, value: bool | None) -> None: ...
  78. @public.deleter
  79. def public(self) -> None: ...
  80. @property
  81. def private(self) -> bool | None: ...
  82. @private.setter
  83. def private(self, value: bool | None) -> None: ...
  84. @private.deleter
  85. def private(self) -> None: ...
  86. @property
  87. def must_revalidate(self) -> bool | None: ...
  88. @must_revalidate.setter
  89. def must_revalidate(self, value: bool | None) -> None: ...
  90. @must_revalidate.deleter
  91. def must_revalidate(self) -> None: ...
  92. @property
  93. def proxy_revalidate(self) -> bool | None: ...
  94. @proxy_revalidate.setter
  95. def proxy_revalidate(self, value: bool | None) -> None: ...
  96. @proxy_revalidate.deleter
  97. def proxy_revalidate(self) -> None: ...
  98. @property
  99. def s_maxage(self) -> int | None: ...
  100. @s_maxage.setter
  101. def s_maxage(self, value: int | None) -> None: ...
  102. @s_maxage.deleter
  103. def s_maxage(self) -> None: ...
  104. @property
  105. def immutable(self) -> bool | None: ...
  106. @immutable.setter
  107. def immutable(self, value: bool | None) -> None: ...
  108. @immutable.deleter
  109. def immutable(self) -> None: ...