Annotation Class¶
The muspy.Annotation
class is a container for annotations. For flexibility, annotation can hold any type of data.
Attributes | Description | Type | Default |
---|---|---|---|
time | Start time | int | |
annotation | Annotation of any type |
-
class
muspy.
Annotation
(time: int, annotation: Any, group: str = None)[source] A container for annotations.
-
annotation
¶ Annotation of any type.
Type: any
-
adjust_time
(func: Callable[[int], int], attr: str = None, recursive: bool = True) → BaseType Adjust the timing of time-stamped objects.
Parameters: Returns: Return type: Object itself.
-
copy
() → BaseType Return a shallow copy of the object.
This is equivalent to
copy.copy(self)()
.Returns: Return type: Shallow copy of the object.
-
deepcopy
() → BaseType Return a deep copy of the object.
This is equivalent to
copy.deepcopy(self)()
Returns: Return type: Deep copy of the object.
-
fix_type
(attr: str = None, recursive: bool = True) → BaseType Fix the types of attributes.
Parameters: Returns: Return type: Object itself.
-
classmethod
from_dict
(dict_: Mapping[KT, VT_co], strict: bool = False, cast: bool = False) → BaseType Return an instance constructed from a dictionary.
Instantiate an object whose attributes and the corresponding values are given as a dictionary.
Parameters: Returns: Return type: Constructed object.
-
is_valid
(attr: str = None, recursive: bool = True) → bool Return True if an attribute has a valid type and value.
This will recursively apply to an attribute’s attributes.
Parameters: Returns: Whether the attribute has a valid type and value.
Return type: See also
muspy.Base.validate()
- Raise an error if an attribute has an invalid type or value.
muspy.Base.is_valid_type()
- Return True if an attribute is of a valid type.
-
is_valid_type
(attr: str = None, recursive: bool = True) → bool Return True if an attribute is of a valid type.
This will apply recursively to an attribute’s attributes.
Parameters: Returns: Whether the attribute is of a valid type.
Return type: See also
muspy.Base.validate_type()
- Raise an error if a certain attribute is of an invalid type.
muspy.Base.is_valid()
- Return True if an attribute has a valid type and value.
-
pretty_str
(skip_missing: bool = True) → str Return the attributes as a string in a YAML-like format.
Parameters: skip_missing (bool, default: True) – Whether to skip attributes with value None or those that are empty lists. Returns: Stored data as a string in a YAML-like format. Return type: str See also
muspy.Base.print()
- Print the attributes in a YAML-like format.
-
print
(skip_missing: bool = True) Print the attributes in a YAML-like format.
Parameters: skip_missing (bool, default: True) – Whether to skip attributes with value None or those that are empty lists. See also
muspy.Base.pretty_str()
- Return the the attributes as a string in a YAML-like format.
-
to_ordered_dict
(skip_missing: bool = True, deepcopy: bool = True) → collections.OrderedDict Return the object as an OrderedDict.
Return an ordered dictionary that stores the attributes and their values as key-value pairs.
Parameters: Returns: A dictionary that stores the attributes and their values as key-value pairs, e.g., {“attr1”: value1, “attr2”: value2}.
Return type: OrderedDict
-
validate
(attr: str = None, recursive: bool = True) → BaseType Raise an error if an attribute has an invalid type or value.
This will apply recursively to an attribute’s attributes.
Parameters: Returns: Return type: Object itself.
See also
muspy.Base.is_valid()
- Return True if an attribute has a valid type and value.
muspy.Base.validate_type()
- Raise an error if an attribute is of an invalid type.
-
validate_type
(attr: str = None, recursive: bool = True) → BaseType Raise an error if an attribute is of an invalid type.
This will apply recursively to an attribute’s attributes.
Parameters: Returns: Return type: Object itself.
See also
muspy.Base.is_valid_type()
- Return True if an attribute is of a valid type.
muspy.Base.validate()
- Raise an error if an attribute has an invalid type or value.
-