[docs]class Mutator(object):
"""Abstract class to apply a mutation to the points of an ND
ScanPointGenerator"""
# Lookup table for mutator subclasses
_mutator_lookup = {}
[docs] def mutate(self, iterator):
"""
Abstract method to take each point from the given iterator, apply a
mutation and then yield the new point
Args:
iterator(iter): Iterator to mutate
Yields:
Point: Mutated points from generator
"""
raise NotImplementedError
[docs] def to_dict(self):
"""Abstract method to convert object attributes into a dictionary"""
raise NotImplementedError
@classmethod
[docs] def from_dict(cls, d):
"""
Abstract method to create a Mutator instance from a serialised
dictionary
Args:
d(dict): Dictionary of attributes
Returns:
Mutator: New Mutator instance
"""
mutator_type = d["typeid"]
generator = cls._mutator_lookup[mutator_type]
assert generator is not cls, \
"Subclass %s did not redefine from_dict" % mutator_type
mutator = generator.from_dict(d)
return mutator
@classmethod
[docs] def register_subclass(cls, mutator_type):
"""
Register a subclass so from_dict() works
Args:
mutator_type(Mutator): Subclass to register
"""
def decorator(mutator):
cls._mutator_lookup[mutator_type] = mutator
mutator.typeid = mutator_type
return mutator
return decorator