U >i-0@sdZddlmZddlZddlmZddlmZmZdZ dZ dZ d Z d Z e d Zd Ze eZed ZedZdddgZdddeDZeeZddddZddddZddddZdd d!d"ZeZdd#d$d%d&ZGd'd(d(eZdS))zBUtilities for managing / converting field paths to / from strings.) annotationsN)abc)Iterablecastz!{!r} is not contained in the dataz2{!r} is not contained in the data for the key {!r}zGThe data at {!r} is not a dictionary, so it cannot contain the key {!r}.\`z^[_a-zA-Z][_a-zA-Z0-9]*$z ^[_a-zA-Z][_a-zA-Z0-9]*[~*/\[\]])ZSIMPLEz[_a-zA-Z][_a-zA-Z0-9]*)ZQUOTEDz`(?:\\`|[^`])*?`)DOTz\.|ccs|]}dj|VqdS)z (?P<{}>{})N)format).0pairrH/tmp/pip-unpacked-wheel-599y42ri/google/cloud/firestore_v1/field_path.py (srstr)pathccsrd}tj}||}|dk rJtt|j}||}|V|}|||}q|t|krntd |||ddS)zLex a field path into tokens (including dots). Args: path (str): field path to be lexed. Returns: List(str): tokens rNz!Path {} not consumed, residue: {}) TOKENS_REGEXmatchrr lastgroupgroupendlen ValueErrorr )rpos get_tokenrtype_valuerrr_tokenize_field_path,s    rz str | NonecCs~|sgSg}d}t|D]J}|r>|dkr8td|qbd}q|dkrTtd|||d}q|rl|sztd||S)aSplit a field path into valid elements (without dots). Args: path (str): field path to be lexed. Returns: List(str): tokens Raises: ValueError: if the path does not match the elements-interspersed- with-dots pattern. FrzInvalid path: {}T)rrr append)relementsZwant_dotelementrrrsplit_field_pathAs   r#api_reprcCs\g}t|D]J}|ddkrL|ddkrL|dd}|tt}|tt}||q |S)a;Parse a **field path** from into a list of nested field names. See :func:`field_path` for more on **field paths**. Args: api_repr (str): The unique Firestore api representation which consists of either simple or UTF-8 field names. It cannot exceed 1500 bytes, and cannot be empty. Simple field names match ``'^[_a-zA-Z][_a-zA-Z0-9]*$'``. All other field names are escaped by surrounding them with backticks. Returns: List[str, ...]: The list of field names in the field path. rr )r#replace_ESCAPED_BACKTICK _BACKTICK_ESCAPED_BACKSLASH _BACKSLASHr )r% field_names field_namerrrparse_field_pathds     r/z Iterable[str])r-cCsfg}|D]R}t|}|r4|d|kr4||q|tttt}|t|tqt |S)aCCreate a **field path** from a list of nested field names. A **field path** is a ``.``-delimited concatenation of the field names. It is used to represent a nested field. For example, in the data .. code-block:: python data = { 'aa': { 'bb': { 'cc': 10, }, }, } the field path ``'aa.bb.cc'`` represents that data stored in ``data['aa']['bb']['cc']``. Args: field_names: The list of field names. Returns: str: The ``.``-delimited field path. r) _SIMPLE_FIELD_NAMErrr r(r,r+r*r)_FIELD_PATH_DELIMITERjoin)r-resultr.rZreplacedrrrrender_field_paths   r4dict) field_pathdatacCst|}|}t|D]\}}t|tjr|||kr:||}q|dkrVt|}t|qt|d|}t ||}t|qt|d|}t ||}t|q|S)aGet a (potentially nested) value from a dictionary. If the data is nested, for example: .. code-block:: python >>> data { 'top1': { 'middle2': { 'bottom3': 20, 'bottom4': 22, }, 'middle5': True, }, 'top6': b' foo', } a **field path** can be used to access the nested data. For example: .. code-block:: python >>> get_nested_value('top1', data) { 'middle2': { 'bottom3': 20, 'bottom4': 22, }, 'middle5': True, } >>> get_nested_value('top1.middle2', data) { 'bottom3': 20, 'bottom4': 22, } >>> get_nested_value('top1.middle2.bottom3', data) 20 See :meth:`~google.cloud.firestore_v1.client.Client.field_path` for more information on **field paths**. Args: field_path (str): A field path (``.``-delimited list of field names). data (Dict[str, Any]): The (possibly nested) data. Returns: Any: (A copy of) the value stored for the ``field_path``. Raises: KeyError: If the ``field_path`` does not match nested data. rN) r/ enumerate isinstancerMapping_FIELD_PATH_MISSING_TOPr KeyErrorr4_FIELD_PATH_MISSING_KEY_FIELD_PATH_WRONG_TYPE)r6r7r-Z nested_dataindexr.msgpartialrrrget_nested_values 6        rBc@seZdZdZddZeddddZeddd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZeddZdS) FieldPathaField Path object for client use. A field path is a sequence of element keys, separated by periods. Each element key can be either a simple identifier, or a full unicode string. In the string representation of a field path, non-identifier elements must be quoted using backticks, with internal backticks and backslashes escaped with a backslash. Args: parts: (one or more strings) Indicating path of the key to be used. cGs2|D]}t|tr|sd}t|qt||_dS)Nz3One or more components is not a string or is empty.)r9rrtupleparts)selfrEparterrorrrr__init__ s  zFieldPath.__init__rr$cCs |}|std|t|S)aFactory: create a FieldPath from the string formatted per the API. Args: api_repr (str): a string path, with non-identifier elements quoted It cannot exceed 1500 characters, and cannot be empty. Returns: (:class:`FieldPath`) An instance parsed from ``api_repr``. Raises: ValueError if the parsing fails z.Field path API representation cannot be empty.)striprr/)clsr%rrr from_api_reprs zFieldPath.from_api_repr) path_stringcCsfz ||WStk r`|d}|D](}|s:tdt|r*td|q*t|YSXdS)aFactory: create a FieldPath from a unicode string representation. This method splits on the character `.` and disallows the characters `~*/[]`. To create a FieldPath whose components have those characters, call the constructor. Args: path_string (str): A unicode string which cannot contain `~*/[]` characters, cannot exceed 1500 bytes, and cannot be empty. Returns: (:class:`FieldPath`) An instance parsed from ``path_string``. rz Empty elementz.Invalid char in element with leading alpha: {}N)rLrsplit_LEADING_ALPHA_INVALIDrr rC)rKrMr!r"rrr from_string"s   zFieldPath.from_stringcCs6d}|jD]}|d|d7}q |dd}d|S)N'z',r&z FieldPath({}))rEr )rFpathsrGrrr__repr__>s   zFieldPath.__repr__cCs t|SN)hash to_api_reprrFrrr__hash__EszFieldPath.__hash__cCst|tr|j|jkStSrUr9rCrENotImplementedrFotherrrr__eq__Hs  zFieldPath.__eq__cCst|tr|j|jkStSrUrZr\rrr__lt__Ms  zFieldPath.__lt__cCsJt|tr|j|j}t|St|trB|jt|j}t|StSdS)zAdds `other` field path to end of this field path. Args: other (~google.cloud.firestore_v1._helpers.FieldPath, str): The field path to add to the end of this `FieldPath`. N)r9rCrErrPr[)rFr]rErrr__add__Rs   zFieldPath.__add__cCs t|jS)zRender a quoted string representation of the FieldPath Returns: (str) Quoted string representation of the path stored within this FieldPath. )r4rErXrrrrWbszFieldPath.to_api_reprcCs(|jdt|j|jdt|jkS)zCheck whether ``other`` is an ancestor. Returns: (bool) True IFF ``other`` is an ancestor or equal to ``self``, else False. N)rErr\rrr eq_or_parentkszFieldPath.eq_or_parentcs"tdtj}fdd|DS)zVReturn field paths for all parents. Returns: Set[:class:`FieldPath`] r'csh|]}tjd|qSrU)rCrE)r r?rXrr zsz$FieldPath.lineage..)rangerrE)rFZindexesrrXrlineagetszFieldPath.lineagecCsdS)zA special FieldPath value to refer to the ID of a document. It can be used in queries to sort or filter by the document ID. Returns: A special sentinel value to refer to the ID of a document. __name__rrrrr document_id|szFieldPath.document_idN)re __module__ __qualname____doc__rI classmethodrLrPrTrYr^r_r`rWrard staticmethodrfrrrrrCs   rC) ri __future__rre collectionsrtypingrrr;r=r>r1r,r+r*r)compiler0rOZPATH_ELEMENT_TOKENSr2ZTOKENS_PATTERNrrr#r/r4Zget_field_pathrBobjectrCrrrrs8     #)M