Utility Functions
YORM provides a set of utility functions to interact with mapped classes and instances in a manner similar to other ORMs.
Create
To create a new mapped object:
yorm.create(MyClass, *my_args, **my_kwargs)
If YORM is allow to overwrite an existing file during the mapping:
yorm.create(MyClass, ..., overwrite=True)
Find
Documentation coming soon...
Match
To yield all matching instances of a mapped class:
yorm.match(MyClass, **my_kwargs)
where **my_kwargs
are zero or more keyword arguments to filter instances by.
Load
Documentation coming soon...
Save
Documentation coming soon...
Delete
Documentation coming soon...
ORM Methods
If you would like your class and its instances to behave more like a traditional object-relational mapping (ORM) model, use the provided mixin class:
import yorm
class Student(yorm.ModelMixin):
...
which will add the following class methods:
new
- object factoryfind
- return a single matching objectmatch
- return all matching objects
and instance methods:
load
- update the object from its filesave
- update the file from its objectdelete
- delete the object's file