migration_helper

class Code.migration_helper.MigrationHelper

Helper class to perform migrations.

Attributes:

migration_status_file : str

The path to the migration status file.

migration_status_file_lock : Lock

The lock for the migration status file.

Methods

_validate_migration_key(key, raise_exception=False)	Validate the given migration key.
get_migration_status(key)	Get the migration status for the given key.
set_migration_status(key)	Update the migration status file.
perform_migration(key)	Perform the migration for the given key, if it has not already been performed.
migrate_locked_themes()	Unlock all locked themes.

LOCKED_COLLECTION_FIELDS = 'locked_collection_fields'

LOCKED_THEMES = 'locked_themes'

_validate_migration_key(self, key, raise_exception=False)

Validate the given migration key.

Ensure the given key has a corresponding class attribute and function.

Parameters:

key : str

The key to validate.

raise_exception : pybool

Whether to raise an exception if the key is invalid.

Returns:

pybool

Whether the key is valid.

Raises:

AttributeError

If the key is invalid and raise_exception is True.

get_migration_status(self, key)

Get the migration status for the given key.

Parameters:

key : str

The key to get the migration status for.

Returns:

Optional[pybool]

The migration status for the given key, or None if the key is not found.

Examples

>>> MigrationHelper().get_migration_status(key=self.LOCKED_THEMES)
True

static migrate_locked_collection_fields()

Unlock fields locked in collections.

Prior to v0.3.0, fields for collections modified by Themerr-plex were locked which leads to an issue in v0.3.0 and newer, since Themerr-plex will not update locked fields.

static migrate_locked_themes()

Unlock all locked themes.

Prior to v0.3.0, themes uploaded by Themerr-plex were locked which leads to an issue in v0.3.0 and newer, since Themerr-plex will not update locked themes. Additionally, there was no way to know if a theme was added by Themerr-plex or not until v0.3.0, so this migration will unlock all themes.

perform_migration(self, key)

Perform the migration for the given key, if it has not already been performed.

Parameters:

key : str

The key to perform the migration for.

Examples

>>> MigrationHelper().perform_migration(key=MigrationHelper.LOCKED_THEMES)

set_migration_status(self, key)

Update the migration status file.

Parameters:

key : str

The key to update in the migration status file.

Examples

>>> MigrationHelper().set_migration_status(key=self.LOCKED_THEMES)