{ "module": "mongo_ops.populate", "content": { "path": "mongo_ops.populate", "docstring": null, "objects": { "PopulationEngine": { "name": "PopulationEngine", "kind": "class", "path": "mongo_ops.populate.PopulationEngine", "signature": "", "docstring": null, "members": { "register_repo": { "name": "register_repo", "kind": "function", "path": "mongo_ops.populate.PopulationEngine.register_repo", "signature": "", "docstring": null }, "populate": { "name": "populate", "kind": "function", "path": "mongo_ops.populate.PopulationEngine.populate", "signature": "", "docstring": null }, "depopulate": { "name": "depopulate", "kind": "function", "path": "mongo_ops.populate.PopulationEngine.depopulate", "signature": "", "docstring": null } } }, "PopulateRule": { "name": "PopulateRule", "kind": "class", "path": "mongo_ops.populate.PopulateRule", "signature": "", "docstring": null, "members": { "field_name": { "name": "field_name", "kind": "attribute", "path": "mongo_ops.populate.PopulateRule.field_name", "signature": "", "docstring": null }, "collection_name": { "name": "collection_name", "kind": "attribute", "path": "mongo_ops.populate.PopulateRule.collection_name", "signature": "", "docstring": null }, "nested_rules": { "name": "nested_rules", "kind": "attribute", "path": "mongo_ops.populate.PopulateRule.nested_rules", "signature": "", "docstring": null }, "max_depth": { "name": "max_depth", "kind": "attribute", "path": "mongo_ops.populate.PopulateRule.max_depth", "signature": "", "docstring": null }, "filter": { "name": "filter", "kind": "attribute", "path": "mongo_ops.populate.PopulateRule.filter", "signature": "", "docstring": null }, "projection": { "name": "projection", "kind": "attribute", "path": "mongo_ops.populate.PopulateRule.projection", "signature": "", "docstring": null } } }, "engine": { "name": "engine", "kind": "module", "path": "mongo_ops.populate.engine", "signature": null, "docstring": null, "members": { "Any": { "name": "Any", "kind": "alias", "path": "mongo_ops.populate.engine.Any", "signature": "", "docstring": null }, "Dict": { "name": "Dict", "kind": "alias", "path": "mongo_ops.populate.engine.Dict", "signature": "", "docstring": null }, "List": { "name": "List", "kind": "alias", "path": "mongo_ops.populate.engine.List", "signature": "", "docstring": null }, "Optional": { "name": "Optional", "kind": "alias", "path": "mongo_ops.populate.engine.Optional", "signature": "", "docstring": null }, "Set": { "name": "Set", "kind": "alias", "path": "mongo_ops.populate.engine.Set", "signature": "", "docstring": null }, "Tuple": { "name": "Tuple", "kind": "alias", "path": "mongo_ops.populate.engine.Tuple", "signature": "", "docstring": null }, "TypeVar": { "name": "TypeVar", "kind": "alias", "path": "mongo_ops.populate.engine.TypeVar", "signature": "", "docstring": null }, "ObjectId": { "name": "ObjectId", "kind": "alias", "path": "mongo_ops.populate.engine.ObjectId", "signature": "", "docstring": null }, "CircularReferenceError": { "name": "CircularReferenceError", "kind": "class", "path": "mongo_ops.populate.engine.CircularReferenceError", "signature": "", "docstring": null, "members": { "collection": { "name": "collection", "kind": "attribute", "path": "mongo_ops.populate.engine.CircularReferenceError.collection", "signature": "", "docstring": null }, "doc_id": { "name": "doc_id", "kind": "attribute", "path": "mongo_ops.populate.engine.CircularReferenceError.doc_id", "signature": "", "docstring": null }, "path": { "name": "path", "kind": "attribute", "path": "mongo_ops.populate.engine.CircularReferenceError.path", "signature": "", "docstring": null } } }, "BaseDocument": { "name": "BaseDocument", "kind": "class", "path": "mongo_ops.populate.engine.BaseDocument", "signature": "", "docstring": "Base document class with common MongoDB fields.\n\nInherit from this class to create Pydantic models that represent \nMongoDB documents. It includes automatic handling of the `_id` field \nand timestamps.\n\nAttributes:\n id: The MongoDB document ID (aliased to `_id`).\n created_at: Timestamp when the document was created.\n updated_at: Timestamp when the document was last updated.", "members": { "id": { "name": "id", "kind": "attribute", "path": "mongo_ops.populate.engine.BaseDocument.id", "signature": "", "docstring": null }, "created_at": { "name": "created_at", "kind": "attribute", "path": "mongo_ops.populate.engine.BaseDocument.created_at", "signature": "", "docstring": null }, "updated_at": { "name": "updated_at", "kind": "attribute", "path": "mongo_ops.populate.engine.BaseDocument.updated_at", "signature": "", "docstring": null }, "Config": { "name": "Config", "kind": "class", "path": "mongo_ops.populate.engine.BaseDocument.Config", "signature": "", "docstring": null, "members": { "populate_by_name": { "name": "populate_by_name", "kind": "attribute", "path": "mongo_ops.populate.engine.BaseDocument.Config.populate_by_name", "signature": "", "docstring": null }, "arbitrary_types_allowed": { "name": "arbitrary_types_allowed", "kind": "attribute", "path": "mongo_ops.populate.engine.BaseDocument.Config.arbitrary_types_allowed", "signature": "", "docstring": null }, "json_encoders": { "name": "json_encoders", "kind": "attribute", "path": "mongo_ops.populate.engine.BaseDocument.Config.json_encoders", "signature": "", "docstring": null }, "json_schema_extra": { "name": "json_schema_extra", "kind": "attribute", "path": "mongo_ops.populate.engine.BaseDocument.Config.json_schema_extra", "signature": "", "docstring": null } } } } }, "PopulateRule": { "name": "PopulateRule", "kind": "class", "path": "mongo_ops.populate.engine.PopulateRule", "signature": "", "docstring": null, "members": { "field_name": { "name": "field_name", "kind": "attribute", "path": "mongo_ops.populate.engine.PopulateRule.field_name", "signature": "", "docstring": null }, "collection_name": { "name": "collection_name", "kind": "attribute", "path": "mongo_ops.populate.engine.PopulateRule.collection_name", "signature": "", "docstring": null }, "nested_rules": { "name": "nested_rules", "kind": "attribute", "path": "mongo_ops.populate.engine.PopulateRule.nested_rules", "signature": "", "docstring": null }, "max_depth": { "name": "max_depth", "kind": "attribute", "path": "mongo_ops.populate.engine.PopulateRule.max_depth", "signature": "", "docstring": null }, "filter": { "name": "filter", "kind": "attribute", "path": "mongo_ops.populate.engine.PopulateRule.filter", "signature": "", "docstring": null }, "projection": { "name": "projection", "kind": "attribute", "path": "mongo_ops.populate.engine.PopulateRule.projection", "signature": "", "docstring": null } } }, "T": { "name": "T", "kind": "attribute", "path": "mongo_ops.populate.engine.T", "signature": null, "docstring": null }, "PopulationEngine": { "name": "PopulationEngine", "kind": "class", "path": "mongo_ops.populate.engine.PopulationEngine", "signature": "", "docstring": null, "members": { "register_repo": { "name": "register_repo", "kind": "function", "path": "mongo_ops.populate.engine.PopulationEngine.register_repo", "signature": "", "docstring": null }, "populate": { "name": "populate", "kind": "function", "path": "mongo_ops.populate.engine.PopulationEngine.populate", "signature": "", "docstring": null }, "depopulate": { "name": "depopulate", "kind": "function", "path": "mongo_ops.populate.engine.PopulationEngine.depopulate", "signature": "", "docstring": null } } } } }, "rules": { "name": "rules", "kind": "module", "path": "mongo_ops.populate.rules", "signature": null, "docstring": null, "members": { "dataclass": { "name": "dataclass", "kind": "alias", "path": "mongo_ops.populate.rules.dataclass", "signature": "", "docstring": null }, "Any": { "name": "Any", "kind": "alias", "path": "mongo_ops.populate.rules.Any", "signature": "", "docstring": null }, "Dict": { "name": "Dict", "kind": "alias", "path": "mongo_ops.populate.rules.Dict", "signature": "", "docstring": null }, "List": { "name": "List", "kind": "alias", "path": "mongo_ops.populate.rules.List", "signature": "", "docstring": null }, "Optional": { "name": "Optional", "kind": "alias", "path": "mongo_ops.populate.rules.Optional", "signature": "", "docstring": null }, "PopulateRule": { "name": "PopulateRule", "kind": "class", "path": "mongo_ops.populate.rules.PopulateRule", "signature": "", "docstring": null, "members": { "field_name": { "name": "field_name", "kind": "attribute", "path": "mongo_ops.populate.rules.PopulateRule.field_name", "signature": null, "docstring": null }, "collection_name": { "name": "collection_name", "kind": "attribute", "path": "mongo_ops.populate.rules.PopulateRule.collection_name", "signature": null, "docstring": null }, "nested_rules": { "name": "nested_rules", "kind": "attribute", "path": "mongo_ops.populate.rules.PopulateRule.nested_rules", "signature": null, "docstring": null }, "max_depth": { "name": "max_depth", "kind": "attribute", "path": "mongo_ops.populate.rules.PopulateRule.max_depth", "signature": null, "docstring": null }, "filter": { "name": "filter", "kind": "attribute", "path": "mongo_ops.populate.rules.PopulateRule.filter", "signature": null, "docstring": null }, "projection": { "name": "projection", "kind": "attribute", "path": "mongo_ops.populate.rules.PopulateRule.projection", "signature": null, "docstring": null } } } } } } } }