o hJ@sdZddlmZddlmZmZmZmZddlm Z ddl m Z GdddZ Gdd d Z Gd d d ZGd d d ZGdddZdddZdS)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,eZdZdZdZ dZ dZ dZ dZdS)CollationStrengthzd An enum that defines values for `strength` on a :class:`~pymongo.collation.Collation`. N) __name__ __module__ __qualname____doc__ZPRIMARYZ SECONDARYZTERTIARYZ QUATERNARYZ IDENTICALrrD/var/www/html/venv/lib/python3.10/site-packages/pymongo/collation.pyr sr c@eZdZdZdZ dZdS)CollationAlternateze An enum that defines values for `alternate` on a :class:`~pymongo.collation.Collation`. z non-ignorableZshiftedN)rrrrZ NON_IGNORABLEZSHIFTEDrrrrr3 rc@r)CollationMaxVariablezh An enum that defines values for `max_variable` on a :class:`~pymongo.collation.Collation`. punctspaceN)rrrrZPUNCTSPACErrrrrFrrc@s eZdZdZdZ dZ dZdS)CollationCaseFirstzf An enum that defines values for `case_first` on a :class:`~pymongo.collation.Collation`. upperloweroffN)rrrrZUPPERZLOWERZOFFrrrrrSsrc@s\eZdZdZdZ        d"d#ddZed$ddZd%ddZd&ddZ d&d d!Z 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 __documentNlocalestr caseLevelOptional[bool] caseFirst Optional[str]strength Optional[int]numericOrdering alternate maxVariable normalization backwardskwargsrreturnNonec Kstd|}d|i|_|durtd||jd<|dur$td||jd<|dur1td||jd<|dur=td||jd<|durJtd||jd<|durWtd||jd<|durctd||jd<| durotd | |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__dict[str, Any]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`. )r1copyr3rrrdocuments zCollation.documentcs$|jddfddDS)Nz Collation({})z, c3s"|] }|d|VqdS)=Nr).0keyr8rr s z%Collation.__repr__..)r8formatjoinr7rr<r__repr__szCollation.__repr__otherboolcCst|tr |j|jkStSN) isinstancer r8NotImplementedr3rArrr__eq__s  zCollation.__eq__cCs ||k SrCrrFrrr__ne__s zCollation.__ne__)NNNNNNNN)r!r"r#r$r%r&r'r(r)r$r*r&r+r&r,r$r-r$r.rr/r0)r/r5)r/r")rArr/rB) rrrr __slots__r4propertyr8r@rGrHrrrrr cs"9 #  r value-Optional[Union[Mapping[str, Any], Collation]]r/Optional[dict[str, Any]]cCs2|durdSt|tr|jSt|tr|Std)NzEcollation must be a dict, an instance of collation.Collation, or None)rDr r8dict TypeError)rKrrrvalidate_collation_or_nones  rPN)rKrLr/rM)r __future__rtypingrrrrZpymongorZpymongo.write_concernrr rrrr rPrrrrs    v