U Lk7gg@sddlZddlZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl Z ddlZddlmZmZmZmZddlmZmZddlmZddlmZz ddlZWnek rdZYn XddlZdd lmZmZm Z m!Z!m"Z"m#Z#m$Z$dd l%m&Z&dd l'm(Z(dd l)m*Z*m+Z+dd l,m-Z-m.Z.ddl/m0Z0m1Z1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8z0ddl9m:Z:m;Z;eZ>ne:j>Z>Wnek rdZ:dZ;YnXdZ?dZ@GdddeZAGdddeAZBGdddeAZCGdddeZDGdddeDZEGd d!d!eZFGd"d#d#eZGGd$d%d%eZHGd&d'd'eZIGd(d)d)eIZJGd*d+d+eAZKGd,d-d-eZLGd.d/d/eZMGd0d1d1eZNGd2d3d3e ZOGd4d5d5eOZPGd6d7d7eOZQd8d9ZRd:d;ZSGdd?d?eTZUGd@dAdAeZVGdBdCdCeZWGdDdEdEeZXGdFdGdGeZYGdHdIdIeZZGdJdKdKe[Z\GdLdMdMZ]GdNdOdOeZ^GdPdQdQe]Z_GdRdSdSe[Z`GdTdUdUe^ZaGdVdWdWeZbGdXdYdYeZcGdZd[d[eZdGd\d]d]e!ZeGd^d_d_e!ZfGd`dadae!ZgGdbdcdce!ZhGdddedee!ZiGdfdgdge!ZjGdhdidieZkGdjdkdkeXZlGdldmdmeZmdS)nN)isclass)BytesIO) itemgetter)SONBinaryDBRefObjectId) Decimal128create_decimal128_contextInt64)ReturnDocument) BaseDocument BaseFieldComplexBaseFieldGeoJsonBaseField LazyReference ObjectIdField get_document)LazyRegexCompiler) _import_class)DEFAULT_CONNECTION_NAMEget_db)DocumentEmbeddedDocument) DoesNotExistInvalidQueryErrorValidationError) DO_NOTHING) BaseQuerySet)STRING_OPERATORS)ImageImageOps Resampling), StringFieldURLField EmailFieldIntField LongField FloatField DecimalField BooleanField DateTimeField DateFieldComplexDateTimeFieldEmbeddedDocumentFieldrGenericEmbeddedDocumentField DynamicField ListFieldSortedListFieldEmbeddedDocumentListField DictFieldMapFieldReferenceFieldCachedReferenceFieldLazyReferenceFieldGenericLazyReferenceFieldGenericReferenceField BinaryField GridFSError GridFSProxy FileFieldImageGridFsProxyImproperlyConfigured ImageField GeoPointField PointFieldLineStringField PolygonField SequenceField UUIDField EnumFieldMultiPointFieldMultiLineStringFieldMultiPolygonFieldrDecimal128FieldselfcsFeZdZdZd fdd ZddZddZd d Zfd d ZZ S)r$zA unicode string field.Nc s2|rt|nd|_||_||_tjf|dS)av :param regex: (optional) A string pattern that will be applied during validation :param max_length: (optional) A max length that will be applied during validation :param min_length: (optional) A min length that will be applied during validation :param kwargs: Keyword arguments passed into the parent :class:`~mongoengine.BaseField` N)recompileregex max_length min_lengthsuper__init__)rNrQrRrSkwargs __class__6/tmp/pip-unpacked-wheel-n1etwkgt/mongoengine/fields.pyrUsszStringField.__init__cCs6t|tr|Sz|d}Wntk r0YnX|S)Nzutf-8) isinstancestrdecode ExceptionrNvaluerYrYrZ to_pythons zStringField.to_pythoncCst|ts|d|jdk r6t||jkr6|d|jdk rXt||jkrX|d|jdk r||j|dkr||ddS)Nz&StringField only accepts string valueszString value is too longzString value is too shortz+String value did not match validation regex)r[r\errorrRlenrSrQmatchr_rYrYrZvalidates    zStringField.validatecCsdSNrYrN member_namerYrYrZ lookup_memberszStringField.lookup_membercst|ts|S|tkr|d}|d}|r4tjnd}d}|dkrJd}n6|dkrXd}n(|dkrfd }n|d krtd }n |d kr|}|d krt||}nt|}t|||}t ||S) Nir%s startswithz^%sendswithz%s$exactz^%s$Z wholewordz\b%s\brQ) r[r\r rllstriprO IGNORECASErPescaperTprepare_query_value)rNopr`Zcase_insensitiveflagsrQrWrYrZrrs,    zStringField.prepare_query_value)NNN) __name__ __module__ __qualname____doc__rUrarerirr __classcell__rYrYrWrZr$ps    r$csBeZdZdZedejZddddgZd fdd Z d d Z Z S) r%z'A field that validates input as an URL.z^(?:[a-z0-9\.\-]*)://(?:(?:[A-Z0-9](?:[A-Z0-9-_]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}(?eZdZdZd fdd ZddZddZfd d ZZS) r'z32-bit integer field.Nc s |||_|_tjf|dSa :param min_value: (optional) A min value that will be applied during validation :param max_value: (optional) A max value that will be applied during validation :param kwargs: Keyword arguments passed into the parent :class:`~mongoengine.BaseField` N min_value max_valuerTrUrNrrrVrWrYrZrUKszIntField.__init__c Cs*z t|}Wnttfk r$YnX|Srf)int TypeError ValueErrorr_rYrYrZraTs  zIntField.to_pythonc Cstz t|}Wn&ttfk r2|d|YnX|jdk rR||jkrR|d|jdk rp||jkrp|ddS)Nz %s could not be converted to intzInteger value is too smallzInteger value is too large)rrrrbrrr_rYrYrZre[s  zIntField.validatecs|dkr |St|t|Srf)rTrrrrNrsr`rWrYrZrrgszIntField.prepare_query_value)NN rurvrwrxrUrarerrryrYrYrWrZr'Hs   r'c@seZdZdZddZdS)r(zW64-bit integer field. (Equivalent to IntField since the support to Python2 was dropped)cCst|Srfr r_rYrYrZto_mongoqszLongField.to_mongoN)rurvrwrxrrYrYrYrZr(nsr(cs>eZdZdZd fdd ZddZddZfd d ZZS) r)zFloating point number field.Nc s |||_|_tjf|dSrrrrWrYrZrUxszFloatField.__init__cCs&z t|}Wntk r YnX|Srf)floatrr_rYrYrZras  zFloatField.to_pythoncCst|tr6z t|}Wntk r4|dYnXt|tsJ|d|jdk rh||jkrh|d|jdk r||jkr|ddS)Nz/The value is too large to be converted to floatz0FloatField only accepts float and integer valueszFloat value is too smallzFloat value is too large)r[rr OverflowErrorrbrrr_rYrYrZres     zFloatField.validatecs|dkr |St|t|Srf)rTrrrrrWrYrZrrszFloatField.prepare_query_value)NNrrYrYrWrZr)us  r)csReZdZdZddddejffdd ZddZd d Zd d Z fd dZ Z S)r*aDisclaimer: This field is kept for historical reason but since it converts the values to float, it is not suitable for true decimal storage. Consider using :class:`~mongoengine.fields.Decimal128Field`. Fixed-point decimal number field. Stores the value as a float by default unless `force_string` is used. If using floats, beware of Decimal to float conversion (potential precision loss) NFc sL||_||_||_|dks$t|ts.|d||_||_tj f|dS)a% :param min_value: (optional) A min value that will be applied during validation :param max_value: (optional) A max value that will be applied during validation :param force_string: Store the value as a string (instead of a float). Be aware that this affects query sorting and operation like lte, gte (as string comparison is applied) and some query operator won't work (e.g. inc, dec) :param precision: Number of decimal places to store. :param rounding: The rounding rule from the python decimal library: - decimal.ROUND_CEILING (towards Infinity) - decimal.ROUND_DOWN (towards zero) - decimal.ROUND_FLOOR (towards -Infinity) - decimal.ROUND_HALF_DOWN (to nearest with ties going towards zero) - decimal.ROUND_HALF_EVEN (to nearest with ties going to nearest even integer) - decimal.ROUND_HALF_UP (to nearest with ties going away from zero) - decimal.ROUND_UP (away from zero) - decimal.ROUND_05UP (away from zero if last digit after rounding towards zero would have been 0 or 5; otherwise towards zero) Defaults to: ``decimal.ROUND_HALF_UP`` :param kwargs: Keyword arguments passed into the parent :class:`~mongoengine.BaseField` rz$precision must be a positive integerN) rr force_stringr[rrb precisionroundingrTrU)rNrrrrrrVrWrYrZrUs zDecimalField.__init__c Csvztd|}Wn tttjfk r2|YSX|jdkr^|jtdd|j|jdS|jt|jdSdS)Nrkrz.%s0)r)decimalDecimalrrInvalidOperationrquantizerr_rYrYrZras  zDecimalField.to_pythoncCs"|jrt||St||Srf)rr\rarr_rYrYrZrszDecimalField.to_mongoc Cst|tjsft|tst|}zt|}Wn8tttjfk rd}z|d|W5d}~XYnX|jdk r||jkr|d|j dk r||j kr|ddS)Nz&Could not convert value to decimal: %sDecimal value is too smallDecimal value is too large) r[rrr\rrrrbrrrNr`excrYrYrZres    zDecimalField.validatecs |dkr |St|||SrfrTrrrrrWrYrZrrsz DecimalField.prepare_query_value) rurvrwrxr ROUND_HALF_UPrUrarrerrryrYrYrWrZr*s * r*c@s eZdZdZddZddZdS)r+zBoolean field type.c Cs*z t|}Wnttfk r$YnX|Srf)boolrrr_rYrYrZras  zBooleanField.to_pythoncCst|ts|ddS)Nz(BooleanField only accepts boolean values)r[rrbr_rYrYrZres zBooleanField.validateN)rurvrwrxrarerYrYrYrZr+sr+cs<eZdZdZddZddZeddZfdd ZZ S) r,avDatetime field. Uses the python-dateutil library if available alternatively use time.strptime to parse the dates. Note: python-dateutil's parser is fully featured and when installed you can utilise it to convert varying types of date formats into valid python datetime objects. Note: To default the field to the current datetime, use: DateTimeField(default=datetime.utcnow) Note: Microseconds are rounded to the nearest millisecond. Pre UTC microsecond support is effectively broken. Use :class:`~mongoengine.fields.ComplexDateTimeField` if you need accurate microsecond support. cCs.||}t|tjtjfs*|d|dS)Nzcannot parse date "%s")rr[datetimedaterb)rNr` new_valuerYrYrZres zDateTimeField.validatecCsf|dkr |St|tjr|St|tjrYdSXd|kr|z|d\}}t|}Wqtk rxYdSXnd}d|i}zt j t |ddd|WStk r:z"t j t |ddd|WYStk r4z&t j t |ddd |WYYStk r.YYYdSXYnXYnXdS) N.r microsecondz%Y-%m-%d %H:%M:%Sz%Y-%m-%d %H:%Mz%Y-%m-%d) stripdateutilparserparserrrrrrtimestrptime)r`ZusecsrVrYrYrZr+sF   zDateTimeField._parse_datetimecst|||SrfrrrWrYrZrrSsz!DateTimeField.prepare_query_value) rurvrwrxrer staticmethodrrrryrYrYrWrZr,s  'r,cs(eZdZfddZfddZZS)r-cs0t|}t|tjr,t|j|j|j}|Srf)rTrr[rrrrr_rWrYrZrXs  zDateField.to_mongocs0t|}t|tjr,t|j|j|j}|Srf)rTrar[rrrrrr_rWrYrZra_s  zDateField.to_python)rurvrwrraryrYrYrWrZr-Ws r-csneZdZdZdfdd ZddZddZfd d Zfd d Zd dZ ddZ ddZ fddZ Z S)r.a ComplexDateTimeField handles microseconds exactly instead of rounding like DateTimeField does. Derives from a StringField so you can do `gte` and `lte` filtering by using lexicographical comparison when filtering / sorting strings. The stored string has the following format: YYYY,MM,DD,HH,MM,SS,NNNNNN Where NNNNNN is the number of microseconds of the represented `datetime`. The `,` as the separator can be easily modified by passing the `separator` keyword when initializing the field. Note: To default the field to the current datetime, use: DateTimeField(default=datetime.utcnow) ,c s2||_|dddddddg|_tjf|dS) z :param separator: Allows to customize the separator used for storage (default ``,``) :param kwargs: Keyword arguments passed into the parent :class:`~mongoengine.StringField` z%Yz%mz%dz%Hz%Mz%Sz%fN) separatorjoinrrTrU)rNrrVrWrYrZrUzszComplexDateTimeField.__init__cCs ||jS)aN Convert a `datetime` object to a string representation (which will be stored in MongoDB). This is the reverse function of `_convert_from_string`. >>> a = datetime(2011, 6, 8, 20, 26, 24, 92284) >>> ComplexDateTimeField()._convert_from_datetime(a) '2011,06,08,20,26,24,092284' )strftimer)rNvalrYrYrZ_convert_from_datetimes z+ComplexDateTimeField._convert_from_datetimecCs dd||jD}tj|S)aV Convert a string representation to a `datetime` object (the object you will manipulate). This is the reverse function of `_convert_from_datetime`. >>> a = '2011,06,08,20,26,24,092284' >>> ComplexDateTimeField()._convert_from_string(a) datetime.datetime(2011, 6, 8, 20, 26, 24, 92284) cSsg|] }t|qSrY)r).0drYrYrZ sz=ComplexDateTimeField._convert_from_string..)rrr)rNdatavaluesrYrYrZ_convert_from_strings z)ComplexDateTimeField._convert_from_stringcs<|dkr |St||}t|tjs.|dkr2|S||Srf)rT__get__r[rr)rNinstanceownerrrWrYrZrs zComplexDateTimeField.__get__csRt|||j|j}|dk rNt|tjrB|||j|j<n ||j|j<dSrf)rT__set___datanamer[rrrNrr`rWrYrZrs   zComplexDateTimeField.__set__cCs$||}t|tjs |ddS)Nz8Only datetime objects may used in a ComplexDateTimeField)rar[rrbr_rYrYrZres  zComplexDateTimeField.validatecCs.|}z ||WStk r(|YSXdSrf)rr^rNr`original_valuerYrYrZras  zComplexDateTimeField.to_pythoncCs||}||Srf)rarr_rYrYrZrs zComplexDateTimeField.to_mongocs |dkr |St|||Srf)rTrrrrrWrYrZrrsz(ComplexDateTimeField.prepare_query_value)r)rurvrwrxrUrrrrrerarrrryrYrYrWrZr.gs   r.cs\eZdZdZfddZeddZddZdd d Zdd d Z ddZ fddZ Z S)r/zAn embedded document field - with a declared document_type. Only valid values are subclasses of :class:`~mongoengine.EmbeddedDocument`. c s6t|tst|ts|d||_tjf|dSNzDInvalid embedded document class provided to an EmbeddedDocumentField)r[r\ issubclassrrbdocument_type_objrTrUrN document_typerVrWrYrZrUszEmbeddedDocumentField.__init__cCsHt|jtrB|jtkr|j}n t|j}t|ts<|d||_|jSr) r[rr\RECURSIVE_REFERENCE_CONSTANTowner_documentrrrrb)rNZresolved_document_typerYrYrZrs    z#EmbeddedDocumentField.document_typecCs"t||js|jj||jdS|S)N)_auto_dereference)r[r _from_sonrr_rYrYrZras  zEmbeddedDocumentField.to_pythonTNcCs t||js|S|j|||Srf)r[rrrNr` use_db_fieldfieldsrYrYrZrs zEmbeddedDocumentField.to_mongocCs&t||js|d|j|ddS)zMake sure that the document instance is an instance of the EmbeddedDocument subclass provided when the document was defined. zGInvalid embedded document instance provided to an EmbeddedDocumentFieldcleanN)r[rrbrerNr`rrYrYrZres  zEmbeddedDocumentField.validatecCs8|jg|j}|D]}|j|}|r|SqdSrf)r__subclasses___fieldsget)rNrhdoc_and_subclassesdoc_typefieldrYrYrZris  z#EmbeddedDocumentField.lookup_membercs|dk rpt||jspt|tr8tdd|Dr8|Sz|j|}Wn&tk rntd|jjfYnXt ||| |S)Ncss|]}|dVqdS)$N)rl)rkrYrYrZ sz.zIQuerying the embedded document '%s' failed, due to an invalid query value) r[rdictallkeysrrr _class_namerTrrrrrWrYrZrr s  z)EmbeddedDocumentField.prepare_query_value)TN)T) rurvrwrxrUpropertyrrarrerirrryrYrYrWrZr/s    r/csDeZdZdZfddZddZdddZd d Zdd d ZZ S)r0a*A generic embedded document field - allows any :class:`~mongoengine.EmbeddedDocument` to be stored. Only valid values are subclasses of :class:`~mongoengine.EmbeddedDocument`. .. note :: You can use the choices param to limit the acceptable EmbeddedDocument types cst|||SrfrrrWrYrZrr$sz0GenericEmbeddedDocumentField.prepare_query_valuecCs$t|tr t|d}||}|SN_cls)r[rrrrNr`doc_clsrYrYrZra's   z&GenericEmbeddedDocumentField.to_pythonTcCsT|jr0t|tr0|jD]}|d|jkrdSqt|tsD|d|j|ddS)NrTzNInvalid embedded document instance provided to an GenericEmbeddedDocumentFieldr)choicesr[rrrrbre)rNr`rchoicerYrYrZre.s  z%GenericEmbeddedDocumentField.validatecCsL|jpg}|D]8}|g|}|D] }|j|}|r$|Sq$qdSrf)r rrr)rNrhZdocument_choicesZdocument_choicerrrrYrYrZri<s  z*GenericEmbeddedDocumentField.lookup_memberNcCs.|dkr dS|||}d|kr*|j|d<|Sr)rr)rNdocumentrrrrYrYrZrEs   z%GenericEmbeddedDocumentField.to_mongo)T)TN) rurvrwrxrrrarerirryrYrYrWrZr0s    r0csHeZdZdZdddZfddZdd Zfd d Zdd d ZZ S)r1zA truly dynamic field type capable of handling different and varying types of data. Used by :class:`~mongoengine.DynamicDocument` to handle dynamic dataTNc Cst|tr|St|dr\|j}|||}t|trD||jd}t|trX|j|d<|St|t t t fsp|Sd}t|dsd}ddt |D}i}| D]\}} || ||||<q|}|rd d t| td d D}|S) z3Convert a Python type to a MongoDB compatible type.r)_refrrFitemsTcSsi|]\}}||qSrYrYrrvrYrYrZ jsz)DynamicField.to_mongo..cSsg|] \}}|qSrYrYrrYrYrZrrsz)DynamicField.to_mongo..r)key)r[r\hasattrrXrrZto_dbrefrurrlisttuple enumerater sortedr) rNr`rrclsrZis_listrrrrYrYrZrTs.       zDynamicField.to_mongocsNt|trBd|krBt|d}d|kr8||d}||St|SNrr )r[rr_get_db dereferencerrTrarrWrYrZraus   zDynamicField.to_pythoncCs|SrfrYrgrYrYrZri~szDynamicField.lookup_membercs,t|trt||St|||Srf)r[r\r$rrrTrrrWrYrZrrs z DynamicField.prepare_query_valuecCst|dr|j|ddS)Nrer)rrerrYrYrZres zDynamicField.validate)TN)T) rurvrwrxrrarirrreryrYrYrWrZr1Ns  !  r1csLeZdZdZd ddfdd ZfddZfdd Zfd d ZZS) r2a,A list field that wraps a standard field, allowing multiple instances of the field to be used as a list in the database. If using with ReferenceFields see: :ref:`many-to-many-with-listfields` .. note:: Required means it cannot be empty - as the default for ListFields is [] N)rRc s,||_|dttjfd|i|dS)Ndefaultr)rR setdefaultrrTrU)rNrrRrVrWrYrZrUs zListField.__init__csf|dkr S|jj}td}td}tj||frX|rXfdd|D|jj<t||S)Nr9r:csg|]}j|qSrY)r build_lazyref)rxrNrYrZrsz%ListField.__get__..)rrrrr[rrTr)rNrrr`r9r:rWrrZrszListField.__get__csLt|tttfs|d|jdk r.) rRrcrbrrr[r\rrrrT)rNrsr`Zis_iterZ eligible_iterrWr)rZrrs   zListField.prepare_query_value)N) rurvrwrxrUrrerrryrYrYrWrZr2s    r2cs eZdZdZfddZZS)r4zA :class:`~mongoengine.ListField` designed specially to hold a list of embedded documents to provide additional query helpers. .. note:: The only valid list values are subclasses of :class:`~mongoengine.EmbeddedDocument`. c stjfdt|i|dS)z :param document_type: The type of :class:`~mongoengine.EmbeddedDocument` the list will hold. :param kwargs: Keyword arguments passed into the parent :class:`~mongoengine.ListField` rN)rTrUr/rrWrYrZrUsz"EmbeddedDocumentListField.__init__rurvrwrxrUryrYrYrWrZr4sr4cs.eZdZdZfddZdfdd ZZS) r3aA ListField that sorts the contents of its list before writing to the database in order to ensure that a sorted list is always retrieved. .. warning:: There is a potential race condition when handling lists. If you set / save the whole list then other processes trying to save the whole list as well could overwrite changes. The safest way to append to a list is to perform a push operation. c s0|dd|_|dd|_tj|f|dS)NZorderingreverseF)pop _ordering_order_reverserTrU)rNrrVrWrYrZrUszSortedListField.__init__TNcs>t|||}|jdk r0t|t|j|jdSt||jdS)N)rr+)r+)rTrr-rrr.rrWrYrZrs zSortedListField.to_mongo)TN)rurvrwrxrUrryrYrYrWrZr3s r3cCs8|D]*\}}t|tr,t|trt|rdSqdS)z]Helper function to recursively determine if any key in a dictionary is not a string. TN)r r[r\rkey_not_stringrrrrYrYrZr/sr/cCs8|D]*\}}|ds,t|trt|rdSqdS)zaHelper function to recursively determine if any key in a dictionary starts with a dollar rTN)r rlr[rkey_starts_with_dollarr0rYrYrZr1sr1csBeZdZdZd fdd ZfddZddZfd d ZZS) r5zA dictionary field that wraps a standard Python dictionary. This is similar to an embedded document, but the structure is not defined. .. note:: Required means it cannot be empty - as the default for DictFields is {} Ncs0|dttj|d|i||ddS)NrrF)rrrTrUZset_auto_dereferencingrNrrrVrWrYrZrUs zDictField.__init__csLt|ts|dt|r*d}||t|r<|dt|dS)r z,Only dictionaries may be used in a DictFieldz=Invalid dictionary key - documents must have only string keyszDInvalid dictionary key name - keys may not startswith "$" charactersN)r[rrbr/r1rTre)rNr`msgrWrYrZres   zDictField.validatecCs t|dS)N)Zdb_field)r5rgrYrYrZri*szDictField.lookup_membercsxt}|kr&t|tr&t|Stjdrjdkr\t|tr\fdd|DSj|St |S)Nr)r"r$cs i|]\}}|j|qSrYr(rr)rYrZr7sz1DictField.prepare_query_value..) r r[r\r$rrrrrr rT)rNrsr`Zmatch_operatorsrWr)rZrr-s zDictField.prepare_query_value)N) rurvrwrxrUrerirrryrYrYrWrZr5 s  r5cs"eZdZdZdfdd ZZS)r6zA field that maps a name to a specified field type. Similar to a DictField, except the 'value' of each item must match the specified field type. Ncs.t|ts|dtj|d|i|dS)Nz6Argument to MapField constructor must be a valid fieldr)r[rrbrTrUr2rWrYrZrUEs  zMapField.__init__)Nr*rYrYrWrZr6?sr6csveZdZdZdeffdd ZeddZeddZ fd d Z d d Z d dZ fddZ ddZddZZS)r7aA reference to a document that will be automatically dereferenced on access (lazily). Note this means you will get a database I/O access everytime you access this field. This is necessary because the field returns a :class:`~mongoengine.Document` which precise type can depend of the value of the `_cls` field present in the document in database. In short, using this type of field can lead to poor performances (especially if you access this field only to retrieve it `pk` field which is already known before dereference). To solve this you should consider using the :class:`~mongoengine.fields.LazyReferenceField`. Use the `reverse_delete_rule` to handle what should happen if the document the field is referencing is deleted. EmbeddedDocuments, DictFields and MapFields does not support reverse_delete_rule and an `InvalidDocumentError` will be raised if trying to set on one of these Document / Field types. The options are: * DO_NOTHING (0) - don't do anything (default). * NULLIFY (1) - Updates the reference to null. * CASCADE (2) - Deletes the documents associated with the reference. * DENY (3) - Prevent the deletion of the reference object. * PULL (4) - Pull the reference from a :class:`~mongoengine.fields.ListField` of references Alternative syntax for registering delete rules (useful when implementing bi-directional delete rules) .. code-block:: python class Org(Document): owner = ReferenceField('User') class User(Document): org = ReferenceField('Org', reverse_delete_rule=CASCADE) User.register_delete_rule(Org, 'owner', DENY) Fc sJt|ts&t|rt|ts&|d||_||_||_t j f|dS)aqInitialises the Reference Field. :param document_type: The type of Document that will be referenced :param dbref: Store the reference as :class:`~pymongo.dbref.DBRef` or as the :class:`~pymongo.objectid.ObjectId`. :param reverse_delete_rule: Determines what to do when the referring object is deleted :param kwargs: Keyword arguments passed into the parent :class:`~mongoengine.BaseField` .. note :: A reference to an abstract document type is always stored as a :class:`~pymongo.dbref.DBRef`, regardless of the value of `dbref`. zKArgument to ReferenceField constructor must be a document class or a stringN) r[r\rrrrbdbrefrreverse_delete_rulerTrU)rNrr4r5rVrWrYrZrUtszReferenceField.__init__cCs2t|jtr,|jtkr |j|_n t|j|_|jSrfr[rr\rrrrrYrYrZrs     zReferenceField.document_typecCs.||}|dkr$td|||SNz'Trying to dereference unknown document rrrrZref_clsr4Zdereferenced_sonrYrYrZ_lazy_load_refszReferenceField._lazy_load_refcst|dkr |S|j|j}|j|jj}|rft|trft|drLt|j }n|j }| |||j|j<t ||S)'Descriptor to allow lazy dereferencing.Nr)rrrrrr[rrrrrr:rTr)rNrrZ ref_valueauto_dereferencerrWrYrZrs  zReferenceField.__get__cCst|tr|js|jS|St|trB|j}|dkr<|d|}n |}|j}|jd}|j |}| |}|jj dr| }t|||j dS|jr| }t||S|S)NJYou can only reference documents once they have been saved to the databaseid_fieldabstract)r)r[rr4idrpkrbr_metarrr_get_collection_namer)rNr id_r id_field_namer> collectionrYrYrZrs.      zReferenceField.to_mongocCs8|js4t|tttfs4|j}t||jj|}|Sz3Convert a MongoDB-compatible type to a Python type.) r4r[rrrrrCr@rarNr`rFrYrYrZras zReferenceField.to_pythoncs$|dkr dSt||||SrfrrrWrYrZrrsz"ReferenceField.prepare_query_valuecCs@t||jtttfs|dt|tr<|jdkr<|ddS)NzIA ReferenceField only accepts DBRef, LazyReference, ObjectId or documentsr=)r[rrrrrbrr@r_rYrYrZreszReferenceField.validatecCs|jj|SrfrrrrgrYrYrZriszReferenceField.lookup_member)rurvrwrxrrUrrrr:rrrarrreriryrYrYrWrZr7Ls(   %  r7cseZdZdZdfdd ZddZdd Zd d Zed d Z e ddZ fddZ dddZ ddZddZddZddZZS)r8z:A referencefield with cache fields to purpose pseudo-joinsNTc sX|dkr g}t|ts4t|r*t|ts4|d||_||_||_ t j f|dS)a[Initialises the Cached Reference Field. :param document_type: The type of Document that will be referenced :param fields: A list of fields to be cached in document :param auto_sync: if True documents are auto updated :param kwargs: Keyword arguments passed into the parent :class:`~mongoengine.BaseField` NzQArgument to CachedReferenceField constructor must be a document class or a string) r[r\inspectrrrrb auto_syncrrrTrU)rNrrrKrVrWrYrZrUs zCachedReferenceField.__init__cCs$ddlm}|jj|j|jddS)Nr)signals)sender)Z mongoenginerLZ post_saveconnecton_document_pre_saver)rNrLrYrYrZstart_listeners z#CachedReferenceField.start_listenerc sR|rdSfdd|dD}|rNi}||j<jjf|jf|dS)Ncs.i|]&\}}|jkrdjd||qS)Zset____)rr)rrrrrYrZr"s z=CachedReferenceField.on_document_pre_save..r)Z_deltar rrobjectsupdate)rNrMr createdrV update_kwargs filter_kwargsrYrrZrOs  z)CachedReferenceField.on_document_pre_savecCsHt|trD|j}t||jj|d}|j|j |S|S)N_id) r[rrrCrr@rarrrrHrYrYrZra-s  zCachedReferenceField.to_pythoncCs2t|jtr,|jtkr |j|_n t|j|_|jSrfr6rrYrYrZr7s     z"CachedReferenceField.document_typecCs.||}|dkr$td|||Sr7r8r9rYrYrZr:@sz#CachedReferenceField._lazy_load_refcsZ|dkr |S|j|j}|j|jj}|rLt|trL||j||j|j<t ||Srf) rrrrrr[rr:rrTr)rNrrr`r<rWrYrZrHszCachedReferenceField.__get__c s|jjd}|jj|}t|tr<|j}|dkrF|dn |dtd||ff}rtfdd|j D}n|j }| t |j||d|S)Nr>r=zOnly accept a document objectrWcsg|]}|kr|qSrYrY)rfrrYrZrjsz1CachedReferenceField.to_mongo..rY) rrBrr[rrArbrrrrSr) rNr rrrEr>rDr` new_fieldsrYrYrZrWs    zCachedReferenceField.to_mongocCs^|dkr dSt|trV|jdkr*|dd|ji}|jD]}||||iq:|StdS)Nr=rW)r[rrArbrrSNotImplementedError)rNrsr`Z value_dictrrYrYrZrrqs    z(CachedReferenceField.prepare_query_valuecCs8t||js|dt|tr4|jdkr4|ddS)Nz-A CachedReferenceField only accepts documentsr=)r[rrbrr@r_rYrYrZres   zCachedReferenceField.validatecCs|jj|SrfrIrgrYrYrZrisz"CachedReferenceField.lookup_membercCsLd|j}|jjD]4}i}|||j<i}|||<|jjf|jf|qdS)zb Sync all cached fields on demand. Caution: this operation may be slower. zset__%sN)rrrRrrS)rNZ update_keydocrVrUrYrYrZsync_alls   zCachedReferenceField.sync_all)NT)TN)rurvrwrxrUrPrOrarrrr:rrrrrerir]ryrYrYrWrZr8s      r8cs\eZdZdZfddZfddZeddZfdd Zd d Z d d Z ddZ Z S)r;aA reference to *any* :class:`~mongoengine.document.Document` subclass that will be automatically dereferenced on access (lazily). Note this field works the same way as :class:`~mongoengine.document.ReferenceField`, doing database I/O access the first time it is accessed (even if it's to access it ``pk`` or ``id`` field). To solve this you should consider using the :class:`~mongoengine.fields.GenericLazyReferenceField`. .. note :: * Any documents used as a generic reference must be registered in the document registry. Importing the model will automatically register it. * You can use the choices param to limit the acceptable Document types csx|dd}tj||g|_|rt|D]J}t|trD|j|q(t|trht|t rh|j|j q(| dq(dS)Nr zIInvalid choices provided: must be a list ofDocument subclasses and/or str) r,rTrUr r[r\appendtyperrrrb)rNrrVr r rWrYrZrUs  zGenericReferenceField.__init__cs6t|tr|d}nt|tr&|j}t|dSr)r[rrrrrT_validate_choicesr_rWrYrZr`s    z'GenericReferenceField._validate_choicescCs.||}|dkr$td|||Sr7r8r9rYrYrZr:sz$GenericReferenceField._lazy_load_refcsh|dkr |S|j|j}|j|jj}|rZt|trZt|d}|||d|j|j<t ||Sr) rrrrrr[rrr:rTr)rNrrr`r<rrWrYrZrs zGenericReferenceField.__get__cCsht|ttttfs|dt|ttfrFd|ks:d|krd|dnt|trd|jdkrd|ddS)Nz,GenericReferences can only contain documentsr rr=)r[rrrrrbr@r_rYrYrZres  zGenericReferenceField.validatecCs|dkr dSt|ttttfr"|S|jjd}|jj|}t|tr^|j }|dkrb| dn|}| |}| }t||}td|j fd|ffS)Nr>r=rr )r[rrrrrXrBrrr@rbrrCr)rNr rEr>rDrFrefrYrYrZrs"     zGenericReferenceField.to_mongocCs|dkr dS||SrfrrrYrYrZrrsz)GenericReferenceField.prepare_query_value) rurvrwrxrUr`rr:rrerrrryrYrYrWrZr;s    r;csJeZdZdZd fdd ZfddZddZd d Zfd d ZZ S)r<zA binary data field.Nc s||_tjf|dSrf) max_bytesrTrU)rNrcrVrWrYrZrUszBinaryField.__init__cs t|trt|}t||S)zHandle bytearrays in python 3.1)r[ bytearraybytesrTrrrWrYrZrs zBinaryField.__set__cCst|Srf)rr_rYrYrZr#szBinaryField.to_mongocCsJt|ttfs$|dtjtjf|jdk rFt||jkrF|ddS)Nz6BinaryField only accepts instances of (%s, %s, Binary)zBinary value is too long)r[rerrbrurcrcr_rYrYrZre&s zBinaryField.validatecs |dkr |St|||SrfrrrWrYrZrr0szBinaryField.prepare_query_value)N) rurvrwrxrUrrrerrryrYrYrWrZr<s   r<csXeZdZdZfddZfddZfddZfdd Zd d Zfd d Z Z S)rIaEnumeration Field. Values are stored underneath as is, so it will only work with simple types (str, int, etc) that are bson encodable Example usage: .. code-block:: python class Status(Enum): NEW = 'new' ONGOING = 'ongoing' DONE = 'done' class ModelWithEnum(Document): status = EnumField(Status, default=Status.NEW) ModelWithEnum(status='done') ModelWithEnum(status=Status.DONE) Enum fields can be searched using enum or its value: .. code-block:: python ModelWithEnum.objects(status='new').count() ModelWithEnum.objects(status=Status.NEW).count() The values can be restricted to a subset of the enum by using the ``choices`` parameter: .. code-block:: python class ModelWithEnum(Document): status = EnumField(Status, choices=[Status.NEW, Status.DONE]) c sh||_|drHg}|dD]}t||s||q|rVtd|nt|j|d<tjf|dS)Nr zInvalid choices: %r) _enum_clsrr[r^rrrTrU)rNenumrVZinvalid_choicesr rWrYrZrUYs    zEnumField.__init__csVt||jrt|Sz||Wn*tk rP||d|jYnXdS)Nz is not a valid )r[rfrTrerrbr_rWrYrZrefs   zEnumField.validatecsBt|}t||js>z ||WStk r<|YSX|Srf)rTrar[rfrr_rWrYrZrans    zEnumField.to_pythoncst|||Srf)rTrrarrWrYrZrwszEnumField.__set__cCst||jr|jS|Srf)r[rfr`r_rYrYrZrzs zEnumField.to_mongocs |dkr |St|||SrfrrrWrYrZrrszEnumField.prepare_query_value) rurvrwrxrUrerarrrrryrYrYrWrZrI6s"  rIc@s eZdZdS)r=NrurvrwrYrYrYrZr=sr=c@seZdZdZdZdddedfddZddZdd Zd d Z d d Z ddZ ddZ ddZ ddZddZddZeddZd1ddZddZd d!Zd"d#Zd$d%Zd2d'd(Zd)d*Zd+d,Zd-d.Zd/d0ZdS)3r>zFProxy object to handle writing and reading of files to and from GridFSNfscCs.||_||_||_||_||_d|_d|_dSrf)grid_idrrdb_aliascollection_namenewfilegridout)rNrjrrrkrlrYrYrZrUszGridFSProxy.__init__cCs:d}||kr||S|}t||r2t||StdS)N)_fsrjrrrkrlrmrn)__getattribute__rrgetattrAttributeError)rNrattrsobjrYrYrZ __getattr__s    zGridFSProxy.__getattr__cCs|SrfrYrrYrYrZrszGridFSProxy.__get__cCs t|jSrf)rrjrrYrYrZ__bool__szGridFSProxy.__bool__cCs|j}d|d<|S)Nro)__dict__)rNZ self_dictrYrYrZ __getstate__szGridFSProxy.__getstate__cCst}|j||Srf)r>rwrSrx)rNcopiedrYrYrZ__copy__szGridFSProxy.__copy__cCs|Srf)rz)rNmemorYrYrZ __deepcopy__szGridFSProxy.__deepcopy__cCsd|jjd|jdS)N<: >)rXrurjrrYrYrZ__repr__szGridFSProxy.__repr__cCs4|}|r|jnd}d|jjd|d|jdS)Nz r}r~z (z)>)rfilenamerXrurj)rNrnrrYrYrZ__str__szGridFSProxy.__str__cCs6t|tr.|j|jko,|j|jko,|j|jkSdSdS)NF)r[r>rjrlrkrNotherrYrYrZ__eq__s    zGridFSProxy.__eq__cCs ||k SrfrYrrYrYrZ__ne__szGridFSProxy.__ne__cCs"|jstt|j|j|_|jSrf)rogridfsZGridFSrrkrlrrYrYrZriszGridFSProxy.fscCsV|r ||_|jdkrdSz"|jdkr4|j|j|_|jWStk rPYdSXdSrf)rjrnrirr^)rNrjrYrYrZrs  zGridFSProxy.getcKs&|jjf||_|jj|_|dSrf)rinew_filermrWrj_mark_as_changed)rNrVrYrYrZrs zGridFSProxy.new_filecKs,|jrtd|jj|f||_|dSNzRThis document already has a file. Either delete it or call replace to overwrite it)rjr=riputrrNfile_objrVrYrYrZrs zGridFSProxy.putcCs.|jr|jstdn||j|dSr)rjrmr=rwrite)rNstringrYrYrZrszGridFSProxy.writecCs(|js||jj|_|j|dSrf)rmrrWrj writelines)rNlinesrYrYrZrs zGridFSProxy.writelinesrcCs<|}|dkrdSz ||WStk r6YdSXdS)N)rreadr^)rNsizernrYrYrZr s zGridFSProxy.readcCs&|j|jd|_d|_|dSrf)rideleterjrnrrrYrYrZrszGridFSProxy.deletecKs||j|f|dSrf)rrrrYrYrZreplaceszGridFSProxy.replacecCs|jr|jdSrf)rmcloserrYrYrZr!szGridFSProxy.closecCs|jr|j|jdS)z4Inform the instance that `self.key` has been changedN)rrrrrYrYrZr%szGridFSProxy._mark_as_changed)N)r)rurvrwrxrorrUrurrvrxrzr|rrrrrrirrrrrrrrrrrYrYrYrZr>s<       r>cs\eZdZdZeZedffdd ZddZddZ dd d Z d d Z ddZ ddZ ZS)r?zA GridFS storage field.ric stjf|||_||_dSrf)rTrUrlrk)rNrkrlrVrWrYrZrU0szFileField.__init__cCsZ|dkr |S|j|j}t||jsB|j|j|d}||j|j<|jsV|j|_||_|S)Nrr)rrrr[ proxy_class get_proxy_objrr)rNrr grid_filerYrYrZr7s  zFileField.__get__cCs|j}t|drt|tr(t|ttfr|j|j}|r\z |Wnt k rZYnX|j ||d|j|<|j| |n ||j|<| |dS)Nrr) rrr[r>rer\rrrr^rrr)rNrr`rrrYrYrZrFs"   zFileField.__set__NcCs.|dkr|j}|dkr|j}|j||||dS)N)rrrkrl)rkrlr)rNrrrkrlrYrYrZr\szFileField.get_proxy_objcCs t||jr|jdk r|jSdSrf)r[rrjr_rYrYrZriszFileField.to_mongocCs |dk r|j||j|jdSdS)N)rlrk)rrlrkr_rYrYrZraos zFileField.to_pythoncCs:|jdk r6t||js |dt|jts6|ddS)Nz)FileField only accepts GridFSProxy valueszInvalid GridFSProxy value)rjr[rrbrr_rYrYrZreus     zFileField.validate)NN)rurvrwrxr>rrrUrrrrrareryrYrYrWrZr?+s r?csheZdZdZfddZfddZddZedd Zed d Z ed d Z ddZ ddZ Z S)r@zProxy for ImageFieldc s|jj|j}t|dr*t|jtr*|j}zt|}|j }Wn.t k rl}zt d|W5d}~XYnX|j dp|d}| drt| dtr|dkrd}nd}|jr |jd|jd ks|jd |jd kr |j}|d rt||d |d ft}n||d |d ftd} |jrx|j}|d rXt||d |d ft} n |} | |d |d ft| r|| ||} nd} |j\} } t} |j| ||d | dtj| f| | || d|S)ze Insert a image in database applying field properties (size, thumbnail_size) rzInvalid image: %sN progressiveFZJPEGTrwidthrheightforcer)rrr thumbnail_id)rrrrr[rr?r!openrr^rinforrrr"ZfitLANCZOS thumbnailthumbnail_sizecopy_put_thumbnailrsaveseekrTr)rNrrVrimgZ img_formaterrrZthumb_idwhiorWrYrZrsd      zImageGridFsProxy.putcs*|}|r |jr |j|jtSrf)rrrirrT)rNrrVoutrWrYrZrs zImageGridFsProxy.deletecKsF|j\}}t}|j|||d|d|jj|f|||d|S)Nrr)rrr)rrrrrir)rNrrrrVrrrrYrYrZrs   zImageGridFsProxy._put_thumbnailcCs|}|r|j|jfSdS)z1 return a width, height of image N)rrrrNrrYrYrZrszImageGridFsProxy.sizecCs|}|r|jSdS)zH return format of image ex: PNG, JPEG, GIF, etc N)rrrrYrYrZrszImageGridFsProxy.formatcCs$|}|r |jr |j|jSdS)z] return a gridfs.grid_file.GridOut representing a thumbnail of Image N)rrrirrYrYrZrs zImageGridFsProxy.thumbnailcOs tddSNzPlease use "put" method instead RuntimeErrorrNrrVrYrYrZrszImageGridFsProxy.writecOs tddSrrrrYrYrZrszImageGridFsProxy.writelines)rurvrwrxrrrrrrrrrryrYrYrWrZr@}s @     r@c@s eZdZdS)rANrhrYrYrYrZrAsrAcs&eZdZdZeZdfdd ZZS)rBa  A Image File storage field. :param size: max size to store images, provided as (width, height, force) if larger, it will be automatically resized (ex: size=(800, 600, True)) :param thumbnail_size: size to generate a thumbnail, provided as (width, height, force) Nimagesc  sxts tdd}||d}|D]:\}}d} t|ttfrPttj||dd} t ||| q"t j fd|i|dS)NzPIL library was not found)rrr)rr) fillvaluerl) r!rAr r[rrr itertools zip_longestsetattrrTrU) rNrrrlrVZ params_size extra_argsZatt_nameZattr`rWrYrZrUs zImageField.__init__)NNr)rurvrwrxr@rrUryrYrYrWrZrBs rBcsveZdZdZdZdZeZdfdd ZddZ d d Z d d Z d dZ fddZ fddZddZddZZS)rGaProvides a sequential counter see: https://www.mongodb.com/docs/manual/reference/method/ObjectId/#ObjectIDs-SequenceNumbers .. note:: Although traditional databases often use increasing sequence numbers for primary keys. In MongoDB, the preferred approach is to use Object IDs instead. The concept is that in a very large cluster of machines, it is easier to create an object ID than have global, uniformly increasing sequence numbers. :param collection_name: Name of the counter collection (default 'mongoengine.counters') :param sequence_name: Name of the sequence in the collection (default 'ClassName.counter') :param value_decorator: Any callable to use as a counter (default int) Use any callable as `value_decorator` to transform calculated counter into any value suitable for your needs, e.g. string or hexadecimal representation of the default integer counter value. .. note:: In case the counter is defined in the abstract document, it will be common to all inherited documents and the default sequence name will be the class name of the abstract document. Tzmongoengine.countersNcsB|p|j|_|pt|_||_t|r(|n|j|_tj ||dSrf) COLLECTION_NAMErlrrk sequence_namerVALUE_DECORATORvalue_decoratorrTrU)rNrlrkrrrrVrWrYrZrU5s  zSequenceField.__init__cCsX|}|d|j}t|jd|j}|jd|idddiitjdd}||dS) z4 Generate and Increment the counter raliasrWz$incnextrTfilterrSZreturn_documentZupsert get_sequence_namerrrkrlZfind_one_and_updater ZAFTERr)rNr sequence_idrFcounterrYrYrZgenerateFs zSequenceField.generatecCsX|}|d|j}t|jd|j}|jd|idd|iitjdd}||dS)z,Helper method to set the next sequence valuerrrWz$setrTrr)rNr`rrrFrrYrYrZset_next_valueVs zSequenceField.set_next_valuecCsX|}|d|j}t|jd|j}|d|i}|rN||ddS|dS)zHelper method to get the next value for previewing. .. warning:: There is no guarantee this will be the next value as it is only fixed on set. rrrWrr)rrrrkrlZfind_oner)rNrrrFrrYrYrZget_next_valuecszSequenceField.get_next_valuecCsT|jr |jS|j}t|tr0|jds0|Sddd|jD d SdS)Nr?rcss"|]}|rd|n|VqdS)z_%sN)isupper)rcrYrYrZr{sz2SequenceField.get_sequence_name.._) rrrrrBrrCrrrr)rNrrYrYrZrsszSequenceField.get_sequence_namecs@t||}|dkr<|jr<|}||j|j<||j|Srf)rTr _initialisedrrrrrNrrr`rWrYrZrs   zSequenceField.__get__cs$|dkr|jr|}t||Srf)rrrTrrrWrYrZrszSequenceField.__set__cCs ||S)a This method is overridden in order to convert the query value into to required type. We need to do this in order to be able to successfully compare query values passed as string, the base implementation returns the value as is. )rrrYrYrZrrsz!SequenceField.prepare_query_valuecCs|dkr|}|Srf)rr_rYrYrZraszSequenceField.to_python)NNNN)rurvrwrxZ _auto_genrrrrUrrrrrrrrraryrYrYrWrZrGs"  rGcsFeZdZdZdZdfdd ZddZdd Zd d Zd d Z Z S)rHz A UUID field.NTc s||_tjf|dS)ze Store UUID data in the database :param binary: if False store as a string. N)_binaryrTrU)rNbinaryrVrWrYrZrUszUUIDField.__init__c CsL|jsH|}zt|tst|}t|WStttfk rF|YSX|Srf)rr[r\uuidUUIDrrrrrrYrYrZras   zUUIDField.to_pythoncCs&|jst|St|tr"t|S|Srf)rr\r[rrr_rYrYrZrs   zUUIDField.to_mongocCs|dkr dS||SrfrbrrYrYrZrrszUUIDField.prepare_query_valuec Csht|tjsdt|tst|}zt|Wn6tttfk rb}z|d|W5d}~XYnXdS)NzCould not convert to UUID: %s)r[rrr\rrrrrbrrYrYrZres  zUUIDField.validate)T) rurvrwrxrrUrarrrreryrYrYrWrZrHs  rHc@seZdZdZejZddZdS)rCaQA list storing a longitude and latitude coordinate. .. note:: this represents a generic point in a 2D plane and a legacy way of representing a geo point. It admits 2d indexes but not "2dsphere" indexes in MongoDB > 2.4 which are more natural for modeling geospatial points. See :ref:`geospatial-indexes` cCsrt|ttfs|dt|dks8|dt|n6t|dttfr\t|dttfsn|dt|dS)z,Make sure that a geo-value is of type (x, y)z7GeoPointField can only accept tuples or lists of (x, y)rz*Value (%s) must be a two-dimensional pointrrz.Both values (%s) in point must be float or intN)r[rrrbrcreprrrr_rYrYrZres  zGeoPointField.validateN)rurvrwrxpymongoZGEO2DZ _geo_indexrerYrYrYrZrCsrCc@seZdZdZdZdS)rDa/A GeoJSON field storing a longitude and latitude coordinate. The data is represented as: .. code-block:: js {'type' : 'Point' , 'coordinates' : [x, y]} You can either pass a dict with the full information or a list to set the value. Requires mongodb >= 2.4 ZPointNrurvrwrx_typerYrYrYrZrDsrDc@seZdZdZdZdS)rEaMA GeoJSON field storing a line of longitude and latitude coordinates. The data is represented as: .. code-block:: js {'type' : 'LineString' , 'coordinates' : [[x1, y1], [x2, y2] ... [xn, yn]]} You can either pass a dict with the full information or a list of points. Requires mongodb >= 2.4 Z LineStringNrrYrYrYrZrEsrEc@seZdZdZdZdS)rFaA GeoJSON field storing a polygon of longitude and latitude coordinates. The data is represented as: .. code-block:: js {'type' : 'Polygon' , 'coordinates' : [[[x1, y1], [x1, y1] ... [xn, yn]], [[x1, y1], [x1, y1] ... [xn, yn]]} You can either pass a dict with the full information or a list of LineStrings. The first LineString being the outside and the rest being holes. Requires mongodb >= 2.4 ZPolygonNrrYrYrYrZrF srFc@seZdZdZdZdS)rJa/A GeoJSON field storing a list of Points. The data is represented as: .. code-block:: js {'type' : 'MultiPoint' , 'coordinates' : [[x1, y1], [x2, y2]]} You can either pass a dict with the full information or a list to set the value. Requires mongodb >= 2.6 Z MultiPointNrrYrYrYrZrJ srJc@seZdZdZdZdS)rKazA GeoJSON field storing a list of LineStrings. The data is represented as: .. code-block:: js {'type' : 'MultiLineString' , 'coordinates' : [[[x1, y1], [x1, y1] ... [xn, yn]], [[x1, y1], [x1, y1] ... [xn, yn]]]} You can either pass a dict with the full information or a list of points. Requires mongodb >= 2.6 ZMultiLineStringNrrYrYrYrZrK1 srKc@seZdZdZdZdS)rLaA GeoJSON field storing list of Polygons. The data is represented as: .. code-block:: js {'type' : 'MultiPolygon' , 'coordinates' : [[ [[x1, y1], [x1, y1] ... [xn, yn]], [[x1, y1], [x1, y1] ... [xn, yn]] ], [ [[x1, y1], [x1, y1] ... [xn, yn]], [[x1, y1], [x1, y1] ... [xn, yn]] ] } You can either pass a dict with the full information or a list of Polygons. Requires mongodb >= 2.6 Z MultiPolygonNrrYrYrYrZrLD srLcsteZdZdZddeffdd ZeddZddZfd d Z d d Z d dZ ddZ fddZ ddZZS)r9aZA really lazy reference to a document. Unlike the :class:`~mongoengine.fields.ReferenceField` it will **not** be automatically (lazily) dereferenced on access. Instead, access will return a :class:`~mongoengine.base.LazyReference` class instance, allowing access to `pk` or manual dereference by using ``fetch()`` method. Fc sHt|tst|ts|d||_||_||_||_t j f|dS)aVInitialises the Reference Field. :param dbref: Store the reference as :class:`~pymongo.dbref.DBRef` or as the :class:`~pymongo.objectid.ObjectId`.id . :param reverse_delete_rule: Determines what to do when the referring object is deleted :param passthrough: When trying to access unknown fields, the :class:`~mongoengine.base.datastructure.LazyReference` instance will automatically call `fetch()` and try to retrieve the field on the fetched document. Note this only work getting field (not setting or deleting). zOArgument to LazyReferenceField constructor must be a document class or a stringN) r[r\rrrbr4 passthroughrr5rTrU)rNrrr4r5rVrWrYrZrUg s zLazyReferenceField.__init__cCs2t|jtr,|jtkr |j|_n t|j|_|jSrfr6rrYrYrZr s     z LazyReferenceField.document_typecCst|tr,|j|jkrt|j|j|jd}n\|dk rt||jrVt|j|j|jd}n2t|trvt|j|j|jd}nt|j||jd}|S)Nr)r[rrrrArr@r_rYrYrZr s4    z LazyReferenceField.build_lazyrefcs>|dkr |S||j|j}|r0||j|j<t||S)r;NrrrrrTrrrWrYrZr s  zLazyReferenceField.__get__cCs|t|tr|j}n*t||jr&|j}nt|tr8|j}n|}|jjd}|jj|}||}|j rtt|j |S|SdS)Nr>) r[rrArrr@rBrrr4rC)rNr`rArEr>rYrYrZr s      zLazyReferenceField.to_mongocCs<t|tttfs8|j}t||jj|}||}|SrG) r[rrrrrCr@rarrHrYrYrZra s   zLazyReferenceField.to_pythonc Cst|tr2|j|jkr*|d|j|j}nt||jrF|j}nt|trz|j}|j|krr|d||j}n\|jj d}t |j|}|}z| |Wn0t k r|d |jjt|jYnX|dkr|ddS)Nz%Reference must be on a `%s` document.z)DBRef on bad collection (must be on `%s`)r>zcvalue should be `{0}` document, LazyReference or DBRef on `{0}` or `{0}`'s primary key (i.e. `{1}`)r=)r[rrFrrCrbrArr@rBrqrerrrur_)rNr`rArFrEr>rYrYrZre s6        zLazyReferenceField.validatecs$|dkr dSt||||SrfrrrWrYrZrr sz&LazyReferenceField.prepare_query_valuecCs|jj|SrfrIrgrYrYrZri sz LazyReferenceField.lookup_member)rurvrwrxrrUrrrrrrarerrriryrYrYrWrZr9^ s "  " r9csXeZdZdZfddZfddZddZfdd Zfd d Zfd d Z Z S)r:aA reference to *any* :class:`~mongoengine.document.Document` subclass. Unlike the :class:`~mongoengine.fields.GenericReferenceField` it will **not** be automatically (lazily) dereferenced on access. Instead, access will return a :class:`~mongoengine.base.LazyReference` class instance, allowing access to `pk` or manual dereference by using ``fetch()`` method. .. note :: * Any documents used as a generic reference must be registered in the document registry. Importing the model will automatically register it. * You can use the choices param to limit the acceptable Document types cs |dd|_tj||dS)NrF)r,rrTrUrrWrYrZrU sz"GenericLazyReferenceField.__init__cs"t|tr|jj}t|dSrf)r[rrrrTr`r_rWrYrZr` s z+GenericLazyReferenceField._validate_choicescCst|tr,|j|jkrt|j|j|jd}nV|dk rt|ttfrbtt|d|dj|jd}n t|t rtt ||j|jd}|S)Nrrr ) r[rrrrArrrr@rr_r_rYrYrZr s*    z'GenericLazyReferenceField.build_lazyrefcs>|dkr |S||j|j}|r0||j|j<t||SrfrrrWrYrZr& s  z!GenericLazyReferenceField.__get__cs*t|tr|jdkr|dt|S)Nr=)r[rrArbrTrer_rWrYrZre0 s z"GenericLazyReferenceField.validatecsL|dkr dSt|trr?r@rArBrGrHrCrDrErFrJrKrLr9r:rMrYrYrYrZs       $         /G$m&*YP^T5=@  6 2&t O#Rx/R