djblets.siteconfig.forms¶

A base form for working with settings stored on SiteConfigurations.

class SiteSettingsForm(siteconfig: SiteConfiguration, *args, request: HttpRequest | None = None, **kwargs)[source]¶

Bases: KeyValueForm[SiteConfiguration]

A base form for loading/saving settings for a SiteConfiguration.

This is meant to be subclassed for different settings pages. Any fields defined by the form will be loaded/saved automatically.

__init__(siteconfig: SiteConfiguration, *args, request: HttpRequest | None = None, **kwargs) → None[source]¶

Initialize the form.

Changed in version 7.0: Made request an explicitly listed parameter.

Parameters:

• siteconfig (djblets.siteconfig.models.SiteConfiguration) – The site configuration to work with on the form.

• *args (tuple) – Positional arguments to pass to the parent constructor.

• request (django.http.HttpRequest, optional) – The HTTP request from the client.

• **kwargs (dict) – Keyword arguments to pass to the parent constructor.

request: HttpRequest | None¶

The HTTP request used for this form.

Type:

django.http.HttpRequest

siteconfig: SiteConfiguration¶

The site configuration settings that are loaded from and saved to.

Type:

djblets.siteconfig.models.SiteConfiguration

get_key_value(key: str, default: SiteConfigurationSettingsValue | None = None) → SiteConfigurationSettingsValue | None[source]¶

Return the value for a SiteConfiguration settings key.

Parameters:

• key (str) – The settings key.

• default (object, unused) – The default value from the form, which will be ignored, so that the registered siteconfig defaults will be used.

Returns:

The resulting value from the settings.

Return type:

object

__annotations__ = {'css_bundle_names': 'ClassVar[Sequence[str]]', 'instance': '_T | None', 'js_bundle_names': 'ClassVar[Sequence[str]]', 'request': 'HttpRequest | None', 'siteconfig': 'SiteConfiguration'}¶

__orig_bases__ = (djblets.forms.forms.key_value_form.KeyValueForm[djblets.siteconfig.models.SiteConfiguration],)¶

__parameters__ = ()¶

declared_fields = {}¶

set_key_value(key: str, value: SiteConfigurationSettingsValue) → None[source]¶

Set the value for a SiteConfiguration settings key.

Parameters:

• key (str) – The settings key.

• value (object) – The settings value.

save_instance() → None[source]¶

Save the SiteConfiguration instance.