django-types 0.19.1__py3-none-any.whl → 0.21.0__py3-none-any.whl

django-stubs/shortcuts.pyi

@@ -1,6 +1,5 @@
 from collections.abc import Callable, Mapping, Sequence
-from typing import Any, Protocol, TypeVar, overload
-from typing_extensions import Literal
+from typing import Any, Literal, Protocol, TypeVar, overload
 
 from django.db.models import Manager, QuerySet
 from django.db.models.base import Model

django-stubs/template/backends/base.pyi

@@ -1,7 +1,16 @@
 from collections.abc import Iterator, Mapping
-from typing import Any
+from typing import Any, Protocol
 
-from django.template.base import Template
+from django.http.request import HttpRequest
+from django.utils.safestring import SafeText
+
+# Source: https://github.com/django/deps/blob/main/final/0182-multiple-template-engines.rst#backends-api
+class _BaseTemplate(Protocol):
+    def render(
+        self,
+        context: Mapping[str, Any] | None = ...,
+        request: HttpRequest | None = ...,
+    ) -> SafeText | str: ...
 
 class BaseEngine:
     name: str = ...
@@ -9,9 +18,9 @@ class BaseEngine:
     app_dirs: bool = ...
     def __init__(self, params: Mapping[str, Any]) -> None: ...
     @property
-    def app_dirname(self) -> str | None: ...
-    def from_string(self, template_code: str) -> Template: ...
-    def get_template(self, template_name: str) -> Template | None: ...
+    def app_dirname(self) -> str: ...
+    def from_string(self, template_code: str) -> _BaseTemplate: ...
+    def get_template(self, template_name: str) -> _BaseTemplate: ...
     @property
     def template_dirs(self) -> tuple[str]: ...
     def iter_template_filenames(self, template_name: str) -> Iterator[str]: ...

django-stubs/template/backends/django.pyi

@@ -1,8 +1,12 @@
-from collections.abc import Iterator
-from typing import Any
+from collections.abc import Iterator, Mapping
+from typing import Any, NoReturn
+from typing_extensions import override
 
+from django.http.request import HttpRequest
+from django.template import base
 from django.template.engine import Engine
 from django.template.exceptions import TemplateDoesNotExist
+from django.utils.safestring import SafeText
 
 from .base import BaseEngine
 
@@ -12,10 +16,27 @@ class DjangoTemplates(BaseEngine):
     def get_templatetag_libraries(
         self, custom_libraries: dict[str, str]
     ) -> dict[str, str]: ...
+    @override
+    def from_string(self, template_code: str) -> Template: ...
+    @override
+    def get_template(self, template_name: str) -> Template: ...
+
+class Template:
+    template: base.Template
+    backend: DjangoTemplates
+    def __init__(self, template: base.Template, backend: DjangoTemplates) -> None: ...
+    @property
+    def origin(self) -> base.Origin: ...
+    def render(
+        self,
+        context: Mapping[str, Any] | None = ...,
+        request: HttpRequest | None = ...,
+    ) -> SafeText: ...
 
 def copy_exception(
     exc: TemplateDoesNotExist, backend: DjangoTemplates | None = ...
 ) -> TemplateDoesNotExist: ...
-def reraise(exc: TemplateDoesNotExist, backend: DjangoTemplates) -> Any: ...
+def reraise(exc: TemplateDoesNotExist, backend: DjangoTemplates) -> NoReturn: ...
+def get_template_tag_modules() -> Iterator[tuple[str, str]]: ...
 def get_installed_libraries() -> dict[str, str]: ...
 def get_package_libraries(pkg: Any) -> Iterator[str]: ...

django-stubs/template/backends/dummy.pyi

@@ -1,20 +1,21 @@
 import string
+from collections.abc import Mapping
 from typing import Any
+from typing_extensions import override
 
 from django.http.request import HttpRequest
 
 from .base import BaseEngine
 
 class TemplateStrings(BaseEngine):
-    template_dirs: tuple[str]
-    def __init__(
-        self, params: dict[str, dict[Any, Any] | list[Any] | bool | str]
-    ) -> None: ...
+    @override
+    def from_string(self, template_code: str) -> Template: ...
+    @override
+    def get_template(self, template_name: str) -> Template: ...
 
 class Template(string.Template):
-    template: str
     def render(
         self,
-        context: dict[str, str] | None = ...,
+        context: Mapping[str, Any] | None = ...,
         request: HttpRequest | None = ...,
     ) -> str: ...

django-stubs/template/backends/jinja2.pyi

@@ -1,16 +1,34 @@
-from collections.abc import Callable
+from collections.abc import Callable, Mapping
 from typing import Any
+from typing_extensions import override
 
+from django.http.request import HttpRequest
+from django.template import base
 from django.template.exceptions import TemplateSyntaxError
+from django.utils.safestring import SafeText
 
 from .base import BaseEngine
 
 class Jinja2(BaseEngine):
     context_processors: list[str] = ...
-    def __init__(self, params: dict[str, Any]) -> None: ...
+    @override
+    def from_string(self, template_code: str) -> Template: ...
+    @override
+    def get_template(self, template_name: str) -> Template: ...
     @property
     def template_context_processors(self) -> list[Callable[..., Any]]: ...
 
+class Template:
+    template: base.Template
+    backend: Jinja2
+    origin: Origin
+    def __init__(self, template: base.Template, backend: Jinja2) -> None: ...
+    def render(
+        self,
+        context: Mapping[str, Any] | None = ...,
+        request: HttpRequest | None = ...,
+    ) -> SafeText: ...
+
 class Origin:
     name: str = ...
     template_name: str | None = ...

django-stubs/template/backends/utils.pyi

@@ -1,9 +1,9 @@
-from typing import Any
+from collections.abc import Callable
 
 from django.http.request import HttpRequest
 from django.utils.safestring import SafeText
 
 def csrf_input(request: HttpRequest) -> SafeText: ...
 
-csrf_input_lazy: Any
-csrf_token_lazy: Any
+csrf_input_lazy: Callable[[HttpRequest], SafeText]
+csrf_token_lazy: Callable[[HttpRequest], SafeText]

django-stubs/template/base.pyi

@@ -65,9 +65,9 @@ class Template:
     def __iter__(self) -> None: ...
     def render(
         self,
-        context: Context | dict[str, Any] | None = ...,
+        context: Context,
         request: HttpRequest | None = ...,
-    ) -> Any: ...
+    ) -> SafeText: ...
     def compile_nodelist(self) -> NodeList: ...
     def get_exception_info(
         self, exception: Exception, token: Token

django-stubs/template/context.pyi

@@ -68,8 +68,8 @@ class RequestContext(Context):
     dicts: list[dict[str, str]]
     render_context: RenderContext
     template_name: str | None
-    use_l10n: None
-    use_tz: None
+    use_l10n: None  # pyright: ignore[reportIncompatibleVariableOverride]
+    use_tz: None  # pyright: ignore[reportIncompatibleVariableOverride]
     request: HttpRequest = ...
     def __init__(
         self,

django-stubs/template/context_processors.pyi

@@ -1,14 +1,13 @@
 from collections.abc import Callable
 from typing import Any
 
-from django.core.handlers.wsgi import WSGIRequest
 from django.http.request import HttpRequest
 from django.utils.functional import SimpleLazyObject
 
 def csrf(request: HttpRequest) -> dict[str, SimpleLazyObject]: ...
 def debug(request: HttpRequest) -> dict[str, Callable[..., Any] | bool]: ...
 def i18n(
-    request: WSGIRequest,
+    request: HttpRequest,
 ) -> dict[str, list[tuple[str, str]] | bool | str]: ...
 def tz(request: HttpRequest) -> dict[str, str]: ...
 def static(request: HttpRequest) -> dict[str, str]: ...

django-stubs/template/library.pyi

@@ -1,5 +1,6 @@
 from collections.abc import Callable
-from typing import Any
+from typing import Any, TypeVar, overload
+from typing_extensions import ParamSpec
 
 from django.template.base import FilterExpression, Origin, Parser, Token
 from django.template.context import Context
@@ -7,40 +8,103 @@ from django.utils.safestring import SafeText
 
 from .base import Node, Template
 
+T = TypeVar("T")
+P = ParamSpec("P")
+
 class InvalidTemplateLibrary(Exception): ...
 
 class Library:
     filters: dict[str, Callable[..., Any]] = ...
     tags: dict[str, Callable[..., Any]] = ...
     def __init__(self) -> None: ...
+
+    # Both arguments None
+    @overload
+    def tag(
+        self,
+        name: None = ...,
+        compile_function: None = ...,
+    ) -> Callable[[Callable[P, T]], Callable[P, T]]: ...
+    # Only name as function
+    @overload
+    def tag(
+        self,
+        name: Callable[P, T],
+        compile_function: None = ...,
+    ) -> Callable[P, T]: ...
+    # Only name as string
+    @overload
     def tag(
         self,
-        name: Callable[..., Any] | str | None = ...,
-        compile_function: Callable[..., Any] | str | None = ...,
-    ) -> Callable[..., Any]: ...
-    def tag_function(self, func: Callable[..., Any]) -> Callable[..., Any]: ...
+        name: str,
+        compile_function: None = ...,
+    ) -> Callable[[Callable[P, T]], Callable[P, T]]: ...
+    # Both arguments specified
+    @overload
+    def tag(
+        self,
+        name: str,
+        compile_function: Callable[P, T],
+    ) -> Callable[P, T]: ...
+    def tag_function(self, func: Callable[P, T]) -> Callable[P, T]: ...
+
+    # Both arguments None
+    @overload
+    def filter(
+        self,
+        name: None = ...,
+        filter_func: None = ...,
+        **flags: Any,
+    ) -> Callable[[Callable[P, T]], Callable[P, T]]: ...
+    # Only name as string
+    @overload
     def filter(
         self,
-        name: Callable[..., Any] | str | None = ...,
-        filter_func: Callable[..., Any] | str | None = ...,
-        **flags: Any
-    ) -> Callable[..., Any]: ...
-    def filter_function(
-        self, func: Callable[..., Any], **flags: Any
-    ) -> Callable[..., Any]: ...
+        name: str = ...,
+        filter_func: None = ...,
+        **flags: Any,
+    ) -> Callable[[Callable[P, T]], Callable[P, T]]: ...
+    # Only name as callable
+    @overload
+    def filter(
+        self,
+        name: Callable[P, T],
+        filter_func: None = ...,
+        **flags: Any,
+    ) -> Callable[P, T]: ...
+    # Both arguments
+    @overload
+    def filter(
+        self,
+        name: str,
+        filter_func: Callable[P, T],
+        **flags: Any,
+    ) -> Callable[P, T]: ...
+    def filter_function(self, func: Callable[P, T], **flags: Any) -> Callable[P, T]: ...
+
+    # func is None
+    @overload
+    def simple_tag(
+        self,
+        func: None = ...,
+        takes_context: bool | None = ...,
+        name: str | None = ...,
+    ) -> Callable[[Callable[P, T]], Callable[P, T]]: ...
+    # func is callable
+    @overload
     def simple_tag(
         self,
-        func: Callable[..., Any] | str | None = ...,
+        func: Callable[P, T],
         takes_context: bool | None = ...,
         name: str | None = ...,
-    ) -> Callable[..., Any]: ...
+    ) -> Callable[P, T]: ...
     def inclusion_tag(
         self,
         filename: Template | str,
         func: None = ...,
         takes_context: bool | None = ...,
         name: str | None = ...,
-    ) -> Callable[..., Any]: ...
+    ) -> Callable[[Callable[P, T]], Callable[P, T]]: ...
 
 class TagHelperNode(Node):
     func: Any = ...

django-stubs/template/loader.pyi

@@ -1,19 +1,21 @@
 from typing import Any
 
 from django.http.request import HttpRequest
+from django.template.backends.base import _BaseTemplate
 from django.template.exceptions import (  # noqa: F401
     TemplateDoesNotExist as TemplateDoesNotExist,
 )
+from django.utils.safestring import SafeText
 
 from . import engines as engines  # noqa: F401
 
-def get_template(template_name: str, using: str | None = ...) -> Any: ...
+def get_template(template_name: str, using: str | None = ...) -> _BaseTemplate: ...
 def select_template(
     template_name_list: list[str] | str, using: str | None = ...
-) -> Any: ...
+) -> _BaseTemplate: ...
 def render_to_string(
     template_name: list[str] | str,
     context: dict[str, Any] | None = ...,
     request: HttpRequest | None = ...,
     using: str | None = ...,
-) -> str: ...
+) -> SafeText: ...

django-stubs/template/response.pyi

@@ -15,7 +15,7 @@ class ContentNotRenderedError(Exception): ...
 class SimpleTemplateResponse(HttpResponse):
     content: Any = ...
     closed: bool
-    cookies: SimpleCookie[Any]
+    cookies: SimpleCookie  # type: ignore [type-arg]
     status_code: int
     rendering_attrs: Any = ...
     template_name: list[str] | Template | str = ...
@@ -47,9 +47,9 @@ class SimpleTemplateResponse(HttpResponse):
 class TemplateResponse(SimpleTemplateResponse):
     client: Client
     closed: bool
-    context: RequestContext
+    context: RequestContext  # pyright: ignore[reportIncompatibleVariableOverride]
     context_data: dict[str, Any] | None
-    cookies: SimpleCookie[Any]
+    cookies: SimpleCookie  # type: ignore [type-arg]
     csrf_cookie_set: bool
     json: functools.partial[Any]
     redirect_chain: list[tuple[str, int]]

django-stubs/template/utils.pyi

@@ -1,4 +1,5 @@
-import collections
+from collections.abc import Iterator
+from pathlib import Path
 from typing import Any
 
 from django.core.exceptions import ImproperlyConfigured
@@ -7,10 +8,11 @@ from django.template.backends.base import BaseEngine
 class InvalidTemplateEngineError(ImproperlyConfigured): ...
 
 class EngineHandler:
-    templates: collections.OrderedDict[Any, Any]
     def __init__(self, templates: list[dict[str, Any]] = ...) -> None: ...
+    @property
+    def templates(self) -> dict[str, dict[str, Any]]: ...
     def __getitem__(self, alias: str) -> BaseEngine: ...
-    def __iter__(self) -> Any: ...
+    def __iter__(self) -> Iterator[BaseEngine]: ...
     def all(self) -> list[BaseEngine]: ...
 
-def get_app_template_dirs(dirname: str) -> tuple[Any, ...]: ...
+def get_app_template_dirs(dirname: str) -> tuple[Path, ...]: ...