o ޭh@sBddlmZddlZddlZddlZddlmZmZmZm Z ddl m Z m Z ddl m Z ddlmZmZmZmZddlmZmZmZddlmZdd lmZdd lmZdd lmZdd lm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(dd l)m*Z*ddl+m,Z,ddl-m.Z.ddl/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7ddl8m9Z9m:Z:ddl;mZ>ddl?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFddlGmHZHddlImJZJddlKmLZLedddZMeNZOdMd!d"ZPdNd$d%ZQGd&d'd'eZRdOd/d0ZSdPd4d5ZTdQd9d:ZUdRdJs  z+prepare_default_ordering..)rArD)r: ordering_listparsed_orderingr@r@rFprepare_default_orderingGs rPc@s&eZdZUded<ded<ded<dS)FkSetterKwargsr=_keyrelation_fieldto_fieldN)__name__ __module__ __qualname____annotations__r@r@r@rFrQQs  rQselfvalue Model | NonerRrSrTNonecCs*t|||r t||ndt|||dSrJ)setattrrA)rYrZrRrSrTr@r@rF _fk_setterWsr^ftype type[Model]rcCsRzt||WSty(t||}|dur$|jdi||iYStYSwNr@)rAAttributeErrorfilterfirstr&)rYrRr_rSrTrZr@r@rF _fk_getterbs   re frelfield from_fieldr(cCs2t||d}|durt||||}t||||SrJ)rAr(r]rYrRr_rfrgvalr@r@rF _rfk_getterns  rjQuerySetSingle[Model | None]cCsBt||r t||S|jdi|t||i}t||||Sra)hasattrrArcrdr]rhr@r@rF _ro2o_getterxs   rm field_objectr$r%cCs.t||d}|durt||}t||||SrJ)rAr%r])rYrRrnrir@r@rF _m2m_getters   roclsdict[str, str]c Cszt|}Wn ttfyiYSwi}t|jD]+}|tur#qtd|}|D]}|d}tj dd|dtj d}| d|j ||<q+q|S)a Get comments exactly before attributes It can be multiline comment. The placeholder "{model}" will be replaced with the name of the model class. We require that the comments are in #: (with a colon) format, so you can differentiate between private and public comments. :param cls: The class we need to extract comments from its source. :return: The dictionary of comments by field name z3((?:(?!\n|^)[^\w\n]*#:.*?\n)+?)[^\w\n]*(\w+)\s*[:=]z(^\s*#:\s*|\s*$)r)flagsz{model}) inspect getsource TypeErrorOSErrorreversed__mro__objectrefindallsub MULTILINEreplacerU)rpsourcecommentscls_matchesmatch field_namecommentr@r@rF _get_commentss   rc@seZdZdZd%ddZed&d d Zd'ddZed(ddZed)ddZ d*ddZ d+ddZ d+ddZ d+ddZ d+d d!Zd+d"d#Zd$S),MetaInfo)$abstractdb_tableschemaappfields db_fields m2m_fields o2o_fieldsbackward_o2o_fields fk_fieldsbackward_fk_fields fetch_fieldsfields_db_projection_initedfields_db_projection_reversefilters fields_mapdefault_connection basequerybasequery_all_fields basetable_filtersunique_togethermanagerindexespk_attrgenerated_db_fields_modeltable_descriptionpk db_pk_columndb_native_fieldsdb_default_fieldsdb_complex_fields_default_ordering_ordering_validatedr:r;r>r\cCs>t|dd|_t|dt|_t|dd|_t|dd|_t|dd|_t|d|_t|d |_ t ||_ d|_ t |_t |_t |_t |_t |_t |_t |_t |_i|_i|_i|_i|_i|_d|_d|_t|_t|_t d|_!t|d d|_"d|_#d|_$t|d d|_%d|_&d|_'g|_(g|_)g|_*dS) NrFrtablersrrrrrr)+rArr,rrrrrGrrrPrrsetrrrrrrrrrrrrrrrrrrrrrrrrrrrrr)rYr:r@r@rF__init__sH     zMetaInfo.__init__r=cCs|jd|jjS)N.)rrrUrYr@r@rF full_nameszMetaInfo.full_namenamerZrcCs||jvr td|d|j|_||j|<||_|jr$|jp ||j|<t|t r0|j |nt|t r<|j |n t|trG|j |t|||jpN|d}|j||dS)NzField z already present in metarfield source_field)rrrmodelmodel_field_name has_db_fieldrrrBr$raddr"rr!rr*rupdatefinalise_fields)rYrrZ field_filtersr@r@rF add_fields$         zMetaInfo.add_fieldrcCs(|jdurtd|jdt|jS)Nz!default_connection for the model z cannot be None)rrrrgetrr@r@rFdbs   z MetaInfo.dbrHcCs@|jsdd|jD|j}tdd|d|jj|jS)NcSsh|]\}}|qSr@r@)rLf_r@r@rF sz$MetaInfo.ordering..zUnknown fields ,z in default ordering for model )rrrrjoinrrU)rYunknown_fieldsr@r@rFrIszMetaInfo.orderingkeyr)cCs |j|SrJ)r)rYrr@r@rF get_filter' zMetaInfo.get_filtercCs$||||dS)zD Finalise the model after it had been fully loaded. N)r_generate_filters_generate_lazy_fk_m2m_fields_generate_db_fieldsrr@r@rFfinalise_model*s zMetaInfo.finalise_modelcCst|j|_t|j|_dd|jD|_|j |j B|j B|j B|j B|_dd|jD}t||_d|_|jD]\}}|dd|jvrTd|_dSq@dS) NcSsi|]\}}||qSr@r@)rLrrZr@r@rF 6s z,MetaInfo.finalise_fields..cSsg|] }|jr|jp |jqSr@) generatedrr)rLrr@r@rF As  z,MetaInfo.finalise_fields..T__rF)rrvaluesrrkeysritemsrrrrrrrrDrrrsplit)rYgenerated_fieldsrrr@r@rFr3s4 zMetaInfo.finalise_fieldsc Cs|jD]?}d|}|j|}tt|j}|jj}t|||d}t|j |t t t fd|j i|t tfi|t tfddi|q|jD] }d|}|j|}t|j |t t t||j |j|jjdqF|jD]B}d|}tt|j|}tt|j}|jj}t|||d}t|j |t t t fd|j i|t tfi|t tfddi|qj|jD] }d|}|j|} t|j |t t t|| j | j| jjdq|jD]}d|}tt|j|} t|j |t t t|| dqdS)Nr)rRrSrTr_rZ)rRr_rfrg)rRrn)rrr r=rto_field_instancerdictr]rpropertyr re related_modelr^rrjrSrr'rrmrr$ro) rYrrRfk_field_objectrSrTproperty_kwargsbackward_fk_field_objecto2o_field_objectbackward_o2o_field_objectrnr@r@rFrNs              z%MetaInfo._generate_lazy_fk_m2m_fieldscCs|j|j|j|jD]A}|j|}|j|}|j|jj j v}|j j t j u}|r>|s4|jr>|j|||fq|rJ|j|||fq|j|||fqdSrJ)rclearrrrrr field_typerexecutor_class DB_NATIVE __class__to_python_valuerskip_to_python_if_nativeappend)rYr model_fieldris_native_field_typedefault_converterr@r@rFrs      zMetaInfo._generate_db_fieldscCsN|jjj}|jD]\}}||dd}|rt|}||d<||j|<q dS)Noperator) filter_func)rrget_overridden_filter_funcrrrr)rYrr filter_infooverridden_operatorr@r@rFrs  zMetaInfo._generate_filtersN)r:r;r>r\r>r=)rr=rZrr>r\)r>r)r>rH)rr=r>r)r>r\)rUrVrW __slots__rrrrrrIrrrrrrr@r@r@rFrs  '&       qrcsdeZdZdZd.fd d Zed/ddZed0ddZed1ddZ ed2d%d&Z d3d,d-Z Z S)4 ModelMetar@rr=basestuple[type, ...]attrsdict[str, Any]r>c si}|dtddi}d}i}|D]}|||q|r#i||}t|dd} |dkr7||||| \}}|||| \} } } } }| D]}||dqE||| || | || ||d<}t ||||}|j D]}||_ qlt |D]\}}|| vr|| |_| |jdur|dd | |_qx|jr|jst|jdd |_| D] }t|tr||_q||_||j_||S) NMetar@idrFr8_meta r)rtype_search_for_field_attributesrA_parse_custom_pk_dispatch_fieldspop build_metasuper__new__rrrrr docstring descriptionr__doc__rrucleandocrBr,rrr)rprrrr meta_classrinherited_attrsbase is_abstractrrrrrslotr: new_classrfnamerrZrr@rFrsZ        zModelMeta.__new__r rrr\cCs|jddD]}|||qt|dd}rA|jD]\}}|||<q|jD]\}}t|tr>||vr>|||<q+dS|jD]\}}t|t rW||vrW|||<qFdS)a Searching for class attributes of type fields.Field in the given class. If an attribute of the class is an instance of fields.Field, then it will be added to the fields dict. But only, if the key is not already in the dict. So derived classes have a higher precedence. Multiple Inheritance is supported from left to right. After checking the given class, the function will look into the classes according to the MRO (method resolution order). The MRO is 'natural' order, in which python traverses methods and fields. For more information on the magic behind check out: `The Python 2.3 Method Resolution Order `_. rrNr) rzrrArr__dict__rBr,rr)rpr rparentr:rrZr@r@rFrs  z&ModelMeta._search_for_field_attributesrtuple[dict, str]cCsd}|D]-\}}t|tr3|jr3|rtd|d|jr/|js/td|d|jjdd}|}q|sY|sYd|vrEdt dd i|}t|dtrQ|djsYtd|d ||fS) NFzCan't create model z< with two primary keys, only single primary key is supportedField 'z' (z) can't be DB-generatedTr) primary_keyz; without explicit primary key if field 'id' already present) rrBrrrrallows_generatedrrUr )rrrr custom_pk_presentrrZr@r@rFr8s.    zModelMeta._parse_custom_pkrPtuple[dict[str, Field], dict[str, FilterInfoDict], set[str], set[str], set[str]]c Csi}i}t}t}t}|D]Y\}} t| trj|r t| } | } ||<|| _t| tr4||qt| tr?||qt| t rJ||q| j pN|} ||<| t || | d| j rj| t d| | dq|||||fS)Nrr)rrrBrrrr'rr#r$rrr*r) rrr rrrrrrrZrrr@r@rFrUs>        zModelMeta._dispatch_fieldsr r;rdict[str, Field]rqrdict[str, FilterInfoDict]rset[str]rrrc Cst|}||_||_||_||_||_||_||_||} r:| |_ | j r+| j |_ nt | t r7|d|_ n||_ d|_|sBd|_|S)N_idFT)rrrrrrrrrrrrrBr'rr) r rrrrrrrr:pk_fieldr@r@rFrs&   zModelMeta.build_metarp type[MODEL]rr QuerySetSingle[MODEL]cC ||SrJ)_getbypkrprr@r@rF __getitem__rzModelMeta.__getitem__)rr=rrrrr>r)r rrrr>r\)rrrr=rr=r>r)rrrrr>r)r r;rrrrqrrrrrrrrrr=r>r)rprrr r>r) rUrVrWrr classmethodr staticmethodrrrr# __classcell__r@r@rrFrs5 #  ) rcseZdZUdZedZejiejiej iej iiZ de d<dd d Z dŇfd d ZdddZedddZdddZdddZdddZddd Zdd$d%Zdd&d'Zdd)d*ZeeeZ edd-d.Zedd0d1Zefdd4d5Zdd7d8Zedd=d>Z dd?d@Z!ddAdBZ"dddEdFZ#dddGdHZ$  dddKdLZ%  M dddOdPZ&   M MdddSdTZ'dddUdVZ(ddWddYdZZ)  ddd\d]Z*eddd`daZ+e  dddedfZ,eddhdiZ-e MdddkdlZ.e M M m  MdddsdtZ/e  dddvdwZ0e dddxdyZ1e  ddddZ2e 3 ddddZ3e  M   ddddZ4eddddZ5eddddZ6edddZ7edddZ8edddZ9edddZ:edddZ;eddddZeddWdddZ?eddWdddZ@eddWdddZAedddZBedddZCedddZDeddddZEdddZFGddÄdÃZGZHS)r8z1 Base class for all Tortoise ORM Models. Nz0dict[Signals, dict[type[MODEL], list[Callable]]] _listenerskwargsr r>r\cKs|j}d|_d|_d|_i|_|j||D]*}|j|}|j }t |r-||j|<qt |r9t |||qt ||t|j qdSNF)r_partial _saved_in_db_custom_generated_pk_await_when_saver difference _set_kwargsrdefaultruiscoroutinefunctioncallabler]r)rYr(r:rrn field_defaultr@r@rFrs   zModel.__init__csNt|dr |j|d||jjvs||jjvr|||t||dS)Nr-) rlr-rrrr_validate_relation_typer __setattr__)rYrrZrr@rFr5s  zModel.__setattr__rrcCs|j}h||jB}|D]q\}}||jvs||jvr;|r+|js+td|dt|||| |j |j q||j vrf|j |}|j rN|jrNd|_|dur\|js\t|dt||||q||jvrotd||jvrxtd||jvrtdq|S)Nz!You should first call .save() on z before referring to itTz+ is non nullable field, but null was passedzKYou can't set backward relations through init, change related model insteadzVYou can't set backward one to one relations through init, change related model insteadzAYou can't set m2m relations through init, use m2m_manager instead)rrrrrrr+rr]rrrrrrr,null ValueErrorrrrrr)rYr(r: passed_fieldsrrZrnr@r@rFr/s>         zModel._set_kwargsrprr7c Ks||}d|_d|_|jj|jjv|_i|_|j}t}zS|j D]\}}}t ||||| |q!|j D]\}}}||}durI| |}t |||| |q7|jD]\}}}t |||||| |qXW|Styd|_dd|j D} d} } |D]H\}}||vs||jvrq|j|}| vr| durdd|j D} || vr|dur| |}n| durdd|jD} ||}t |||qY|Sw)NFTcSg|]^}}|qSr@r@rLrrr@r@rFrz'Model._init_from_db..cSr9r@r@r:r@r@rFrr;cSr9r@r@r:r@r@rFrr;)rr*r+rrrr,r-rrr]rrrrrKeyErrorrr) rpr(rYr: inited_keysrrrrZ native_fieldsdefault_fieldscomplex_fieldsr@r@rF _init_from_dbsT         zModel._init_from_dbr=cCsd|jjdS)N<>)rrUrr@r@rF__str__#z Model.__str__cCs.|jrd|jjd|jdSd|jjdS)NrBz: rC)rrrUrr@r@rF__repr__&szModel.__repr__intcCs|jstdt|jS)Nz)Model instances without id are unhashable)rrwhashrr@r@rF__hash__+s zModel.__hash__Iterable[tuple]ccs$|jjD] }|t||fVqdSrJ)rrrA)rYrr@r@rF__iter__0s zModel.__iter__otherr{boolcCst|t|uo |j|jkSrJ)rr)rYrLr@r@rF__eq__4sz Model.__eq__cCst||jjdSrJ)rArrrr@r@rF _get_pk_val7rEzModel._get_pk_valrZcCst||jj|dSrJ)r]rr)rYrZr@r@rF _set_pk_val:szModel._set_pk_val field_keyr[cCsz|durdS|jj|}t|ttfs td|dt|j|j}t|}||ur;t d|d|jd|jddS)Nrz1' must be a OneToOne or ForeignKey relation, got z%Invalid type for relationship field 'z'. Expected model type 'z ', but got 'zH'. Make sure you're using the correct model class for this relationship.) rrrBr'r#rrrUrr)rprQrZrexpected_modelreceived_modelr@r@rFr4Cs( zModel._validate_relation_typerc s:z |j|dIdHWSttfyt||jj|w)Nr)rrr7rrrr"r@r@rFr!Xs zModel._getbypkrYrcCsVt|}|tur#|jj}|jdur|jdurt|jjdd|_n||_d|_|S)a Create a new clone of the object that when you do a ``.save()`` will create a new record. :param pk: An optionally required value if the model doesn't generate its own primary key. Any value you specify here will always be used. :return: A copy of the current object without primary key information. :raises ParamsError: If pk is required but not provided. FNz= requires explicit primary key. Please use .clone(pk=)) rEMPTYrrrr0rrr+)rYrobjrr@r@rFclone_s  z Model.clonedatacCs|||S)a Updates the current model with the provided dict. This can allow mass-updating a model from a dict, also ensuring that datatype conversions happen. This will ignore any extra fields, and NOT update the model with them, but will raise errors on bad types or updating Many-instance relations. :param data: The parameters you want to update in a dict format :return: The current model instance :raises ConfigurationError: When attempting to update a remote instance (e.g. a reverse ForeignKey or ManyToMany relation) :raises ValueError: When a passed parameter is not type compatible )r/)rYrXr@r@rFupdate_from_dictvs zModel.update_from_dictsignalr5listenerrcCs>t|std|j||g}||vr||dSdS)z Register listener to current model class for special Signal. :param signal: one of tortoise.signals.Signals :param listener: callable listener :raises ConfigurationError: When listener is not callable z!Signal listener must be callable!N)r2rr'r setdefaultr)rprZr[ cls_listenersr@r@rFregister_listeners  zModel.register_listenercsFt|dr!|jD]\}}t|||IdHq i|_dSdS)z/retrieve value from field's async default valuer-N)rlr-rrr])rYkvr@r@rF_set_async_default_fields   zModel._set_async_default_fieldcsBj|ijg}fdd|D}tj|IdHdS)Ncs g|] }|jgRqSr@r)rLr[ listener_argsrYr@rFrs z-Model._wait_for_listeners..)r'rrasynciogather)rYrZrcr] listenersr@rbrF_wait_for_listenersszModel._wait_for_listenersusing_dbBaseDBAsyncClient | Nonec|tj|IdHdSrJ)rgr5 pre_deleterYrhr@r@rF _pre_deletezModel._pre_deletecrjrJ)rgr5 post_deleterlr@r@rF _post_deleternzModel._post_delete update_fieldsIterable[str] | Nonecs|tj||IdHdSrJ)rgr5pre_save)rYrhrqr@r@rF _pre_saveszModel._pre_saveFcreatedcs|tj|||IdHdSrJ)rgr5 post_save)rYrhrurqr@r@rF _post_saveszModel._post_save force_create force_updatec sl|IdH|p|d}|j|j|d}|jrL|rC|D]#}t||jjs0t|jj dt||sAt|jj d|dqn t|jj d| ||IdH|rb| |IdHd}nE|r|| ||IdH} | dkryt d |jd }n+|js|r|jdur| |IdHd}n| ||IdHd }n | |IdHd}d|_||||IdHdS) a+ Creates/Updates the current model object. :param update_fields: If provided, it should be a tuple/list of fields by name. This is the subset of fields that should be updated. If the object needs to be created ``update_fields`` will be ignored. :param using_db: Specific DB connection to use instead of default bound :param force_create: Forces creation of the record :param force_update: Forces updating of the record :raises IncompleteInstanceError: If the model is partial and the fields are not available for persistence. :raises IntegrityError: If the model can't be created or updated (specifically if force_create or force_update has been set) :raises OperationalError: If update_fields include pk field. NTrrzL is a partial model without primary key fetchd. Partial update not availablez is a partial model, field 'z' is not availablezN is a partial model, can only be saved with the relevant update_field providedrz,Can't update object that doesn't exist. PK: F)ra _choose_dbrrr*rlrrrrUrtexecute_insertexecute_updaterrr+rw) rYrhrqrxryrexecutorrrurowsr@r@rFsavesN     z Model.savecs^|p|d}|jstd||IdH|j|j|d|IdH||IdHdS)z Deletes the current model object. :param using_db: Specific DB connection to use instead of default bound :raises OperationalError: If object has never been persisted. TzCan't delete unpersisted recordNrz)r{r+rrmrrexecute_deleterp)rYrhrr@r@rFdeletesz Model.deleterhargscs8|p|}|j|j|dj|gg|RIdHdS)a Fetch related fields. .. code-block:: python3 User.fetch_related("emails", "manager") :param args: The related fields that should be fetched. :param using_db: Specific DB connection to use instead of default bound rzN)r{rrfetch_for_list)rYrhrrr@r@rF fetch_related s *zModel.fetch_relatedrcsx|jstd|p |}t|j|}|r|j|}|j|jdIdH}|p,|j j D] }t ||t ||dq-dS)a Refresh latest data from db. When this method is called without arguments all db fields of the model are updated to the values currently present in the database. .. code-block:: python3 user.refresh_from_db(fields=['name']) :param fields: The special fields that to be refreshed. :param using_db: Specific DB connection to use instead of default bound. :raises OperationalError: If object has never been persisted. z Can't refresh unpersisted recordrTN) r+rr{r1rrhonlyrrrrr]rA)rYrrhrqsrVrr@r@rFrefresh_from_dbs  zModel.refresh_from_db for_writercCs&|rt|}nt|}|p|jjS)z Return the connection that will be used if this query is executed now. :param for_write: Whether this query for write. :return: BaseDBAsyncClient: )r4 db_for_write db_for_readrr)rprrr@r@rFr{5s   zModel._choose_dbdefaults dict | Nonetuple[Self, bool]csl|si}|p |d}z|jdi||IdHdfWSty5|j||fi|IdHYSw)a6 Fetches the object if exists (filtering on the provided parameters), else creates an instance with any unspecified parameters as default values. :param defaults: Default values to be added to a created instance if it can't be fetched. :param using_db: Specific DB connection to use instead of default bound :param kwargs: Query parameters. :raises IntegrityError: If create failed :raises TransactionManagementError: If transaction error :raises ParamsError: If defaults conflict with kwargs TNFr@)r{rcrhrr_create_or_get)rprrhr(rr@r@rF get_or_createCs& zModel.get_or_createrc s||@D]}||}||}kr$td|d|d|q i||}z3t|jd4IdH}|jd d|i|IdHdfWdIdHWS1IdHsWwYWdSty} z$z|jd i||IdHdfWWYd} ~ St yY| wd} ~ ww) z;Try to create, if fails with IntegrityError then try to getzConflict value with key=z: default_value=z vs query_value=connection_nameNrhTFr@) rrr6rcreaterrcrhrr) rprrr(r default_value query_valuemerged_defaults connectionexcr@r@rFr]s& 42 zModel._create_or_getQuerySet[Self]cCs |p||}|jj|SrJ)r{rr get_querysetrh)rprhrrr@r@rF _db_querysetpszModel._db_querysetr@nowait skip_lockedoftuple[str, ...]no_keycCs|j|ddj||||dS)z Make QuerySet select for update. Returns a queryset that will lock rows until the end of the transaction, generating a SELECT ... FOR UPDATE SQL statement on supported databases. Tr)r)rselect_for_update)rprrrrhrr@r@rFrwszModel.select_for_updatetuple[MODEL, bool]c s|si}|p |d}t|jd4IdH7}||jdi|IdH}|rC||j|dIdH|dfWdIdHSWdIdHn 1IdHsSwY|j||fi|IdHS)a2 A convenience method for updating an object with the given kwargs, creating a new one if necessary. :param defaults: Default values used to update the object. :param using_db: Specific DB connection to use instead of default bound :param kwargs: Query parameters. TrNrFr@) r{r6rrrh get_or_nonerYrr)rprrhr(rrinstancer@r@rFupdate_or_creates (zModel.update_or_createcs<|di|}d|_|p|d}|j|ddIdH|S)a Create a record in the DB and returns the object. .. code-block:: python3 user = await User.create(name="...", email="...") Equivalent to: .. code-block:: python3 user = User(name="...", email="...") await user.save() :param using_db: Specific DB connection to use instead of default bound :param kwargs: Model parameters. FT)rhrxNr@)r+r{r)rprhr(rrr@r@rFrs z Model.createobjectsIterable[MODEL] Iterable[str] batch_size int | NoneBulkUpdateQuery[MODEL]cCs|j|dd|||S)a  Update the given fields in each of the given objects in the database. This method efficiently updates the given fields on the provided model instances, generally with one query. .. code-block:: python3 users = [ await User.create(name="...", email="..."), await User.create(name="...", email="...") ] users[0].name = 'name1' users[1].name = 'name2' await User.bulk_update(users, fields=['name']) :param objects: List of objects to bulk create :param fields: The fields to update :param batch_size: How many objects are created in a single query :param using_db: Specific DB connection to use instead of default bound Tr)r bulk_update)rprrrrhr@r@rFrszModel.bulk_updateid_listIterable[str | int]rdict[str, MODEL]cs||||IdHS)aT Return a dictionary mapping each of the given IDs to the object with that ID. If `id_list` isn't provided, evaluate the entire QuerySet. :param id_list: A list of field values :param field_name: Must be a unique field :param using_db: Specific DB connection to use instead of default bound N)rin_bulk)rprrrhr@r@rFrsz Model.in_bulkignore_conflicts on_conflictBulkCreateQuery[MODEL]cCs|j|dd|||||S)a Bulk insert operation: .. note:: The bulk insert operation will do the minimum to ensure that the object created in the DB has all the defaults and generated fields set, but may be incomplete reference in Python. e.g. ``IntField`` primary keys will not be populated. This is recommended only for throw away inserts where you want to ensure optimal insert performance. .. code-block:: python3 User.bulk_create([ User(name="...", email="..."), User(name="...", email="...") ]) :param on_conflict: On conflict index name :param update_fields: Update fields when conflicts :param ignore_conflicts: Ignore conflicts when inserting :param objects: List of objects to bulk create :param batch_size: How many objects are created in a single query :param using_db: Specific DB connection to use instead of default bound Tr)r bulk_create)rprrrrqrrhr@r@rFrs% zModel.bulk_createQuerySetSingle[Self | None]cC||S)zE Generates a QuerySet that returns the first record. )rrdrprhr@r@rFrdz Model.firstcCr)zD Generates a QuerySet that returns the last record. )rlastrr@r@rFrrz Model.lastr0cO|jjj|i|S)z Generates a QuerySet with the filter applied. :param args: Q functions containing constraints. Will be AND'ed. :param kwargs: Simple filter constraints. )rrrrcrprr(r@r@rFrc#z Model.filter orderingscG|jjj|S)z Generates a QuerySet with the filter applied that returns the last record. :params orderings: Fields to order by. )rrrlatestrprr@r@rFr-z Model.latestcGr)z Generates a QuerySet with the filter applied that returns the first record. :params orderings: Fields to order by. )rrrearliestrr@r@rFr6rzModel.earliestcOr)z Generates a QuerySet with the exclude applied. :param args: Q functions containing constraints. Will be AND'ed. :param kwargs: Simple filter constraints. )rrrexcluderr@r@rFr?rz Model.excludeExpression | TermcKs|jjjdi|S)z Annotates the result set with extra Functions/Aggregations/Expressions. :param kwargs: Parameter name and the Function/Aggregation to annotate with. Nr@)rrrannotate)rpr(r@r@rFrIszModel.annotatecCr )z0 Returns the complete QuerySet. )rrr@r@rFallRs z Model.allQuerySetSingle[Self]cO||j|i|S)a Fetches a single record for a Model type using the provided filter parameters. .. code-block:: python3 user = await User.get(username="foo") :param using_db: The DB connection to use :param args: Q functions containing constraints. Will be AND'ed. :param kwargs: Simple filter constraints. :raises MultipleObjectsReturned: If provided search returned more than one object. :raises DoesNotExist: If object can not be found. )rrrprhrr(r@r@rFrYsz Model.getsqlr3cCs|||S)a Executes a RAW SQL and returns the result .. code-block:: python3 result = await User.raw("select * from users where name like '%test%'") :param using_db: The specific DB connection to use :param sql: The raw sql. )rraw)rprrhr@r@rFrms z Model.rawr/cOs||j|i|S)ao Return True/False whether record exists with the provided filter parameters. .. code-block:: python3 result = await User.exists(username="foo") :param using_db: The specific DB connection to use. :param args: Q functions containing constraints. Will be AND'ed. :param kwargs: Simple filter constraints. )rrcexistsrr@r@rFr{sz Model.existscOr)a| Fetches a single record for a Model type using the provided filter parameters or None. .. code-block:: python3 user = await User.get_or_none(username="foo") :param using_db: The specific DB connection to use. :param args: Q functions containing constraints. Will be AND'ed. :param kwargs: Simple filter constraints. )rrrr@r@rFrszModel.get_or_none instance_listIterable[Model]cs4|p|}|j||dj|g|RIdHdS)z Fetches related models for provided list of Model objects. :param instance_list: List of Model objects to fetch relations for. :param args: Relation names to fetch. :param using_db: DO NOT USE rzN)r{rr)rprrhrrr@r@rFrs &zModel.fetch_for_listcCs|d|ddS)z Calls various checks to validate the model. :raises ConfigurationError: If the model has not been configured correctly. rrN)_check_together)rpr@r@rF_checks z Model._checkr<c Cst|j|}t|ttfstd|jd|dtdd|Dr.td|jd|d|D];}t|tr:|j }|D].}|jj |}|sVtd|jd|d|d t|t rjtd|jd|d |d q.zAll 'z#' elements must be lists or tuples.z ' has no 'z' field.z' 'z#' field refers to ManyToMany field.N) rArrBrDrCrrUanyr+rrrr$)rpr<rE fields_tuplerrr@r@rFrs.   zModel._check_togetherindexIndex | tuple[str, ...] serializableIndex | tuple[str, ...] | dictcCst|tr |r |S|S|SrJ)rBr+describe)rprrr@r@rF_describe_indexs zModel._describe_indexTcs jjjjjjjjjjpdtjpdpdjj pgfddjj Djj jj  fddjj Dfddjj Dfddjj Dfddjj Dfd djj Dfd djj Dd S) a Describes the given list of models or ALL registered models. :param serializable: ``False`` if you want raw python objects, ``True`` for JSON-serializable data. (Defaults to ``True``) :return: A dictionary containing the model description. The base dict has a fixed set of keys that reference a list of fields (or a single field in the case of the primary key): .. code-block:: python3 { "name": str # Qualified model name "app": str # 'App' namespace "table": str # DB table name "abstract": bool # Is the model Abstract? "description": str # Description of table (nullable) "docstring": str # Model docstring (nullable) "unique_together": [...] # List of List containing field names that # are unique together "pk_field": {...} # Primary key field "data_fields": [...] # Data fields "fk_fields": [...] # Foreign Key fields FROM this model "backward_fk_fields": [...] # Foreign Key fields TO this model "o2o_fields": [...] # OneToOne fields FROM this model "backward_o2o_fields": [...] # OneToOne fields TO this model "m2m_fields": [...] # Many-to-Many fields } Each field is specified as defined in :meth:`tortoise.fields.base.Field.describe` Nrscsg|]}|qSr@)r)rLrrprr@rFrsz"Model.describe..cs:g|]\}}|jjkr|jjjjvr|qSr@)rrrrrrLrrrr@rFrs c&g|]\}}|jjvr|qSr@)rrrrrr@rFr  crr@)rrrrrr@rFrrcrr@)rrrrrr@rFr rcrr@)rrrrrr@rFr%rcrr@)rrrrrr@rFr*r)rrrrrrrrr data_fieldsrrrrr)rrrrrrrurrrrrrrrrr@rrFrs8&              zModel.describeGenerator[Any, None, MODEL]csdfdd }|S)Nr>r7csSrJr@r@rr@rF_self2szModel.__await__.._self)r>r7) __await__)rYrr@rrFr1s zModel.__await__c@seZdZdZdS)r;a: The ``Meta`` class is used to configure metadata for the Model. Usage: .. code-block:: python3 class Foo(Model): ... class Meta: table="custom_table" unique_together=(("field_a", "field_b"), ) N)rUrVrWrr@r@r@rFr7sr)r(r r>r\r)r(rr>r)rprr(r r>r7r)r>rG)r>rJ)rLr{r>rM)r>r )rZr r>r\)rQr=rZr[r>r\)rprrr r>r7)rYr7rr r>r7)rYr7rXrr>r7)rZr5r[rr>r\)rZr5r>r\rJ)rhrir>r\)NN)rhrirqrrr>r\)NFN)rhrirurMrqrrr>r\)NNFF) rhrirqrrrxrMryrMr>r\)rr rhrir>r\)rrrrhrir>r\)F)rrMr>r)rrrhrir(r r>r)rrrrr>rr))rhrirrMr>r)FFr@NF) rrMrrMrrrhrirrMr>r) rprrrrhrir(r r>r)rprrhrir(r r>r7) rprrrrrrrrhrir>r)rN) rprrrrr=rhrir>r)NFNNN)rprrrrrrrMrqrrrrrrhrir>r)rhrir>r)rr0r(r r>r)rr=r>r)r(rr>r)rhrir>r)rr0rhrir(r r>r)rr=rhrir>r3) rprrr0rhrir(r r>r/)rr0rhrir(r r>r)rrrr rhrir>r\)r<r=r>r\)rrrrMr>r)T)rrMr>r)rYr7r>r)IrUrVrWrrrr5rsrvrkror'rXrr5r/r$rArDrFrIrKrNrOrPrrr4r!rUrWrYr^rargrmrprtrwrrrrr{rrrrrrrrrrdrrcrrrrrrrrrrrrrrrrr&r@r@rrFr8s   %  1                    B   (          N) metaclass)r:r;r<r=r>r?)r:r;r>rH) rYr8rZr[rRr=rSr=rTr=r>r\) rYr8rRr=r_r`rSr=rTr=r>r) rYr8rRr=r_r`rfr=rgr=r>r() rYr8rRr=r_r`rfr=rgr=r>rk)rYr8rRr=rnr$r>r%)rpr`r>rq)] __future__rrdrur|collections.abcrrrrrr functoolsr typingr r r r pypika_tortoiserrrpypika_tortoise.termsrtyping_extensionsrtortoisertortoise.backends.base.clientrtortoise.exceptionsrrrrrrrrrtortoise.expressionsrtortoise.fields.basertortoise.fields.datar tortoise.fields.relationalr!r"r#r$r%r&r'r(tortoise.filtersr)r*tortoise.indexesr+tortoise.managerr,tortoise.querysetr-r.r/r0r1r2r3tortoise.routerr4tortoise.signalsr5tortoise.transactionsr6r7r{rUrGrPrQr^rerjrmrorrrrr8r@r@r@rFsT      ,  (  $       2H