Database models

Data models for the db application.

class debusine.db.models.Artifact(*args, **kwargs)

Bases: Model

Artifact model.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

category

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

clean()

Ensure that data is valid for this artifact category.

Raises:

ValidationError – for invalid data.

collection_items

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

create_data() → ArtifactData

Instantiate ArtifactData from data.

created_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created_by

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

created_by_id

created_by_work_request

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

created_by_work_request_id

data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

effective_expiration_delay()

Return expiration_delay, inherited if None.

expiration_delay

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property expire_at: datetime.datetime | None

Return computed expiration date.

expired(at: datetime) → bool

Return True if this artifact has expired at a given datetime.

Parameters:

at – datetime to check if the artifact is expired.

Return bool:

True if the artifact’s expire_at is on or earlier than the parameter at.

fileinartifact_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

files

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

get_label(data: debusine.artifacts.models.ArtifactData | None = None) → str

Return a label for this artifact.

Optionally reuse an already instantiated data model.

get_next_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)

get_previous_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=False, **kwargs)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <debusine.db.models.artifacts.ArtifactManager object>

parent_collections

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

relations

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

targeted_by

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

workspace

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

workspace_id

class debusine.db.models.ArtifactRelation(*args, **kwargs)

Bases: Model

Model relations between artifacts.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

class Relations(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: TextChoices

BUILT_USING = 'built-using'

EXTENDS = 'extends'

RELATES_TO = 'relates-to'

artifact

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

artifact_id

get_type_display(*, field=<django.db.models.fields.CharField: type>)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

target

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

target_id

type

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class debusine.db.models.Collection(*args, **kwargs)

Bases: Model

Model representing a collection.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

RetainsArtifacts

alias of _CollectionRetainsArtifacts

category

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

child_artifacts

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

child_collections

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

child_items

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

collection_items

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

full_history_retention_period

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url() → str

Return the canonical URL to display the item.

get_retains_artifacts_display(*, field=<django.db.models.fields.CharField: retains_artifacts>)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

item_match_constraints

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property manager: CollectionManagerInterface

Get collection manager for this collection category.

metadata_only_retention_period

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

parent_collections

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

retains_artifacts

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

workflow

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

workspace

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

workspace_id

class debusine.db.models.CollectionItem(*args, **kwargs)

Bases: Model

CollectionItem model.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

Types

alias of _CollectionItemTypes

active_objects = <debusine.db.models.collections.CollectionItemActiveManager object>

artifact

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

artifact_id

category

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

child_type

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

collection

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

collection_id

created_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created_by_user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

created_by_user_id

data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

static expand_name(name_template: str, expanded_variables: dict[str, str]) → str

Format item name following item_template.

static expand_variables(variables: dict[str, str], artifact: Artifact) → dict[str, str]

Expand JSONPath variables against an Artifact’s data.

get_absolute_url() → str

Return the canonical URL to display the item.

get_child_type_display(*, field=<django.db.models.fields.CharField: child_type>)

get_next_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)

get_previous_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=False, **kwargs)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <debusine.db.models.collections.CollectionItemManager object>

parent_collection

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

parent_collection_id

removed_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

removed_by_user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

removed_by_user_id

class debusine.db.models.CollectionItemMatchConstraint(*args, **kwargs)

Bases: Model

Enforce matching-value constraints on collection items.

All instances of this model with the same collection, constraint_name, and key must have the same value.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

collection

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

collection_id

collection_item_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

constraint_name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

key

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class debusine.db.models.File(*args, **kwargs)

Bases: Model

Database model of a file.

Model different attributes of the file.

From outside the class use the property hash and do not use sha256 field. This allows, if ever needed, to change the hash algorithm only modifying this class without changing the users of this class.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

artifact_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

classmethod calculate_hash(file_path: Path) → bytes

Return hash for the file.

current_hash_algorithm = 'sha256'

fileinartifact_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

fileinstore_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

filestore_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

classmethod from_local_path(local_path: Path) → File

Return a File with the fields.

property hash_digest: bytes

Return the default hash digest of the File.

Use this property instead of the field to allow the algorithm to be changed in the future.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <debusine.db.models.files.FileManager object>

sha256

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

size

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class debusine.db.models.FileInArtifact(*args, **kwargs)

Bases: Model

File in artifact.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

artifact

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

artifact_id

file

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

file_id

fileupload

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

path

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class debusine.db.models.FileInStore(*args, **kwargs)

Bases: Model

Database model used as “through” from FileStore.

Keeps the relationship between stores, files and attached data.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

file

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

file_id

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

store

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

store_id

class debusine.db.models.FileStore(*args, **kwargs)

Bases: Model

Database model of a FileStore.

FileStore has files attached to it.

BackendChoices

alias of _FileStoreBackendChoices

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

backend

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

clean()

Ensure that data is valid for this backend type.

Raises:

ValidationError – for invalid data.

configuration

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

configuration_validators = {_FileStoreBackendChoices.EXTERNAL_DEBIAN_SUITE: <class 'debusine.server.file_backend.models.ExternalDebianSuiteBackendConfiguration'>, _FileStoreBackendChoices.LOCAL: <class 'debusine.server.file_backend.models.LocalFileBackendConfiguration'>, _FileStoreBackendChoices.MEMORY: <class 'debusine.server.file_backend.models.MemoryFileBackendConfiguration'>}

static default() → FileStore

Return the default FileStore.

default_workspaces

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

fileinstore_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

files

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

get_backend_display(*, field=<django.db.models.fields.CharField: backend>)

get_backend_object() → FileBackendInterface[Any]

Instantiate the correct FileBackend and return it.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

other_workspaces

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class debusine.db.models.FileUpload(*args, **kwargs)

Bases: Model

File that is being/has been uploaded.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

absolute_file_path() → Path

Return the absolute file path of the file.

The files are stored in settings.DEBUSINE_UPLOAD_DIRECTORY.

classmethod current_size(artifact: Artifact, path_in_artifact: str) → int

Return current file size.

The current file size might be smaller than the expected size of the file if the file has not finished being uploaded.

Raise ValueError if path_in_artifact does not exist in Artifact or if there’s no FileUpload object for the specific File.

delete(*args, **kwargs)

Schedule deletion of the file in the store.

file_in_artifact

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

file_in_artifact_id

get_next_by_last_activity_at(*, field=<django.db.models.fields.DateTimeField: last_activity_at>, is_next=True, **kwargs)

get_previous_by_last_activity_at(*, field=<django.db.models.fields.DateTimeField: last_activity_at>, is_next=False, **kwargs)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_activity_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

path

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class debusine.db.models.Identity(*args, **kwargs)

Bases: Model

Identity for a user in a remote user database.

An Identity is bound if it’s associated with a Django user, or unbound if no Django user is known for it.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

claims

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_last_used(*, field=<django.db.models.fields.DateTimeField: last_used>, is_next=True, **kwargs)

get_previous_by_last_used(*, field=<django.db.models.fields.DateTimeField: last_used>, is_next=False, **kwargs)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

issuer

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_used

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

subject

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id

class debusine.db.models.NotificationChannel(*args, **kwargs)

Bases: Model

Model to store notification configuration.

exception DoesNotExist

Bases: ObjectDoesNotExist

class Methods(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: TextChoices

EMAIL = 'email'

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

clean()

Ensure that data is valid for the specific method.

Raises:

ValidationError – for invalid data.

data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

data_validators = {Methods.EMAIL: <class 'debusine.tasks.models.NotificationDataEmail'>}

get_method_display(*, field=<django.db.models.fields.CharField: method>)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

method

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

save(*args, **kwargs)

Run validators and save the instance.

class debusine.db.models.Token(*args, **kwargs)

Bases: Model

Database model of a token.

A token contains a key and other related data. It’s used as a shared key between debusine server and clients (workers).

This token model is very similar to rest_framework.authtoken.models.Token. The bigger difference is that debusine’s token’s owner is a CharField, the rest_framework owner is a OneToOne foreign key to a user.

Database-wise we don’t store the token itself, but a hash of the token. TokenManager.get_token_or_none() can be used to check a provided token key against the database.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

comment

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

disable() → None

Disable the token and save it.

enable() → None

Enable the token and save it.

enabled

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)

get_previous_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=False, **kwargs)

hash

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

key: str

objects = <debusine.db.models.auth.TokenManager object>

save(*args, **kwargs) → None

Save the token. If it’s a new token it generates a key.

user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id

worker

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

class debusine.db.models.User(*args, **kwargs)

Bases: AbstractUser

Debusine user.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

artifact_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

get_next_by_date_joined(*, field=<django.db.models.fields.DateTimeField: date_joined>, is_next=True, **kwargs)

get_previous_by_date_joined(*, field=<django.db.models.fields.DateTimeField: date_joined>, is_next=False, **kwargs)

groups

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

identities

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_system

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

logentry_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

token_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

user_created_collectionitem

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

user_permissions

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

user_removed_collectionitem

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

workrequest_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class debusine.db.models.WorkRequest(*args, **kwargs)

Bases: Model

Database model of a request to execute a task.

Time-consuming operations offloaded to Workers and using Artifacts (and associated Files) as input and output.

Submission API needs to check if the request is valid using ontological rules - e.g. whether the specified distribution for a build task exists.

Avoid exposing the status of tasks to the admin interface to avoid runaway changes whilst the scheduler process is running.

The WorkRequest uses the non-Django tasks module to do the checks on whether a task can run on a particular worker.

WorkRequest State Machine

New WorkRequest database entries default to WorkRequest.Statuses.PENDING.

Once the WorkRequest is assigned to a worker and is running starts running the status is changed to WorkRequest.Statuses.RUNNING.

If the WorkRequest is aborted, the Scheduled.Task status is WorkRequest.Statuses.ABORTED.

If the task finish on the Worker the WorkRequest status will be WorkRequest.Statuses.COMPLETED and a WorkRequest.Result is then set, WorkRequest.Results.PASSED or WorkRequest.Results.FAILED.

WorkRequest.started_at is set when the WorkRequest moves from WorkRequest.Statuses.PENDING to WorkRequest.Statuses.RUNNING. WorkRequest.completed_at is set when the Task moves from WorkRequest.Statuses.RUNNING to WorkRequest.Statuses.COMPLETED.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

class Results(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: TextChoices

ERROR = 'error'

FAILURE = 'failure'

NONE = ''

SUCCESS = 'success'

Statuses

alias of _WorkRequestStatuses

class UnblockStrategy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: TextChoices

DEPS = 'deps'

MANUAL = 'manual'

add_dependency(dependency: WorkRequest) → None

Make this work request depend on another one.

artifact_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

assign_worker(worker: Worker) → None

Assign worker and save it.

can_be_automatically_unblocked() → bool

Return True iff this work request can be automatically unblocked.

can_be_unblocked() → bool

Return True iff this work request can be unblocked at all.

can_retry() → bool

Check if this work request can be retried.

can_satisfy_dynamic_data() → bool

Check if dynamic data can still be looked up.

children

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

clean()

Ensure that task data is valid for this task name.

Raises:

ValidationError – for invalid data.

completed_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

create_child(task_name: str, status: _WorkRequestStatuses = _WorkRequestStatuses.BLOCKED, task_type: TaskTypes = TaskTypes.WORKER, task_data: dict[str, Any] | None = None, workflow_data: Optional[WorkRequestWorkflowData] = None) → WorkRequest

Create a child WorkRequest.

created_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created_by

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

created_by_id

de_assign_worker() → bool

De-assign a worker from this work request.

Only allowed if the status is RUNNING or PENDING.

dependencies

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property duration: float | None

Return duration in seconds between started_at and completed_at.

dynamic_task_data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

effective_expiration_delay()

Return expiration_delay, inherited if None.

property event_reactions: EventReactions

Access event_reactions_json as a pydantic structure.

event_reactions_json

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

expiration_delay

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property expire_at: datetime.datetime | None

Return computed expiration date.

get_label(task: Optional[BaseTask[Any, Any]] = None) → str

Return a label for this work request.

Optionally reuse an already instantiated task.

get_next_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)

get_previous_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=False, **kwargs)

get_result_display(*, field=<django.db.models.fields.CharField: result>)

get_status_display(*, field=<django.db.models.fields.CharField: status>)

get_task() → BaseTask[Any, Any]

Instantiate the Task for this work request.

Raises:

InternalTaskError – if the work request is for an internal task

get_task_type_display(*, field=<django.db.models.fields.CharField: task_type>)

get_triggered_actions() → dict[str, list[Union[debusine.tasks.models.ActionSendNotification, debusine.tasks.models.ActionUpdateCollectionWithArtifacts]]]

Filter events to trigger, grouped by type.

get_unblock_strategy_display(*, field=<django.db.models.fields.CharField: unblock_strategy>)

get_workflow_root() → Optional[WorkRequest]

Return the root of this work request’s workflow, if any.

property has_children_in_progress: bool

Return whether child work requests are still in progress.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

internal_collection

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

internal_collection_id

is_aborted_failed() → bool

Check if the work request was aborted or failed.

property is_part_of_workflow: bool

Return whether this work request is part of a workflow.

property is_workflow: bool

Return whether this work request is a workflow.

mark_aborted() → bool

Worker has aborted the task after request from UI.

Task will typically be in CREATED or RUNNING status.

mark_completed(result: Results) → bool

Worker has finished executing the task.

mark_pending() → bool

Worker is ready for execution.

mark_running() → bool

Worker has begun executing the task.

maybe_finish_workflow() → bool

Update workflow status if its children are no longer in progress.

objects = <debusine.db.models.work_requests.WorkRequestManager object>

parent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

parent_id

priority_adjustment

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

priority_base

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property priority_effective: int

The effective priority of this work request.

process_event_reactions()

Process list of actions to perform on completion.

process_update_collection_with_artifacts(actions: list[Union[debusine.tasks.models.ActionSendNotification, debusine.tasks.models.ActionUpdateCollectionWithArtifacts]]) → None

Update collection following event_reactions.

result

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

retry() → WorkRequest

Create a WorkRequest that supersedes this one.

reverse_dependencies

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

review_manual_unblock(*, user: User, notes: str, action: WorkRequestManualUnblockAction | None) → None

Review a work request awaiting manual unblocking.

started_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

status

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

superseded

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

supersedes

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

supersedes_id

task_data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

task_name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

task_type

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

unblock_reverse_dependencies()

Unblock reverse dependencies.

unblock_strategy

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

unblock_workflow_children() → None

Unblock children of a workflow that has just started running.

worker

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

worker_id

property workflow_data: Optional[WorkRequestWorkflowData]

Access workflow_data_json as a python structure.

workflow_data_json

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property workflow_display_name: str

Return this work request’s name for display in a workflow.

workspace

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

workspace_id

class debusine.db.models.Worker(*args, **kwargs)

Bases: Model

Database model of a worker.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

assigned_work_requests

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

concurrency

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

connected() → bool

Return True if the Worker is connected.

connected_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

dynamic_metadata

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

dynamic_metadata_updated_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_registered_at(*, field=<django.db.models.fields.DateTimeField: registered_at>, is_next=True, **kwargs)

get_previous_by_registered_at(*, field=<django.db.models.fields.DateTimeField: registered_at>, is_next=False, **kwargs)

get_worker_type_display(*, field=<django.db.models.fields.CharField: worker_type>)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_busy() → bool

Return True if the Worker is busy with work requests.

A Worker is busy if it has as many running or pending work requests as its concurrency level.

mark_connected() → None

Update and save relevant Worker fields after connecting.

mark_disconnected() → None

Update and save relevant Worker fields after disconnecting.

metadata() → dict[str, Any]

Return all metadata with static_metadata and dynamic_metadata merged.

If the same key is in static_metadata and dynamic_metadata: static_metadata takes priority.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <debusine.db.models.workers.WorkerManager object>

registered_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

set_dynamic_metadata(metadata: dict[str, Any]) → None

Save metadata and update dynamic_metadata_updated_at.

static_metadata

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

token

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

token_id

worker_type

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class debusine.db.models.WorkflowTemplate(*args, **kwargs)

Bases: Model

Database model for Workflow templates.

Workflow templates contain the information needed to instantiate a workflow, with a Workflow orchestrator and mandatory parameters.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

clean()

Ensure that task_name and task data are valid.

Raises:

ValidationError – for invalid data.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

priority

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

task_data

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

task_name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

workspace

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

workspace_id

class debusine.db.models.Workspace(*args, **kwargs)

Bases: Model

Workspace model.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

artifact_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

chain_children

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

chain_parents

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

collection_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

default_expiration_delay

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

default_file_store

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

default_file_store_id

get_collection(*, user: Optional[User], category: str, name: str, visited: set[int] | None = None) → Collection

Lookup a collection by category and name.

If the collection is not found in this workspace, it follows the workspace inheritance chain using a depth-first search.

Parameters:

• user – user to use for permission checking

• category – collection category

• name – collection name

• visited – for internal use only: state used during graph traversal

Raises:

Collection.DoesNotExist – if the collection was not found

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

inherited_by

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

inherits

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_file_in_workspace(fileobj: File) → bool

Return True if fileobj is in any store available for Workspace.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <debusine.db.models.workspaces.WorkspaceManager object>

other_file_stores

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

public

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

set_inheritance(chain: Sequence[Workspace]) → None

Set the inheritance chain for this workspace.

workflowtemplate_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

workrequest_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

debusine.db.models.default_file_store() → FileStore

Return the default file store.

debusine.db.models.default_workspace() → Workspace

Return the default Workspace.

debusine.db.models.system_user() → User

Return the _system user.

Signing service data models.

class debusine.signing.models.AvailableKeyFileSystem(*, temp_dir: Path, certificate: bytes, key: bytes)

Bases: BaseAvailableKey

An available private key on the file system.

__init__(*, temp_dir: Path, certificate: bytes, key: bytes) → None

Construct an AvailableKeyFileSystem.

property sbsign_args: list[str]

Arguments for sbsign.

class debusine.signing.models.AvailableKeyPKCS11(*, temp_dir: Path, certificate: bytes, pkcs11_uri: str)

Bases: BaseAvailableKey

An available private key on a PKCS#11 token.

__init__(*, temp_dir: Path, certificate: bytes, pkcs11_uri: str) → None

Construct an AvailableKeyPKCS11.

property sbsign_args: list[str]

Arguments for sbsign.

class debusine.signing.models.BaseAvailableKey(*, temp_dir: Path, certificate: bytes)

Bases: ABC

A protected key that has temporarily been made available.

__init__(*, temp_dir: Path, certificate: bytes) → None

Construct a BaseAvailableKey.

abstract property sbsign_args: list[str]

Arguments for sbsign.

class debusine.signing.models.BaseProtectedKey(*, storage: ProtectedKeyStorage)

Bases: BaseModel, ABC

Base class for protected private keys.

abstract available(public_key: bytes) → Generator[BaseAvailableKey, None, None]

Make a protected key temporarily available.

Controls on the available key may vary depending on the type of protection used, but they should at least ensure that private keys do not end up on a persistent file system.

storage: ProtectedKeyStorage

class debusine.signing.models.ProtectedKey(*, __root__: debusine.signing.models.ProtectedKeyNaCl | debusine.signing.models.ProtectedKeyPKCS11Static)

Bases: BaseModel

A protected private key.

available(public_key: bytes) → Generator[BaseAvailableKey, None, None]

Make a protected key temporarily available.

Controls on the available key may vary depending on the type of protection used, but they should at least ensure that private keys do not end up on a persistent file system.

exception debusine.signing.models.ProtectedKeyError

Bases: Exception

An error handling a protected key.

class debusine.signing.models.ProtectedKeyNaCl(*, storage: ~typing.Literal[<ProtectedKeyStorage.NACL: 'nacl'>], public_key: str, encrypted: str)

Bases: BaseProtectedKey

Data for a private key encrypted in software using NaCl.

available(public_key: bytes) → Generator[BaseAvailableKey, None, None]

Make this protected key temporarily available.

classmethod create(*, public_key: str | bytes, encrypted: str | bytes) → Self

Create a new ProtectedKeyNaCl.

decrypt(private_keys: Iterable[PrivateKey]) → bytes

Decrypt data using any of an iterable of NaCl private keys.

This uses the private key that matches the stored public key, if one exists. This allows for key rotation.

Raises:

ProtectedKeyError – if none of the given private keys match the stored public key.

classmethod encrypt(public_key: PublicKey, data: bytes) → Self

Encrypt data using a NaCl public key.

encrypted: str

property encrypted_bytes: bytes

Return the base64-decoded encrypted data.

public_key: str

property public_key_bytes: bytes

Return the base64-decoded public key.

storage: NACL: 'nacl'>]

class debusine.signing.models.ProtectedKeyPKCS11Static(*, storage: ~typing.Literal[<ProtectedKeyStorage.PKCS11_STATIC: 'pkcs11-static'>], pkcs11_uri: str)

Bases: BaseProtectedKey

Data for a private key held on a PKCS#11 token.

This key is not extracted under wrap; it only ever lives on the token.

available(public_key: bytes) → Generator[BaseAvailableKey, None, None]

Make this protected key temporarily available.

classmethod create(*, pkcs11_uri: str) → Self

Create a new ProtectedKeyPKCS11Static.

pkcs11_uri: str

storage: PKCS11_STATIC: 'pkcs11-static'>]

class debusine.signing.models.ProtectedKeyStorage(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

Possible values for ProtectedKey.storage.

NACL = 'nacl'

PKCS11_STATIC = 'pkcs11-static'