a AWe@sHddlZddlmZddlmZmZmZmZmZmZGdddeZ dS)N)datetime)DynamicDocument DateTimeField BooleanField ListField StringField DynamicFieldcseZdZdZeeedddZe eddddd Z e d d d Z e ejdd dZe ddddZe ddd ZdddgdgdZfddZddZddZddZddZdd Zd!d"Zed#d$ZZS)%Basear Base class for MongoDB models with common fields and methods. This base class provides common fields and methods for MongoDB models, including fields for tags, soft deletion, and timestamps. It also supports additional custom fields through the use of a DynamicField. Attributes: public_id (str): A unique identifier for the document. It's automatically generated using UUID4. tags (list of str): A list of tags associated with the document. deleted (bool): A flag indicating whether the document has been 'soft deleted.' created_at (datetime): Date and time of creation. updated_at (datetime): Date and time of the last update. deleted_at (datetime): Date and time of deletion, if applicable. Indexes: - public_id: A unique index on the public_id field, facilitating fast lookups by the unique identifier. - created_at: An index for sorting documents by creation date. Methods: - save(): Custom save method to update 'updated_at' field before saving. - archive(): Soft delete the document by setting the 'deleted' flag and timestamp. - restore(): Restore a soft-deleted document. - add_tag(tag): Add a tag to the document if it's not already present. - remove_tag(tag): Remove a tag from the document if it exists. - to_dict(): Convert the document to a dictionary with formatted datetime fields. - _format_datetime(dt): Helper method to format a datetime object to ISO 8601 string. - get_paginated(page, per_page): Get a paginated list of documents. Example: To create a new document with tags and save it: >>> new_doc = Base(tags=['tag1', 'tag2']) >>> new_doc.save() Example: To retrieve a paginated list of documents: >>> page = 1 >>> per_page = 10 >>> result = Base.get_paginated(page, per_page) >>> total = result['total'] >>> items = result['items'] Example: To add a custom field to a document: >>> document.extra_fields['custom_data'] = 'Some additional data' >>> document.save() Tz%A unique identifier for the document.)defaultunique help_text) max_lengthZTagsz*List of tags associated with the document.) descriptionr Fz?A flag indicating whether the document has been 'soft deleted.')r r zDate and time of creation)r readonlyr Nz Date and time of the last updatez(Date and time of deletion, if applicable public_idz -created_at)allow_inheritanceabstractindexesorderingcs$t|_tt|j|i|dS)zP Custom save method to update 'updated_at' field before saving. N)rutcnow updated_atsuperr save)selfargskwargs __class__/app/app/models/base.pyrCs z Base.savecCsd|_t|_|dS)zW Soft delete the document by setting the 'deleted' flag and timestamp. TN)deletedrr deleted_atrrrrr archiveJs z Base.archivecCsd|_d|_|dS)z2 Restore a soft-deleted document. FN)r!r"rr#rrr restoreRsz Base.restorecCs"||jvr|j||dS)zH Add a tag to the document if it's not already present. N)tagsappendrrtagrrr add_tagZs  z Base.add_tagcCs"||jvr|j||dS)z> Remove a tag from the document if it exists. N)r&removerr(rrr remove_tagbs  zBase.remove_tagcCsj|}t|d|d<||d|d<||d|d<||d|d<|dd|S)z7 Convert the document to a dictionary. _idid created_atrr"_clsN)to_mongoto_dictstrpop_format_datetimeget)rZ document_dictrrr r2js  z Base.to_dictcCs|rt|tr|SdS)zO Helper method to format a datetime object to ISO 8601 string. N) isinstancer isoformat)rdtrrr r5xszBase._format_datetimecCsbtd|}ttd|d}|jdd}|jdd|d||}|||dd|DdS)z4 Get a paginated list of documents. dF)r!cSsg|] }|qSr)r2).0docrrr z&Base.get_paginated..)totalpageper_pageitems)maxminobjectscountskiplimit)clsrArBr@ documentsrrr get_paginateds   zBase.get_paginated)__name__ __module__ __qualname____doc__rr3uuiduuid4rrr&rr!rrrr/rr"metarr$r%r*r,r2r5 classmethodrL __classcell__rrrr r s*.   r ) rQr mongoenginerrrrrrr rrrr s