django_evolution.mutations.change_meta

Mutation that changes meta properties on a model.

New in version 2.2.

Classes

ChangeMeta(model_name, prop_name, new_value)

A mutation that changes meta properties on a model.
class django_evolution.mutations.change_meta.ChangeMeta(model_name, prop_name, new_value)

Bases: BaseModelMutation

A mutation that changes meta properties on a model.

Changed in version 2.2: Moved into the django_evolution.mutations.change_meta module.

simulation_failure_error = 'Cannot change the "%(prop_name)s" meta property on model "%(app_label)s.%(model_name)s".'
error_vars = {'model_name': 'model_name', 'prop_name': 'prop_name'}
__init__(model_name, prop_name, new_value)

Initialize the mutation.

Parameters:

  • model_name (unicode) – The name of the model to change meta properties on.

  • prop_name (unicode) – The name of the property to change.

  • new_value (object) – The new value for the property.

get_hint_params()

Return parameters for the mutation’s hinted evolution.

Returns:

A list of parameter strings to pass to the mutation’s constructor in a hinted evolution.

Return type:

list of unicode

simulate(simulation)

Simulate the mutation.

This will alter the database schema to change metadata on the specified model.

Parameters:

simulation (Simulation) – The state for the simulation.

Raises:

django_evolution.errors.SimulationFailure – The simulation failed. The reason is in the exception’s message.

mutate(mutator, model)

Schedule a model meta property change on the mutator.

This will instruct the mutator to change a meta property on a model. It will be scheduled and later executed on the database, if not optimized out.

Parameters:

  • mutator (django_evolution.mutators.ModelMutator) – The mutator to perform an operation on.

  • model (MockModel) – The model being mutated.