Skip to content

Views

Base

rn_forge.django.drf.views.base

Small generic DRF base views composed from rn-forge-django mixins.

BaseAPIView

Bases: RequestAccessViewMixin, ExceptionContextViewMixin, GenericAPIView

Generic DRF base view with request helpers and exception context.

drf_request property

Return self.request narrowed to a DRF request.

get_request_auth()

Return the current request auth payload.

get_request_data(key=None, default=None)

Return request data, or one body value when key is provided.

get_request_param(key, default=None)

Return a query parameter or default_value.

get_request_string(key, default=None)

Return a query/body value as a string.

get_request_user()

Return the current authenticated request user.

get_request_value(key, default=None)

Return a request-body value or default_value.

BaseModelViewSet

Bases: AuditFieldsViewMixin, ExceptionContextViewMixin, MergePatchMixin, ModelFilterViewMixin, ReadMaskMixin, ModelViewSet

Generic DRF model viewset with request helpers, exception context, merge-patch PATCH and readMask.

drf_request property

Return self.request narrowed to a DRF request.

filter_queryset(queryset)

Apply parent filters plus rn-forge's date-range active filter.

get_audit_user_identifier()

Return the actor identifier used for create/update audit fields.

get_request_auth()

Return the current request auth payload.

get_request_data(key=None, default=None)

Return request data, or one body value when key is provided.

get_request_param(key, default=None)

Return a query parameter or default_value.

get_request_string(key, default=None)

Return a query/body value as a string.

get_request_user()

Return the current authenticated request user.

get_request_value(key, default=None)

Return a request-body value or default_value.

partial_update(request, *args, **kwargs)

Apply a merge patch.

Raises:

Type Description
UnsupportedMediaType

The media type is not application/merge-patch+json (415).

PreconditionRequired

A required If-Match is missing (428).

MalformedPrecondition

If-Match is unparseable (400).

VersionConflict

If-Match is stale (412).

InvalidMergePatch

The body is not a JSON object (422).

ValidationError

The merged document is invalid (422).

perform_create(serializer)

Populate audit fields before DRF persists a new model instance.

perform_update(serializer)

Populate update audit fields before DRF persists an existing model instance.

prepare_create_data(validated_data)

Populate create audit fields on one validated serializer row.

prepare_update_data(validated_data)

Populate update audit fields on one validated serializer row.

retrieve(request, *args, **kwargs)

Return the instance, with an ETag when it is versioned.

Mixins

rn_forge.django.drf.views.mixins

Reusable DRF view mixins for rn-forge-django.

AuditFieldsViewMixin

Bases: RequestAccessViewMixin

Populate common audit fields before model serializer saves.

drf_request property

Return self.request narrowed to a DRF request.

get_audit_user_identifier()

Return the actor identifier used for create/update audit fields.

get_request_auth()

Return the current request auth payload.

get_request_data(key=None, default=None)

Return request data, or one body value when key is provided.

get_request_param(key, default=None)

Return a query parameter or default_value.

get_request_string(key, default=None)

Return a query/body value as a string.

get_request_user()

Return the current authenticated request user.

get_request_value(key, default=None)

Return a request-body value or default_value.

perform_create(serializer)

Populate audit fields before DRF persists a new model instance.

perform_update(serializer)

Populate update audit fields before DRF persists an existing model instance.

prepare_create_data(validated_data)

Populate create audit fields on one validated serializer row.

prepare_update_data(validated_data)

Populate update audit fields on one validated serializer row.

ExceptionContextViewMixin

Bases: GenericAPIView

Override DRF exception context with a friendlier action-based message.

MergePatchMixin

Bases: GenericAPIView

PATCH as an RFC 7396 JSON Merge Patch, for a viewset's partial_update.

PATCH accepts only application/merge-patch+json; any other media type is a 415. PUT and POST keep the view's own parsers. The current representation is merged with the patch and the result validated as a full update. A top-level null sets that field to null; read-only and unknown members are ignored.

When the instance is a :class:~rn_forge.django.models.VersionedModelMixin, If-Match is enforced and retrieve and PATCH answer with an ETag.

Attributes:

Name Type Description
merge_patch_requires_if_match bool

When True, a versioned PATCH without a precondition is a 428.

etag_codec ETagCodec | None

The validator format; None uses :class:rn_forge.web.VersionETagCodec.

partial_update(request, *args, **kwargs)

Apply a merge patch.

Raises:

Type Description
UnsupportedMediaType

The media type is not application/merge-patch+json (415).

PreconditionRequired

A required If-Match is missing (428).

MalformedPrecondition

If-Match is unparseable (400).

VersionConflict

If-Match is stale (412).

InvalidMergePatch

The body is not a JSON object (422).

ValidationError

The merged document is invalid (422).

retrieve(request, *args, **kwargs)

Return the instance, with an ETag when it is versioned.

ModelFilterViewMixin

Default queryset filtering for rn-forge model viewsets.

filter_queryset(queryset)

Apply parent filters plus rn-forge's date-range active filter.

PermissionByMethodMixin

Bases: GenericAPIView

Select DRF permission classes per HTTP method.

Unmapped methods use the view's permission_classes. An explicitly empty sequence leaves that method unguarded.

ReadMaskMixin

Bases: GenericAPIView

Honour readMask on retrieve, list and batch_get.

A 200 response then holds only the fields the mask names, with its ETag unchanged. On list the mask applies to each of items, and on batch_get to each resource. Other actions, and responses with any other status, are left alone. Fields are selected by their camelCase wire names, as declared by the view's serializer; a write-only field is not selectable.

Attributes:

Name Type Description
read_mask_actions frozenset[str]

The actions the mask applies to.

Raises:

Type Description
InvalidReadMask

The mask combines * with other paths, or a path names no field the serializer declares (400).

RequestAccessViewMixin

View-level façade over :class:rn_forge.django.drf.utils.RequestUtils.

Child views get a concise self.get_request_* surface while the DRF typing boundaries remain centralized in one helper module.

drf_request property

Return self.request narrowed to a DRF request.

get_request_auth()

Return the current request auth payload.

get_request_data(key=None, default=None)

Return request data, or one body value when key is provided.

get_request_param(key, default=None)

Return a query parameter or default_value.

get_request_string(key, default=None)

Return a query/body value as a string.

get_request_user()

Return the current authenticated request user.

get_request_value(key, default=None)

Return a request-body value or default_value.

SoftDeleteMixin

Bases: GenericAPIView

Soft delete in AIP-164's shape for a viewset over a soft-deleting model.

The model uses :class:~rn_forge.django.models.SoftDeleteModelMixin. List this mixin before :class:~rn_forge.django.drf.views.base.BaseModelViewSet, which supplies the audit actor and the ETag codec.

  • list and batch_delete omit deleted rows; list includes them when showDeleted is true or 1. Every other action sees all rows.
  • DELETE soft-deletes and answers 200 with the resource and its ETag. A resource that is already deleted is a 404.
  • POST {id}:undelete restores the resource and answers 200 with it.
  • PUT and PATCH on a deleted resource are a 409.

A versioned instance honours If-Match on DELETE and :undelete, after the checks above.

Attributes:

Name Type Description
soft_delete_requires_if_match bool

When True, a versioned DELETE or :undelete without a precondition is a 428.

Raises:

Type Description
NotFound

DELETE of a deleted resource (404).

ResourceDeleted

PUT or PATCH of a deleted resource (409).

ResourceNotDeleted

:undelete of a live resource (409).

PreconditionRequired

A required If-Match is missing (428).

MalformedPrecondition

If-Match is unparseable (400).

VersionConflict

If-Match is stale (412).

destroy(request, *args, **kwargs)

Soft-delete the instance and answer with it.

perform_destroy(instance)

Soft-delete instance as the request's actor.

undelete(request, *args, **kwargs)

Restore a soft-deleted instance and answer with it.

Enums

rn_forge.django.drf.views.enums

DRF views for enum choice discovery.

EnumChoicesAPIView

Bases: BaseAPIView

Return BaseEnum choices for a given Django app and enum class.

drf_request property

Return self.request narrowed to a DRF request.

get_request_auth()

Return the current request auth payload.

get_request_data(key=None, default=None)

Return request data, or one body value when key is provided.

get_request_param(key, default=None)

Return a query parameter or default_value.

get_request_string(key, default=None)

Return a query/body value as a string.

get_request_user()

Return the current authenticated request user.

get_request_value(key, default=None)

Return a request-body value or default_value.