djblets.integrations.models¶

Database models for integration configuration.

class BaseIntegrationConfig(*args, **kwargs)[source]¶

Bases: NeedsIntegrationManagerMixin, Model

Base class for stored configuration for a particular integration.

This contains configuration settings for a given instance of an integration, along with state indicating if that integration is to be enabled and user-specified identifying information.

This is meant to be subclassed, in order to provide additional state that may be needed by an application.

integration_id[source]¶

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

time_added[source]¶

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

last_updated[source]¶

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

name[source]¶

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

enabled[source]¶

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

settings[source]¶

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

extra_data[source]¶

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

property integration: Integration[source]¶

The integration for the configuration.

get(key: str, default: Optional[Any] = None) → Optional[Any][source]¶

Return the setting for a given key.

This will return the setting’s stored value, or its default value for the integration if unset in these settings. If the setting isn’t set in either place, the provided default will be returned instead.

Parameters:

• key (str) – The settings key.

• default (object, optional) – The default value, if not available elsewhere.

Returns:

The resulting value from settings, or the default value if not found.

Return type:

object

set(key: str, value: Optional[Any]) → None[source]¶

Set a value for the given settings key.

This is equivalent to setting the value through the standard dictionary operators.

Parameters:

• key (str) – The key to set.

• value (object) – The settings value.

__str__() → str[source]¶

Return a string representation of this configuration.

Returns:

The string representation.

Return type:

str

class Meta[source]¶

Bases: object

abstract = False[source]¶

verbose_name = 'Integration configuration'[source]¶

verbose_name_plural = 'Integration configurations'[source]¶

__annotations__ = {}¶

get_extra_data_json()¶

get_next_by_last_updated(*, field=<django.db.models.fields.DateTimeField: last_updated>, is_next=True, **kwargs)¶

get_next_by_time_added(*, field=<django.db.models.fields.DateTimeField: time_added>, is_next=True, **kwargs)¶

get_previous_by_last_updated(*, field=<django.db.models.fields.DateTimeField: last_updated>, is_next=False, **kwargs)¶

get_previous_by_time_added(*, field=<django.db.models.fields.DateTimeField: time_added>, is_next=False, **kwargs)¶

get_settings_json()¶

set_extra_data_json(json)¶

set_settings_json(json)¶