reviewboard.licensing.license_checks¶

License check processing types.

class ProcessCheckLicenseResultStatus(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Status results for license check processing.

This represents the possible outcomes when checking for and applying new updates to licenses.

New in version 7.1.

APPLIED = 'applied'[source]¶

A new license has been applied.

ERROR_APPLYING = 'error-applying'[source]¶

There was an error applying a new license.

HAS_LATEST = 'has-latest'[source]¶

The latest license is already applied.

__format__(format_spec)¶

Return a formatted version of the string as described by format_spec.

__new__(value)¶

__repr__()¶

Return repr(self).

__str__()¶

Return str(self).

class RequestCheckLicenseResult[source]¶

Bases: TypedDict

Result of requesting a license check.

This provides data and information needed to perform a client-side check with a license server.

New in version 7.1.

data: Mapping[str, str] | str¶

The data to send to the license server.

If this is a dictionary, it will be sent as HTTP form data.

If this is a string (such as a JSON-encoded string), it will be sent as the POST body.

url: str¶

The URL to the license server.

credentials: NotRequired[Mapping[str, str]]¶

Credentials to pass in the request to the server.

headers: NotRequired[Mapping[str, str]]¶

HTTP headers to pass in the request to the server.

session_token: NotRequired[str]¶

An optional session token sent back along with a license response.

__closed__ = None¶

__extra_items__ = typing_extensions.NoExtraItems¶

__mutable_keys__ = frozenset({'credentials', 'data', 'headers', 'session_token', 'url'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'credentials', 'data', 'headers', 'session_token', 'url'})¶

__total__ = True¶

class ProcessCheckLicenseResult[source]¶

Bases: TypedDict

Result of processing a license check.

This contains the status of the license check and any associated license information.

New in version 7.1.

status: ProcessCheckLicenseResultStatus¶

The status of the license check.

license_info: NotRequired[Mapping[str, SerializableDjangoJSONDict | None]]¶

Optional license information returned from the check.

This is a map of license IDs to serialized license dictionaries. If the serialized dictionary is None, the license is considered to be removed.

__closed__ = None¶

__extra_items__ = typing_extensions.NoExtraItems¶

__mutable_keys__ = frozenset({'license_info', 'status'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'license_info', 'status'})¶

__total__ = True¶