o ޭhpB@sddlmZddlZddlZddlmZddlmZddlm Z m Z m Z m Z m Z mZddlmZddlmZmZddlmZe rFdd lmZejd krRdd lmZn Gd d d eeZe dZGdddeZejZejZejZej Z ej!Z!Gddde"Z#Gddde ee#dZ$dS)) annotationsN)Callable)Enum) TYPE_CHECKINGAnyGenericTypeVarUnionoverload)Term)ConfigurationErrorValidationError) Validator)Model) )StrEnumc@seZdZejZdS)rN)__name__ __module__ __qualname__str__str__rrY/var/www/html/stock_analysis/be/venv/lib/python3.10/site-packages/tortoise/fields/base.pyrs rVALUEc@s eZdZdZdZdZdZdZdS)OnDeleteCASCADERESTRICTzSET NULLz SET DEFAULTz NO ACTIONN)rrrrrSET_NULL SET_DEFAULT NO_ACTIONrrrrrs rc@seZdZd d d Zd S) _FieldMetanamerbasestuple[type, ...]attrsdictreturntypecCsnt|dkr/|dtur/t|||df|}t|dkr$|d|_|St|dd|_|St||||S)Nr)lenFieldr(__new__r field_type)mcsr"r#r%clsrrrr--sz_FieldMeta.__new__N)r"rr#r$r%r&r'r()rrrr-rrrrr!+sr!csDeZdZUdZdZded<dZded<dZded<d Zded <d Z ded <dZ d ed <dZ ded<dZ ded<e rXdQfdd ZedRddZedSd dZdTd#dZdUd%d&Z       dVdWd4d5ZdXd7d8ZdYd9d:ZdZd;d<Zed[d=d>Zed\d@dAZd]dCdDZd^dEdFZd_dHdIZd`dLdMZdadOdPZZS)br,a( Base Field type. :param source_field: Provide a source_field name if the DB column name needs to be something specific instead of generated off the field name. :param generated: Is this field DB-generated? :param primary_key: Is this field a Primary Key? Can only have a single such field on the Model, and if none is specified it will autogenerate a default primary key called ``id``. :param null: Is this field nullable? :param default: A default value for the field if not specified on Model creation. This can also be a callable for dynamic defaults in which case we will call it. The default value will not be part of the schema. :param unique: Is this field unique? :param db_index: Should this field be indexed by itself? :param description: Field description. Will also appear in ``Tortoise.describe_model()`` and as DB comments in the generated DDL. :param validators: Validators for this field. **Class Attributes:** These attributes needs to be defined when defining an actual field type. .. attribute:: field_type :annotation: type[Any] The Python type the field is. If adding a type as a mixin, _FieldMeta will automatically set this to that. .. attribute:: indexable :annotation: bool = True Is the field indexable? Set to False if this field can't be indexed reliably. .. attribute:: has_db_field :annotation: bool = True Does this field have a direct corresponding DB column? Or is the field virtualized? .. attribute:: skip_to_python_if_native :annotation: bool = False If the DB driver natively supports this Python type, should we skip it? This is for optimization purposes only, where we don't need to force type conversion between Python and the DB. .. attribute:: allows_generated :annotation: bool = False Is this field able to be DB-generated? .. attribute:: function_cast :annotation: Optional[pypika_tortoise.Term] = None A casting term that we need to apply in case the DB needs emulation help. .. attribute:: SQL_TYPE :annotation: str The SQL type as a string that the DB will use. .. attribute:: GENERATED_SQL :annotation: str The SQL that instructs the DB to auto-generate this field. Required if ``allows_generated`` is ``True``. **Per-DB overrides:** One can specify per-DB overrides of any of the class attributes, or the ``to_db_value`` or ``to_python_value`` methods. To do so, specify a inner class in the form of :samp:`class _db__{SQL_DIALECT}:` like so: .. code-block:: py3 class _db_sqlite: SQL_TYPE = "VARCHAR(40)" skip_to_python_if_native = False def function_cast(self, term: Term) -> Term: return functions.Cast(term, SqlTypes.NUMERIC) Tortoise will then use the overridden attributes/functions for that dialect. If you need a dynamic attribute, you can use a property. Nz type[Any]r.Tbool indexable has_db_fieldFskip_to_python_if_nativeallows_generatedzCallable[[Term], Term] | None function_castrSQL_TYPE GENERATED_SQLargsrkwargsr' Field[VALUE]cs t|SN)superr-)r0r9r: __class__rrr-s z Field.__new__instanceNoneowner type[Model]cCdSr<rselfr@rBrrr__get__z Field.__get__rrcCrDr<rrErrrrGrH Model | NoneField[VALUE] | VALUEcCrDr<rrErrrrGvaluecCrDr<r)rFr@rLrrr__set__rKz Field.__set__ source_field str | None generated primary_key bool | Nonenulldefaultuniquedb_index descriptionmodel validators!list[Validator | Callable] | Nonec KsR| dd} dur&|durtjdtdd| }n || kr&t|jjd|js6|s-|r6t|jjd| dd} dur\|durOtjdtdd| }n || kr\t|jjd |rt| rit|jjd |rtt|jjd |rzd }d }||_||_ t ||_ ||_ ||_ ||_t ||_d |_||_d|_| pg|_| |_d|_dS)Nindexz4`index` is deprecated, please use `db_index` insteadr*) stacklevelz" can't set both db_index and indexz can't be indexedpkz4`pk` is deprecated, please use `primary_key` insteadz" can't set both primary_key and pkz$ can't be both null=True and pk=Truez- can't be both null=True and primary_key=TrueT)popwarningswarnDeprecationWarningr r?rr2rNrPr1r]rTrSrUr[model_field_namerW docstringrYrX reference)rFrNrPrQrSrTrUrVrWrXrYr:r[r]rrr__init__sf        zField.__init__type[Model] | ModelcCs,|durt||js||}|||S)at Converts from the Python type to the DB type. :param value: Current python value in model. :param instance: Model class or Model instance provided to look up. Due to metacoding, to determine if this is an instance reliably, please do a: .. code-block:: py3 if hasattr(instance, "_saved_in_db"): N) isinstancer.validate)rFrLr@rrr to_db_values  zField.to_db_valuecCs"|durt||js||}|S)zd Converts from the DB type to the Python type. :param value: Value from DB N)rhr.)rFrLrrrto_python_values zField.to_python_valuec Csn|jD]1}|jr |dur qzt|tr||jn||Wqty4}z t|jd|d}~wwdS)z Validate whether given value is valid :param value: Value to be validation :raises ValidationError: If validator check is not passed Nz: )rYrSrhrrLr rc)rFrLvexcrrrris   zField.validatecCs|jduo |j o |j S)z Returns ``True`` if the field is required to be provided. It needs to be non-nullable and not have a default or be DB-generated to be required. N)rTrSrPrFrrrrequiredszField.requiredr&cCsiS)z\ Returns a dict with constraints defined in the Pydantic/JSONSchema format. rrnrrr constraints"szField.constraintsdict[str, dict]c si}t|D]A}|dsqt||j}z|Wn ty%YnwfddtD}i||}dd|D||dd<q|S)N_db_cs(i|]}tt|tr|t|qSr)rhgetattrproperty).0propr0objrr 5s  z'Field._get_dialects..cSs i|] \}}|ds||qS)_) startswith)rukrlrrrry<s )dirr{rs__dict__ TypeErroritems)rFretdialectdpropsrrwr _get_dialects)s"        zField._get_dialectscCs|jjjjj}||dS)zS Returns the DB field type for this field for the current dialect. r7)rX_metadb capabilitiesrget_for_dialect)rFrrrrget_db_field_type@s zField.get_db_field_typedict[str, str] | Nonecs<jsdSjdifddfddtDDS)z Returns the DB types for this field. :return: A dictionary that is keyed by dialect. A blank dialect `""` means it is the default DB field type. Nr^csi|] \}}|kr||qSrr)rursql_typerTrrrySs z,Field.get_db_field_types..c3s:|]}|dr|dd|dddfVqdS)rrr}Nr7)r{r)rukeyrnrr Us z+Field.get_db_field_types..)r3r7r~rnr)rTrFrget_db_field_typesGs  zField.get_db_field_typesrrcCsZzt|d|}t||}Wn tyYnwt|tr%t|||S|St||dS)z Returns a field by dialect override. :param dialect: The requested SQL Dialect. :param key: The attribute/method name. rrN)rsAttributeErrorrhrt)rFrr dialect_cls dialect_valuerrrr^s   zField.get_for_dialect serializablec sddddfd d }dd d}t|d|j}|j|r |jjn|j|jp'|j|r-||n||j|j|j|j p9|j|r@||j n|j |j |j |j d }|jrT||d<|S)a Describes the field. :param serializable: ``False`` if you want raw python objects, ``True`` for JSON-serializable data. (Defaults to ``True``) :return: A dictionary containing the field description. (This assumes ``serializable=True``, which is the default): .. code-block:: python3 { "name": str # Field name "field_type": str # Field type "db_column": str # Name of DB column # Optional: Only for pk/data fields "raw_field": str # Name of raw field of the Foreign Key # Optional: Only for Foreign Keys "db_field_types": dict # DB Field types for default and DB overrides "python_type": str # Python type "generated": bool # Is the field generated by the DB? "nullable": bool # Is the column nullable? "unique": bool # Is the field unique? "indexed": bool # Is the field indexed? "default": ... # The default value (coerced to int/float/str/bool/null) "description": str # Description of the field (nullable) "docstring": str # Field docstring (nullable) } When ``serializable=False`` is specified some fields are not coerced to valid JSON types. The changes are: .. code-block:: python3 { "field_type": Field # The Field class used "python_type": Type # The actual Python type "default": ... # The default value as native type OR a callable } typr(r'rcSs<|jdkr|jS|jdkrt|ddS|jd|jS)Nbuiltinstypingztyping.r^.)rrrreplacerrrr _type_names  z"Field.describe.._type_namerstr | list[str]c stz|jjWSttfyYnwz|WSty9z fdd|DWYSty8t|YYSww)Ncsg|]}|qSrr)ru_typrrr sz5Field.describe..type_name..)r full_namerrrrrrr type_names    z!Field.describe..type_namerTint | float | str | bool | NonecSsBt|tttttdfr|St|rd|jd|jdSt|S)Nz ) rhintfloatrr1r(callablerrrrrr default_names z$Field.describe..default_name related_model) r"r. db_column python_typerPnullablerUindexedrTrWrdrpdb_field_typesN)rr(r'r)rrr'r)rTrr'r)rsr.rcr?rrNrPrSrUr[rTrWrdrpr3r)rFrrrr.descrrrdescribess( -    zField.describe)r9rr:rr'r;)r@rArBrCr'r;)r@rrBrCr'r)r@rIrBrCr'rJ)r@rrLrr'rA) NFNFNFNNNN)rNrOrPr1rQrRrSr1rTrrUr1rVrRrWrOrXrIrYrZr:rr'rA)rLrr@rgr'r)rLrr'r)rLrr'rA)r'r1)r'r&)r'rq)r'r)r'r)rrrrr'r)rr1r'r&)rrr__doc__r.__annotations__r2r3r4r5r6r7r8rr-r rGrMrfrjrkrirtrorprrrrr __classcell__rrr>rr,7sR  V            C        r,) metaclass)% __future__rsysr`collections.abcrenumrrrrrrr r pypika_tortoise.termsr tortoise.exceptionsr r tortoise.validatorsrtortoise.modelsr version_inforrrrrrrrr r(r!r,rrrrs.