U ~fhJ@sdZddlmZddlmZmZmZmZddlm Z ddl m Z GdddZ Gdd d Z Gd d d ZGd d d ZGdddZdddddZdS)zTools for working with `collations`_. .. _collations: https://www.mongodb.com/docs/manual/reference/collation/ .. seealso:: This module is compatible with both the synchronous and asynchronous PyMongo APIs. ) annotations)AnyMappingOptionalUnion)common)validate_booleanc@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-36gvocj8/pymongo/collation.pyr sr c@seZdZdZdZdZdS)CollationAlternateze An enum that defines values for `alternate` on a :class:`~pymongo.collation.Collation`. z non-ignorableZshiftedN)rrrrZ NON_IGNORABLEZSHIFTEDrrrrr3src@seZdZdZdZdZdS)CollationMaxVariablezh An enum that defines values for `max_variable` on a :class:`~pymongo.collation.Collation`. punctspaceN)rrrrZPUNCTSPACErrrrrFsrc@seZdZdZdZdZdZdS)CollationCaseFirstzf An enum that defines values for `case_first` on a :class:`~pymongo.collation.Collation`. upperloweroffN)rrrrZUPPERZLOWERZOFFrrrrrSs rc @sxeZdZdZdZdddddddddddd d d d Zed dddZddddZdddddZ dddddZ dS) Collationa' Collation :param 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. :param 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``. :param 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) :param strength: 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. :param numericOrdering: If ``True``, order numbers numerically instead of in collation order (defaults to ``False``). :param alternate: 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` :param maxVariable: 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` :param normalization: If ``True``, normalizes text into Unicode NFD. Defaults to ``False``. :param backwards: 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``. :param kwargs: Keyword arguments supplying any additional options to be sent with this Collation object. .. versionadded: 3.4 )Z __documentNstrzOptional[bool]z Optional[str]z Optional[int]rNone) locale caseLevel caseFirststrengthnumericOrdering alternate maxVariable normalization backwardskwargsreturnc Kstd|}d|i|_|dk r.td||jd<|dk rHtd||jd<|dk rbtd||jd<|dk rztd||jd<|dk rtd||jd<|dk rtd||jd<|dk rtd||jd<| dk rtd | |jd <|j| dS) Nr!r"r#r$r%r&r'r(r))rZvalidate_string_Collation__documentrZvalidate_integerupdate) selfr!r"r#r$r%r&r'r(r)r*rrr__init__s,   zCollation.__init__zdict[str, Any])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).0keyr2rr sz%Collation.__repr__..)r2formatjoinr1rr6r__repr__szCollation.__repr__bool)otherr+cCst|tr|j|jkStSN) isinstancerr2NotImplementedr.r<rrr__eq__s  zCollation.__eq__cCs ||k Sr=rr@rrr__ne__szCollation.__ne__)NNNNNNNN) rrrr __slots__r/propertyr2r:rArBrrrrrcs 9$# rz-Optional[Union[Mapping[str, Any], Collation]]zOptional[dict[str, Any]])valuer+cCs6|dkr dSt|tr|jSt|tr*|StddS)NzFcollation must be a dict, an instance of collation.Collation, or None.)r>rr2dict TypeError)rErrrvalidate_collation_or_nones  rHN)r __future__rtypingrrrrZpymongorZpymongo.write_concernrr rrrrrHrrrrs    v