plynx.db.db_object

The class defines DBObject. This is an abstraction of all of the objects in database.

Module Contents

plynx.db.db_object.DBObjectType

plynx.db.db_object._registry

plynx.db.db_object.register_class(target_class)

Register inherited from DB Object class

plynx.db.db_object.get_class(name: str) → DBObjectType

Get DB Object inherited class object by its name from the registry

exception plynx.db.db_object.DBObjectNotFound

Bases: Exception

Internal Exception.

exception plynx.db.db_object.ClassNotSavable

Bases: Exception

Internal Exception.

class plynx.db.db_object._DBObject

DB Object. Abstraction of an object in the DB.

DB_COLLECTION =

classmethod load(cls: Type[DBObjectType], _id: ObjectId, collection: Optional[str] = None)

Load object from db.

Args:

_id (ObjectId): ID of the object in DB

save(self, force: bool = False, collection: Optional[str] = None)

Save Object in the database

copy(self: DBObjectType)

Make a copy

Return:

A copy of the Object

classmethod from_dict(cls: Type[DBObjectType], dict_obj: Dict[str, Any])

Create a class based on dict_obj

to_dict(self: DBObjectType)

Create serialized object

__str__(self)

__repr__(self)

class plynx.db.db_object.Meta

Bases: type

Class Registry handle

classmethod __new__(meta, name, bases, class_dict)

class plynx.db.db_object.DBObject

Bases: plynx.db.db_object._DBObject

DB Object. Abstraction of an object in the DB.

Args:

obj_dict (dict, None): Representation of the object. If None, an object with default fields will be created.

__post_init__(self)