U d@sdZddlmZmZmZmZmZddlmZGdddZ GdddZ Gdd d Z Gd d d Z Gd d d Z eeeeefe feeeefdddZdS)zpTools for working with `collations`_. .. _collations: https://www.mongodb.com/docs/manual/reference/collation/ )AnyDictMappingOptionalUnion)commonc@s$eZdZdZdZdZdZdZdZdS)CollationStrengthzd An enum that defines values for `strength` on a :class:`~pymongo.collation.Collation`. N) __name__ __module__ __qualname____doc__ZPRIMARYZ SECONDARYZTERTIARYZ QUATERNARYZ IDENTICALrr5/tmp/pip-unpacked-wheel-oblwsawz/pymongo/collation.pyrsrc@seZdZdZdZdZdS)CollationAlternateze An enum that defines values for `alternate` on a :class:`~pymongo.collation.Collation`. z non-ignorableZshiftedN)rrrrZ NON_IGNORABLEZSHIFTEDrrrrr.src@seZdZdZdZdZdS)CollationMaxVariablezh An enum that defines values for `max_variable` on a :class:`~pymongo.collation.Collation`. punctspaceN)rrrrZPUNCTSPACErrrrrAsrc@seZdZdZdZdZdZdS)CollationCaseFirstzf An enum that defines values for `case_first` on a :class:`~pymongo.collation.Collation`. upperloweroffN)rrrrZUPPERZLOWERZOFFrrrrrNs rc @seZdZdZdZdeeeeeeeeeeeeeeeeee dd ddZ e e ee fddd Z edd d Ze ed d dZe ed ddZdS) Collationa{ Collation :Parameters: - `locale`: (string) The locale of the collation. This should be a string that identifies an `ICU locale ID` exactly. For example, ``en_US`` is valid, but ``en_us`` and ``en-US`` are not. Consult the MongoDB documentation for a list of supported locales. - `caseLevel`: (optional) If ``True``, turn on case sensitivity if `strength` is 1 or 2 (case sensitivity is implied if `strength` is greater than 2). Defaults to ``False``. - `caseFirst`: (optional) Specify that either uppercase or lowercase characters take precedence. Must be one of the following values: * :data:`~CollationCaseFirst.UPPER` * :data:`~CollationCaseFirst.LOWER` * :data:`~CollationCaseFirst.OFF` (the default) - `strength`: (optional) Specify the comparison strength. This is also known as the ICU comparison level. This must be one of the following values: * :data:`~CollationStrength.PRIMARY` * :data:`~CollationStrength.SECONDARY` * :data:`~CollationStrength.TERTIARY` (the default) * :data:`~CollationStrength.QUATERNARY` * :data:`~CollationStrength.IDENTICAL` Each successive level builds upon the previous. For example, a `strength` of :data:`~CollationStrength.SECONDARY` differentiates characters based both on the unadorned base character and its accents. - `numericOrdering`: (optional) If ``True``, order numbers numerically instead of in collation order (defaults to ``False``). - `alternate`: (optional) Specify whether spaces and punctuation are considered base characters. This must be one of the following values: * :data:`~CollationAlternate.NON_IGNORABLE` (the default) * :data:`~CollationAlternate.SHIFTED` - `maxVariable`: (optional) When `alternate` is :data:`~CollationAlternate.SHIFTED`, this option specifies what characters may be ignored. This must be one of the following values: * :data:`~CollationMaxVariable.PUNCT` (the default) * :data:`~CollationMaxVariable.SPACE` - `normalization`: (optional) If ``True``, normalizes text into Unicode NFD. Defaults to ``False``. - `backwards`: (optional) If ``True``, accents on characters are considered from the back of the word to the front, as it is done in some French dictionary ordering traditions. Defaults to ``False``. - `kwargs`: (optional) Keyword arguments supplying any additional options to be sent with this Collation object. .. versionadded: 3.4 )Z __documentN) locale caseLevel caseFirststrengthnumericOrdering alternate maxVariable normalization backwardskwargsreturnc Kstd|}d|i|_|dk r0td||jd<|dk rJtd||jd<|dk rdtd||jd<|dk r~td||jd<|dk rtd||jd<|dk rtd||jd<|dk rtd||jd<| dk rtd | |jd <|j| dS) Nrrr r!r"r#r$r%r&)rZvalidate_string_Collation__documentZvalidate_booleanZvalidate_integerupdate) selfrrr r!r"r#r$r%r&r'rrr__init__s2    zCollation.__init__)r(cCs |jS)zThe document representation of this collation. .. note:: :class:`Collation` is immutable. Mutating the value of :attr:`document` does not mutate this :class:`Collation`. )r)copyr+rrrdocumentszCollation.documentcs$|jddfddDS)Nz Collation({})z, c3s |]}|d|VqdS)=Nr).0keyr/rr sz%Collation.__repr__..)r/formatjoinr.rr3r__repr__szCollation.__repr__)otherr(cCst|tr|j|jkStSN) isinstancerr/NotImplementedr+r8rrr__eq__s  zCollation.__eq__cCs ||k Sr9rr<rrr__ne__szCollation.__ne__)NNNNNNNN)rrrr __slots__strrboolintrr,propertyrr/r7r=r>rrrrr^s8: % r)valuer(cCs6|dkr dSt|tr|jSt|tr*|StddS)NzFcollation must be a dict, an instance of collation.Collation, or None.)r:rr/dict TypeError)rDrrrvalidate_collation_or_nones  rGN)rtypingrrrrrZpymongorrrrrrr@rGrrrrs  z