directory.migration

Classes

DirectoryMigration	Takes a directory and the structure/configuration it should have in
FieldTypeMigrations	Contains methods to migrate fields from one type to another.
StructuralChanges	Tries to detect structural changes between two formcode blocks.

Module Contents

class directory.migration.DirectoryMigration(directory: onegov.directory.models.Directory, new_structure: str | None = None, new_configuration: onegov.directory.types.DirectoryConfiguration | None = None, old_structure: str | None = None)

Takes a directory and the structure/configuration it should have in the future.

It then migrates the existing directory entries, if possible.

directory

old_structure

new_structure

new_configuration

new_form_class = None

fieldtype_migrations

changes

property old_directory_structure: str

property possible: bool

True if the migration is possible, False otherwise.

property entries: collections.abc.Iterable[onegov.directory.models.directory_entry.DirectoryEntry]

execute() → None

To run the migration, run this method. The other methods below should only be used if you know what you are doing.

migrate_directory() → None

migrate_entry(entry: onegov.directory.models.directory_entry.DirectoryEntry) → None

This function is called after an update to the directory structure. During execution of self.execute(), the directory is migrated. On start of looping trough the entries, an auto_flush occurs, calling the migration observer for the directory, which will instantiate yet another instance of the migration. After this inside execute(), the session is not flusing anymore, and we have to skip, since the values are already migrated and migration will fail when removing fieldsets.

migrate_values(values: dict[str, Any]) → None

add_new_fields(values: dict[str, Any]) → None

remove_old_fields(values: dict[str, Any]) → None

rename_fields(values: dict[str, Any]) → None

convert_fields(values: dict[str, Any]) → None

rename_options(values: dict[str, Any]) → None

remove_old_options(values: dict[str, Any]) → None

multiple_option_changes_in_one_step() → bool

Returns True if there are multiple changes e.g. added and removed options.

added_required_fields() → bool

Identify newly added fields that are set to be required. Newly added fields shall not be required if entries exist, make them required in a separate migration step.

get_added_required_field_ids() → list[str]

class directory.migration.FieldTypeMigrations

Contains methods to migrate fields from one type to another.

possible(old_type: str, new_type: str) → bool

get_converter(old_type: str, new_type: str) → collections.abc.Callable[[Any], Any] | None

any_to_text(value: Any) → str

any_to_textarea(value: Any) → str

textarea_to_text(value: str) → str

textarea_to_code(value: str) → str

text_to_code(value: str) → str

date_to_text(value: datetime.date) → str

datetime_to_text(value: datetime.datetime) → str

time_to_text(value: datetime.time) → str

radio_to_checkbox(value: str) → list[str]

text_to_url(value: str) → str

class directory.migration.StructuralChanges(old_structure: str, new_structure: str)

Tries to detect structural changes between two formcode blocks.

Can only be trusted if the detection_successful property is True. If it is not, the detection failed because the changes were too great.

old

new

old_fieldsets = []

new_fieldsets = []

__bool__() → bool

detect_removed_fieldsets() → None

detect_added_fieldsets() → None

detect_added_fields() → None

detect_removed_fields() → None

do_rename(removed: str, added: str) → bool

detect_renamed_fields() → None

detect_changed_fields() → None

old_field(changed: str) → onegov.form.parser.core.ParsedField

Returns the field in the old structure for a changed field.

changed_fields holds ids as they appear in the new structure, so a field that was renamed (and changed) is stored under its new id, which does not exist in self.old. This resolves the rename to look the field up under its original id.

detect_added_options() → None

detect_removed_options() → None

detect_renamed_options() → None