API Reference¶
timber_grammar Joint module¶
-
class
timber_grammar.Joint.Joint¶ Bases:
object-
classmethod
from_data(data)¶ Construct a Joint object from structured data. This class method must be overridden by an inherited class.
- data : dict
- The data dictionary.
- object
- An object of the type (based on the ‘type’ value defined in data)
This constructor method is meant to be used in conjuction with the corresponding to_data method.
-
to_data()¶ Returns a dictionary of structured data representing the data structure. Actual implementation is in @property def data(self) of the inherited class Returns ——- dict
The structured data.This method produces the data that can be used in conjuction with the corresponding from_data class method.
-
classmethod
from_json(filepath)¶ Construct a datastructure from structured data contained in a json file. Parameters ———- filepath : str
The path to the json file.- object
- An object of the type of a Joint subclass
This constructor method is meant to be used in conjuction with the corresponding to_json method.
-
to_json(filepath, pretty=False)¶ Serialise the structured data representing the data structure to json. Parameters ———- filepath : str
The path to the json file.
-
classmethod