Source code for dmr.openapi.views.base

from collections.abc import Callable
from typing import TYPE_CHECKING, Any, TypeAlias

from django.http import HttpResponseBase
from django.views import View
from typing_extensions import override

from dmr.openapi.openapi import OpenAPI

if TYPE_CHECKING:
    from dmr.openapi.mappers.schema_normalization import DumpedSchema

SchemaDumper: TypeAlias = Callable[['DumpedSchema'], str]




class OpenAPIView(View):
    """
    Base view for serving an OpenAPI schema.

    This view extends Django's :class:`~django.views.generic.base.View`
    to accept an :class:`~dmr.openapi.openapi.OpenAPI`
    instance via :meth:`as_view`.
    The passed schema is stored on the view class and can be rendered in
    any concrete subclass (for example, as JSON or YAML).
    """

    # Private API:
    _schema: OpenAPI | None = None
    _skip_validation: bool | None = None

    @property
    def schema(self) -> OpenAPI:
        """
        Return the OpenAPI schema bound to this view instance.

        The schema is injected via :meth:`as_view` and stored internally
        in the private ``_schema`` attribute. This property provides a
        typed and safe accessor for that value.
        """
        # An assertion is used to guarantee that the schema has been set.
        # Under normal usage, this should always be true because the view
        # must be constructed via :meth:`as_view(schema=...)`.
        assert self._schema is not None  # noqa: S101
        return self._schema

    @property
    def skip_validation(self) -> bool:
        """Return whether or not we should skip validation for this view."""
        # An assertion is used to guarantee that the value has been set.
        assert self._skip_validation is not None  # noqa: S101
        return self._skip_validation



    @classmethod
    @override
    def as_view(  # type: ignore[override]
        cls,
        schema: OpenAPI,
        *,
        skip_validation: bool = False,
        **initkwargs: Any,
    ) -> Callable[..., HttpResponseBase]:
        """Create a view function bound to the given OpenAPI schema."""
        return super().as_view(
            _schema=schema,
            _skip_validation=skip_validation,
            **initkwargs,
        )