Skip to content

Concurrency

rn_forge.django.drf.concurrency

If-Match preconditions for DRF views over versioned models.

enforce_version(request, instance, *, required=False, codec=None)

Raise unless the client's precondition matches instance's current version.

The header takes precedence over the request body's version fallback.

Parameters:

Name Type Description Default
request Request

The DRF request.

required
instance VersionedModelMixin

The row being written.

required
required bool

When True, a missing precondition is a 428.

False
codec ETagCodec | None

The validator format. Defaults to :class:rn_forge.web.VersionETagCodec, since BaseModel has no UUID primary key; pass :class:rn_forge.web.EntityVersionETagCodec to bind the entity id too.

None

Raises:

Type Description
PreconditionRequired

Nothing was sent and required is set (428).

MalformedPrecondition

The header or the body version is unparseable (400).

VersionConflict

The version does not match (412).

etag_for(instance, *, codec=None)

Return the ETag response header value for instance.