reviewboard.admin.siteconfig¶

Loads and manages site configuration settings.

load_site_config(full_reload: bool = False) → Optional[SiteConfiguration][source]¶

Load stored site configuration settings.

This populates the Django settings object with any keys that need to be there.

Parameters:

full_reload (bool, optional) – Whether to perform a full reload. This would bypass some settings comparisons where necessary.

Returns:

The loaded site configuration, if any.

Return type:

djblets.siteconfig.models.SiteConfiguration

record_siteconfig_install(siteconfig: SiteConfiguration, *, version: str) → None[source]¶

Record a new install of Review Board in the site configuration.

This will set the version, the time of the install, and start off the version_history setting with this install.

The site configuration will be saved once updated.

New in version 8.1.1.

Parameters:

• siteconfig (djblets.siteconfig.models.SiteConfiguration) – The site configuration to update.

• version (str) – The version of Review Board being installed.

record_siteconfig_upgrade(siteconfig: SiteConfiguration, *, new_version: str) → None[source]¶

Record an upgrade of Review Board in the site configuration.

This will set the new version, the time of the upgrade, and add the upgrade to the version_history setting.

If there’s no version history yet (this server predates it), it will start off with the version being upgraded from, using the best timestamp available.

The site configuration will be saved once updated.

New in version 8.1.1.

Parameters:

• siteconfig (djblets.siteconfig.models.SiteConfiguration) – The site configuration to update.

• new_version (str) – The version of Review Board being upgraded to.