Add stubs for django-environ

pyrightconfig.stricter.json

@@ -33,6 +33,7 @@
         "stubs/cffi",
         "stubs/dateparser",
         "stubs/defusedxml",
+        "stubs/django-environ",
         "stubs/docker",
         "stubs/docutils",
         "stubs/Flask-SocketIO",

stubs/django-environ/METADATA.toml

@@ -0,0 +1,2 @@
+version = "0.12.*"
+upstream_repository = "https://github.com/joke2k/django-environ"

stubs/django-environ/environ/__init__.pyi

@@ -0,0 +1,11 @@
+from .compat import DJANGO_POSTGRES as DJANGO_POSTGRES, PYMEMCACHE_DRIVER as PYMEMCACHE_DRIVER, REDIS_DRIVER as REDIS_DRIVER
+from .environ import *
+
+__copyright__: str
+__version__: str
+__license__: str
+__author_email__: str
+__maintainer__: str
+__maintainer_email__: str
+__url__: str
+__description__: str

stubs/django-environ/environ/compat.pyi

@@ -0,0 +1,9 @@
+class ImproperlyConfigured(Exception): ...
+
+def choose_rediscache_driver(): ...
+def choose_postgres_driver(): ...
+def choose_pymemcache_driver(): ...
+
+REDIS_DRIVER: str
+DJANGO_POSTGRES: str
+PYMEMCACHE_DRIVER: str

stubs/django-environ/environ/environ.pyi

@@ -0,0 +1,141 @@
+import os
+from collections.abc import Callable, Mapping, MutableMapping
+from logging import Logger
+from typing import IO, Any, ClassVar, SupportsIndex, TypedDict, TypeVar, overload
+from typing_extensions import TypeAlias, Unpack
+from urllib.parse import ParseResult
+
+from .fileaware_mapping import FileAwareMapping
+
+Openable: tuple[type, ...]
+logger: Logger
+
+class NoValue: ...
+
+# Some type aliases to make our life easier
+_Str = str
+_Bytes = bytes
+_Bool = bool
+_Int = int
+_Float = float
+_List = list
+_Tuple = tuple
+_Dict = dict
+
+_T = TypeVar("_T")
+_Cast: TypeAlias = Callable[[_Str], _T]
+_SchemeValue: TypeAlias = _Cast[Any] | tuple[_Cast[Any], Any]
+_BooleanTrueStrings: TypeAlias = tuple[str, ...]
+
+class Env:
+    ENVIRON: MutableMapping[_Str, _Str]
+    NOTSET: ClassVar[NoValue]
+    BOOLEAN_TRUE_STRINGS: ClassVar[_BooleanTrueStrings]
+    URL_CLASS: ClassVar[type[ParseResult]]
+    POSTGRES_FAMILY: ClassVar[_List[_Str]]
+    DEFAULT_DATABASE_ENV: ClassVar[_Str] = "DATABASE_URL"
+    DB_SCHEMES: ClassVar[_Dict[_Str, _Str]]
+    DEFAULT_CACHE_ENV: ClassVar[_Str] = "CACHE_URL"
+    CACHE_SCHEMES: ClassVar[_Dict[_Str, _Str]]
+    DEFAULT_EMAIL_ENV: ClassVar[_Str] = "EMAIL_URL"
+    EMAIL_SCHEMES: ClassVar[_Dict[_Str, _Str]]
+    DEFAULT_SEARCH_ENV: ClassVar[_Str] = "SEARCH_URL"
+    SEARCH_SCHEMES: ClassVar[_Dict[_Str, _Str]]
+    ELASTICSEARCH_FAMILY: ClassVar[_List[_Str]]
+    CLOUDSQL: ClassVar[_Str]
+    DEFAULT_CHANNELS_ENV: ClassVar[_Str] = "CHANNELS_URL"
+    CHANNELS_SCHEMES: ClassVar[_Dict[_Str, _Str]]
+    smart_cast: _Bool
+    escape_proxy: _Bool
+    prefix: _Str
+    scheme: Mapping[_Str, _SchemeValue]
+
+    def __init__(self, **scheme: _SchemeValue) -> None: ...
+    def __call__(
+        self, var: _Str, cast: _Cast[_T] | None = None, default: _T | NoValue = ..., parse_default: _Bool = False
+    ) -> _T: ...
+    def __contains__(self, var: _Str) -> _Bool: ...
+    def str(self, var: _Str, default: _Str | NoValue = ..., multiline: _Bool = False) -> _Str: ...
+    def bytes(self, var: _Str, default: _Bytes | NoValue = ..., encoding: _Str = "utf8") -> _Bytes: ...
+    def bool(self, var: _Str, default: _Bool | NoValue = ...) -> _Bool: ...
+    def int(self, var: _Str, default: _Int | NoValue = ...) -> _Int: ...
+    def float(self, var: _Str, default: _Float | NoValue = ...) -> _Float: ...
+    def json(self, var: _Str, default: Any | NoValue = ...) -> Any: ...
+    def list(self, var: _Str, cast: _Cast[_List] | None = None, default: _List | NoValue = ...) -> _List: ...
+    def tuple(self, var: _Str, cast: _Cast[_Tuple] | None = None, default: _Tuple | NoValue = ...) -> _Tuple: ...
+    def dict(self, var: _Str, cast: _Cast[_Dict] | None = ..., default: _Dict | NoValue = ...) -> _Dict: ...
+    def url(self, var: _Str, default: _Str | NoValue = ...) -> _Str: ...
+    def db_url(self, var: _Str = ..., default: _Str | NoValue = ..., engine: _Str | None = None) -> _Dict: ...
+
+    db = db_url
+
+    def cache_url(self, var: _Str = ..., default: _Str | NoValue = ..., backend: _Str | None = None) -> _Dict: ...
+
+    cache = cache_url
+
+    def email_url(self, var: _Str = ..., default: _Str | NoValue = ..., backend: _Str | None = None) -> _Dict: ...
+
+    email = email_url
+
+    def search_url(self, var: _Str = ..., default: _Str | NoValue = ..., engine: _Str | None = None) -> _Dict: ...
+    def channels_url(self, var: _Str = ..., default: _Str | NoValue = ..., backend: _Str | None = None) -> _Dict: ...
+
+    channels = channels_url
+
+    def path(self, var: _Str, default: _Str | NoValue = ..., **kwargs: Unpack[_PathKwargs]) -> Path: ...
+    def get_value(
+        self, var: _Str, cast: _Cast[_T] | None = None, default: _T | NoValue = ..., parse_default: _Bool = False
+    ) -> _T: ...
+    @classmethod
+    def parse_value(cls, value: _Str, cast: _Cast[_T]) -> _T: ...
+    @classmethod
+    def db_url_config(cls, url: _Str | ParseResult, engine: _Str | None = None) -> _Dict: ...
+    @classmethod
+    def cache_url_config(cls, url: _Str | ParseResult, backend: _Str | None = None) -> _Dict: ...
+    @classmethod
+    def email_url_config(cls, url: _Str | ParseResult, backend: _Str | None = None) -> _Dict: ...
+    @classmethod
+    def channels_url_config(cls, url: _Str | ParseResult, backend: _Str | None = None) -> _Dict: ...
+    @classmethod
+    def search_url_config(cls, url: _Str | ParseResult, engine: _Str | None = None) -> _Dict: ...
+    @classmethod
+    def read_env(
+        cls,
+        env_file: _Str | os.PathLike[_Str] | None = None,
+        overwrite: _Bool = False,
+        parse_comments: _Bool = False,
+        encoding: _Str = "utf8",
+        **overrides: _Dict[_Str, _Str],
+    ) -> None: ...
+
+class FileAwareEnv(Env):
+    ENVIRON: FileAwareMapping
+
+class _PathKwargs(TypedDict, total=False):
+    required: bool
+    is_file: bool
+
+class Path:
+    def path(self, *paths: str, **kwargs: Unpack[_PathKwargs]) -> Path: ...
+    def file(self, name: str, *args, **kwargs) -> IO[str]: ...
+    @property
+    def root(self) -> str: ...
+
+    __root__: str
+
+    def __init__(self, start: str = "", *paths: str, **kwargs: Unpack[_PathKwargs]) -> None: ...
+    def __call__(self, *paths: str, **kwargs: Unpack[_PathKwargs]) -> str: ...
+    def __eq__(self, other: object | Path) -> bool: ...
+    def __ne__(self, other: object | Path) -> bool: ...
+    def __add__(self, other: object | Path) -> Path: ...
+    def __sub__(self, other: int | str) -> Path: ...
+    def __invert__(self) -> Path: ...
+    def __contains__(self, item: Path) -> bool: ...
+    def __unicode__(self) -> str: ...
+    @overload
+    def __getitem__(self, key: SupportsIndex, /) -> str: ...
+    @overload
+    def __getitem__(self, key: slice, /) -> str: ...
+    def __fspath__(self) -> str: ...
+    def rfind(self, s: str, sub: str, start: int = 0, end: int = ...) -> int: ...
+    def find(self, s: str, sub: str, start: int = 0, end: int = ...) -> int: ...

stubs/django-environ/environ/fileaware_mapping.pyi

@@ -0,0 +1,12 @@
+from collections.abc import Iterator, MutableMapping
+
+class FileAwareMapping(MutableMapping[str, str]):
+    env: dict[str, str]
+    cache: bool
+    files_cache: dict[str, str]
+    def __init__(self, env: dict[str, str] | None = None, cache: bool = True) -> None: ...
+    def __getitem__(self, key: str) -> str: ...
+    def __iter__(self) -> Iterator[str]: ...
+    def __len__(self) -> int: ...
+    def __setitem__(self, key: str, value: str) -> None: ...
+    def __delitem__(self, key: str) -> None: ...