B `p|@sddlmZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z mZmZmZddlmZdd lmZdd lmZmZmZd Zed Zd dZddZeZddZddZeZ ddZ!ddZ"e"Z#ddZ$e$Z%ddZ&ddZ'edd d!Z(edd"d#Z)d$d%Z*d&d'Z+iZ,efd(d)Z-eeGd*d+d+Z.e.Z/eeGd,d-d-Z0edd.d/Z1Gd0d1d1Z2d2S)3) lru_cache)unquote_to_bytes) implementer) IInterface) url_quote)URLDecodeError) VH_ROOT_KEYIRequestFactory IResourceURL ITraverser)lineage)get_current_registry)ascii_is_nonstr_itertext_z~!$&'()*+,;=:@/cCs&x t|D]}|jdkr |}Pq W|S)zFind the root node in the resource tree to which ``resource`` belongs. Note that ``resource`` should be :term:`location`-aware. Note that the root resource is available in the request object by accessing the ``request.root`` attribute. N)r __parent__)resourcelocationrY/home/kop/projects/devel/pgwui/test_venv/lib/python3.7/site-packages/pyramid/traversal.py find_roots  rcCsDt|trt|}t||}|d}|d}|r@td||f|S)aU Given a resource object and a string or tuple representing a path (such as the return value of :func:`pyramid.traversal.resource_path` or :func:`pyramid.traversal.resource_path_tuple`), return a resource in this application's resource tree at the specified path. The resource passed in *must* be :term:`location`-aware. If the path cannot be resolved (if the respective node in the resource tree does not exist), a :exc:`KeyError` will be raised. This function is the logical inverse of :func:`pyramid.traversal.resource_path` and :func:`pyramid.traversal.resource_path_tuple`; it can resolve any path string or tuple generated by either of those functions. Rules for passing a *string* as the ``path`` argument: if the first character in the path string is the ``/`` character, the path is considered absolute and the resource tree traversal will start at the root resource. If the first character of the path string is *not* the ``/`` character, the path is considered relative and resource tree traversal will begin at the resource object supplied to the function as the ``resource`` argument. If an empty string is passed as ``path``, the ``resource`` passed in will be returned. Resource path strings must be escaped in the following manner: each path segment must be UTF-8 encoded and escaped via Python's :mod:`urllib.quote`. For example, ``/path/to%20the/La%20Pe%C3%B1a`` (absolute) or ``to%20the/La%20Pe%C3%B1a`` (relative). The :func:`pyramid.traversal.resource_path` function generates strings which follow these rules (albeit only absolute ones). The text may not have any non-ASCII characters in it. Rules for passing a *tuple* as the ``path`` argument: if the first element in the path tuple is the empty string (for example ``('', 'a', 'b', 'c')``, the path is considered absolute and the resource tree traversal will start at the resource tree root object. If the first element in the path tuple is not the empty string (for example ``('a', 'b', 'c')``), the path is considered relative and resource tree traversal will begin at the resource object supplied to the function as the ``resource`` argument. If an empty sequence is passed as ``path``, the ``resource`` passed in itself will be returned. No URL-quoting of individual path segments within the tuple is required (each segment may be any string representing a resource name). Resource path tuples generated by :func:`pyramid.traversal.resource_path_tuple` can always be resolved by ``find_resource``. view_namecontextz%r has no subelement %s) isinstancestrrtraverseKeyError)rpathDrrrrr find_resource#s,  r cs@trj}n fdd}xt|D]}||r(|Sq(WdS)a Return the first resource found in the :term:`lineage` of ``resource`` which, a) if ``class_or_interface`` is a Python class object, is an instance of the class or any subclass of that class or b) if ``class_or_interface`` is a :term:`interface`, provides the specified interface. Return ``None`` if no resource providing ``interface_or_class`` can be found in the lineage. The ``resource`` passed in *must* be :term:`location`-aware. cs t|S)N)r)arg)class_or_interfacerriz find_interface..N)rZ providedByr )rr"testrr)r"rfind_interface\s  r&cGstt|f|S)aReturn a string object representing the absolute physical path of the resource object based on its position in the resource tree, e.g ``/foo/bar``. Any positional arguments passed in as ``elements`` will be appended as path segments to the end of the resource path. For instance, if the resource's path is ``/foo/bar`` and ``elements`` equals ``('a', 'b')``, the returned string will be ``/foo/bar/a/b``. The first character in the string will always be the ``/`` character (a leading ``/`` character in a path string represents that the path is absolute). Resource path strings returned will be escaped in the following manner: each path segment will be encoded as UTF-8 and escaped via Python's :mod:`urllib.quote`. For example, ``/path/to%20the/La%20Pe%C3%B1a``. This function is a logical inverse of :mod:`pyramid.traversal.find_resource`: it can be used to generate path references that can later be resolved via that function. The ``resource`` passed in *must* be :term:`location`-aware. .. note:: Each segment in the path string returned will use the ``__name__`` attribute of the resource it represents within the resource tree. Each of these segments *should* be a string (as per the contract of :term:`location`-awareness). However, no conversion or safety checking of resource names is performed. For instance, if one of the resources in your tree has a ``__name__`` which (by error) is a dictionary, the :func:`pyramid.traversal.resource_path` function will attempt to append it to a string and it will cause a :exc:`pyramid.exceptions.URLDecodeError`. .. note:: The :term:`root` resource *must* have a ``__name__`` attribute with a value of either ``None`` or the empty string for paths to be generated properly. If the root resource has a non-null ``__name__`` attribute, its name will be prepended to the generated path rather than a single leading '/' character. )_join_path_tupleresource_path_tuple)relementsrrr resource_pathos+r*cCst|r|rtt|}nd}t|}|r>|ddkr>t|}t}|t}|dkrfddlm }|}| |}||_ | |t }|dkrt|}||S)aGiven a resource object as ``resource`` and a string or tuple representing a path as ``path`` (such as the return value of :func:`pyramid.traversal.resource_path` or :func:`pyramid.traversal.resource_path_tuple` or the value of ``request.environ['PATH_INFO']``), return a dictionary with the keys ``context``, ``root``, ``view_name``, ``subpath``, ``traversed``, ``virtual_root``, and ``virtual_root_path``. A definition of each value in the returned dictionary: - ``context``: The :term:`context` (a :term:`resource` object) found via traversal or URL dispatch. If the ``path`` passed in is the empty string, the value of the ``resource`` argument passed to this function is returned. - ``root``: The resource object at which :term:`traversal` begins. If the ``resource`` passed in was found via URL dispatch or if the ``path`` passed in was relative (non-absolute), the value of the ``resource`` argument passed to this function is returned. - ``view_name``: The :term:`view name` found during :term:`traversal` or :term:`URL dispatch`; if the ``resource`` was found via traversal, this is usually a representation of the path segment which directly follows the path to the ``context`` in the ``path``. The ``view_name`` will be a string. The ``view_name`` will be the empty string if there is no element which follows the ``context`` path. An example: if the path passed is ``/foo/bar``, and a resource object is found at ``/foo`` (but not at ``/foo/bar``), the 'view name' will be ``'bar'``. If the ``resource`` was found via URL dispatch, the ``view_name`` will be the empty string unless the ``traverse`` predicate was specified or the ``*traverse`` route pattern was used, at which point normal traversal rules dictate the result. - ``subpath``: For a ``resource`` found via :term:`traversal`, this is a sequence of path segments found in the ``path`` that follow the ``view_name`` (if any). Each of these items is a string. If no path segments follow the ``view_name``, the subpath will be the empty sequence. An example: if the path passed is ``/foo/bar/baz/buz``, and a resource object is found at ``/foo`` (but not ``/foo/bar``), the 'view name' will be ``'bar'`` and the :term:`subpath` will be ``['baz', 'buz']``. For a ``resource`` found via URL dispatch, the subpath will be a sequence of values discerned from ``*subpath`` in the route pattern matched or the empty sequence. - ``traversed``: The sequence of path elements traversed from the root to find the ``context`` object during :term:`traversal`. Each of these items is a string. If no path segments were traversed to find the ``context`` object (e.g. if the ``path`` provided is the empty string), the ``traversed`` value will be the empty sequence. If the ``resource`` is a resource found via :term:`URL dispatch`, traversed will be None. - ``virtual_root``: A resource object representing the 'virtual' root of the resource tree being traversed during :term:`traversal`. See :ref:`vhosting_chapter` for a definition of the virtual root object. If no virtual hosting is in effect, and the ``path`` passed in was absolute, the ``virtual_root`` will be the *physical* root resource object (the object at which :term:`traversal` begins). If the ``resource`` passed in was found via :term:`URL dispatch` or if the ``path`` passed in was relative, the ``virtual_root`` will always equal the ``root`` object (the resource passed in). - ``virtual_root_path`` -- If :term:`traversal` was used to find the ``resource``, this will be the sequence of path elements traversed to find the ``virtual_root`` resource. Each of these items is a string. If no path segments were traversed to find the ``virtual_root`` resource (e.g. if virtual hosting is not in effect), the ``traversed`` value will be the empty list. If URL dispatch was used to find the ``resource``, this will be ``None``. If the path cannot be resolved, a :exc:`KeyError` will be raised. Rules for passing a *string* as the ``path`` argument: if the first character in the path string is the with the ``/`` character, the path will considered absolute and the resource tree traversal will start at the root resource. If the first character of the path string is *not* the ``/`` character, the path is considered relative and resource tree traversal will begin at the resource object supplied to the function as the ``resource`` argument. If an empty string is passed as ``path``, the ``resource`` passed in will be returned. Resource path strings must be escaped in the following manner: each path segment must be encoded as UTF-8 and escaped via Python's :mod:`urllib.quote`. For example, ``/path/to%20the/La%20Pe%C3%B1a`` (absolute) or ``to%20the/La%20Pe%C3%B1a`` (relative). The :func:`pyramid.traversal.resource_path` function generates strings which follow these rules (albeit only absolute ones). Rules for passing a *tuple* as the ``path`` argument: if the first element in the path tuple is the empty string (for example ``('', 'a', 'b', 'c')``, the path is considered absolute and the resource tree traversal will start at the resource tree root object. If the first element in the path tuple is not the empty string (for example ``('a', 'b', 'c')``), the path is considered relative and resource tree traversal will begin at the resource object supplied to the function as the ``resource`` argument. If an empty sequence is passed as ``path``, the ``resource`` passed in itself will be returned. No URL-quoting or UTF-8-encoding of individual path segments within the tuple is required (each segment may be any string representing a resource name). Explanation of the decoding of ``path`` segment values during traversal: Each segment is URL-unquoted, and UTF-8 decoded. Each segment is assumed to be encoded using the UTF-8 encoding (or a subset, such as ASCII); a :exc:`pyramid.exceptions.URLDecodeError` is raised if a segment cannot be decoded. If a segment name is empty or if it is ``.``, it is ignored. If a segment name is ``..``, the previous segment is deleted, and the ``..`` is ignored. As a result of this process, the return values ``view_name``, each element in the ``subpath``, each element in ``traversed``, and each element in the ``virtual_root_path`` will be decoded strings. rrN)Request)rr'tuplerrr Z queryUtilityr Zpyramid.requestr,ZblankregistryZ queryAdapterr ResourceTreeTraverser)rrregZrequest_factoryr,requestZ traverserrrrrs$w     rcGstt|f|S)a Return a tuple representing the absolute physical path of the ``resource`` object based on its position in a resource tree, e.g ``('', 'foo', 'bar')``. Any positional arguments passed in as ``elements`` will be appended as elements in the tuple representing the resource path. For instance, if the resource's path is ``('', 'foo', 'bar')`` and elements equals ``('a', 'b')``, the returned tuple will be ``('', 'foo', 'bar', 'a', 'b')``. The first element of this tuple will always be the empty string (a leading empty string element in a path tuple represents that the path is absolute). This function is a logical inverse of :func:`pyramid.traversal.find_resource`: it can be used to generate path references that can later be resolved by that function. The ``resource`` passed in *must* be :term:`location`-aware. .. note:: Each segment in the path tuple returned will equal the ``__name__`` attribute of the resource it represents within the resource tree. Each of these segments *should* be a string (as per the contract of :term:`location`-awareness). However, no conversion or safety checking of resource names is performed. For instance, if one of the resources in your tree has a ``__name__`` which (by error) is a dictionary, that dictionary will be placed in the path tuple; no warning or error will be given. .. note:: The :term:`root` resource *must* have a ``__name__`` attribute with a value of either ``None`` or the empty string for path tuples to be generated properly. If the root resource has a non-null ``__name__`` attribute, its name will be the first element in the generated path tuple rather than the empty string. )r-_resource_path_list)rr)rrrr(?s&r(cGs(ddt|D}||||S)zIImplementation detail shared by resource_path and resource_path_tuplecSsg|]}|jpdqS)r+)__name__).0locrrr nsz'_resource_path_list..)r reverseextend)rr)rrrrr2ks r2cCsy |j}Wntk r$t}YnX|||ft}|dkrHt||}|j|j}}||kr||r|dt | }t ||Sy|j Stk rt |SXdS)au Provided any :term:`resource` and a :term:`request` object, return the resource object representing the :term:`virtual root` of the current :term:`request`. Using a virtual root in a :term:`traversal` -based :app:`Pyramid` application permits rooting. For example, the resource at the traversal path ``/cms`` will be found at ``http://example.com/`` instead of rooting it at ``http://example.com/cms/``. If the ``resource`` passed in is a context obtained via :term:`traversal`, and if the ``HTTP_X_VHM_ROOT`` key is in the WSGI environment, the value of this key will be treated as a 'virtual root path': the :func:`pyramid.traversal.find_resource` API will be used to find the virtual root resource using this path; if the resource is found, it will be returned. If the ``HTTP_X_VHM_ROOT`` key is not present in the WSGI environment, the physical :term:`root` of the resource tree will be returned instead. Virtual roots are not useful at all in applications that use :term:`URL dispatch`. Contexts obtained via URL dispatch don't really support being virtually rooted (each URL dispatch context is both its own physical and virtual root). However if this API is called with a ``resource`` argument which is a context obtained via URL dispatch, the resource passed in will be returned unconditionally.N) r.AttributeErrorr ZqueryMultiAdapterr ResourceURL virtual_path physical_pathendswithlenr rootr)rr1r0Z url_adaptervpathZrpath vroot_pathrrr virtual_rootws    rBcCs$t|tr|d}t|}t|S)aVariant of :func:`pyramid.traversal.traversal_path_info` suitable for decoding paths that are URL-encoded. If this function is passed a string, it *must* be directly encodeable to ASCII. For example, '/foo' will work but '/' (a string object with characters that cannot be encoded to ASCII) will not. A :exc:`UnicodeEncodeError` will be raised if the string cannot be encoded directly to ASCII. ascii)rrencodeunquote_bytes_to_wsgitraversal_path_info)rrrrtraversal_paths  rGic CsRy t|}Wn<tk rH}zt|j|j|j|j|jWdd}~XYnXt|S)aGiven``path``, return a tuple representing that path which can be used to traverse a resource tree. ``path`` is assumed to be an already-URL-decoded ``str`` type as if it had come to us from an upstream WSGI server as the ``PATH_INFO`` environ variable. The ``path`` is first decoded from its WSGI representation to text. Per the :pep:`3333` spec, ``path`` is first encoded to bytes using the Latin-1 encoding; the resulting set of bytes is subsequently decoded to text using the UTF-8 encoding; a :exc:`pyramid.exc.URLDecodeError` is raised if the URL cannot be decoded. The ``path`` is split on slashes, creating a list of segments. If a segment name is empty or if it is ``.``, it is ignored. If a segment name is ``..``, the previous segment is deleted, and the ``..`` is ignored. Examples: ``/`` () ``/foo/bar/baz`` ('foo', 'bar', 'baz') ``foo/bar/baz`` ('foo', 'bar', 'baz') ``/foo/bar/baz/`` ('foo', 'bar', 'baz') ``/foo//bar//baz/`` ('foo', 'bar', 'baz') ``/foo/bar/baz/..`` ('foo', 'bar') ``/my%20archives/hello`` ('my archives', 'hello') ``/archives/La%20Pe%C3%B1a`` ('archives', '') .. note:: This function does not generate the same type of tuples that :func:`pyramid.traversal.resource_path_tuple` does. In particular, the leading empty string is not present in the tuple it returns, unlike tuples returned by :func:`pyramid.traversal.resource_path_tuple`. As a result, tuples generated by ``traversal_path`` are not resolveable by the :func:`pyramid.traversal.find_resource` API. ``traversal_path`` is a function mostly used by the internals of :app:`Pyramid` and by people writing their own traversal machinery, as opposed to users writing applications in :app:`Pyramid`. N) decode_path_infoUnicodeDecodeErrorrencodingobjectstartendreasonsplit_path_info)rerrrrFs @ ,rFcCsX|d}g}x@|dD]2}|r|dkr.qq|dkrB|rL|d=q||qWt|S)Nr.z..)stripsplitappendr-)rcleansegmentrrrrOs  rOcCs|ddS)Nzlatin-1zutf-8)rDdecode)rrrrrHsrHcCst|dS)Nzlatin-1)rrX)Z bytestringrrrrEsrEcCsXy"|jttfkrt|}t||fStk rRtt|d|}|t||f<|SXdS)a Return a quoted representation of a 'path segment' (such as the string ``__name__`` attribute of a resource) as a string. If the ``segment`` passed in is a bytes object, it is decoded as a UTF-8 string. The result is then URL-quoted using Python's ``urllib.quote``. If the segment passed in is not bytes nor a string, an error will be raised. The return value of ``quote_path_segment`` is always a string. You may pass a string of characters that need not be encoded as the ``safe`` argument to this function. This corresponds to the ``safe`` argument to :mod:`urllib.quote`. .. note:: The return value for each segment passed to this function is cached in a module-scope dictionary for speed: the cached version is returned when possible rather than recomputing the quoted version. No cache emptying is ever done for the lifetime of an application, however. If you pass arbitrary user-supplied strings to this function (as opposed to some bounded set of values from a 'working set' known to your application), it may become a memory leak. zutf-8N) __class__rbytes_segment_cacherrr)rWsaferesultrrrquote_path_segments  r^c@s(eZdZdZeZdZddZddZdS)r/zA resource tree traverser that should be used (for speed) when every resource in the tree supplies a ``__name__`` and ``__parent__`` attribute (ie. every resource in the tree is :term:`location` aware) .z@@cCs ||_dS)N)r?)selfr?rrr__init__PszResourceTreeTraverser.__init__c Cs`|j}|j}|dk r\|ddp"d}t|r>dd|pW| d ||| || d S) NrrsubpathrrRr)rrraZ traversedrBZvirtual_root_pathr?r+)environ matchdictgetrjoinrOZ path_inforrIrrJrKrLrMrNrrHr>r? VIEW_SELECTOR __getitem__r9)r_r1rdrerrarPrAZ vroot_tupler@Z vroot_idxr?obZvrootZ vpath_tupleiZ view_selectorrWgetitemnextrrr__call__Ss  *        zResourceTreeTraverser.__call__N)r3 __module__ __qualname____doc__rrhr`rnrrrrr/Fs r/c@seZdZeZddZdS)r:c Cst|}t|}|dkr(|d}|d}|}|}|j}||j}|dk r|d}|r||rt|d} t | } d|| d}|t |d}||_ ||_ ||_ ||_ dS)N)r+r)r(r'rdrfrrstrip startswithr-rTr>r;r<virtual_path_tuplephysical_path_tuple) r_rr1rur<r;rtrdrAZvroot_path_tupleZnumelsrrrr`s(  zResourceURL.__init__N)r3rorprr`rrrrr:sr:cCs|rddd|DpdS)NrcSsg|] }t|qSr)r^)r4xrrrr6sz$_join_path_tuple..)rg)r-rrrr'sr'c@seZdZdZdZddZdS)DefaultRootFactoryNcCsdS)Nr)r_r1rrrr`szDefaultRootFactory.__init__)r3rorprr`rrrrrwsrwN)3 functoolsr urllib.parserZzope.interfacerZzope.interface.interfacesrZpyramid.encoderZpyramid.exceptionsrZpyramid.interfacesrr r r Zpyramid.locationr Zpyramid.threadlocalr Z pyramid.utilrrrZPATH_SEGMENT_SAFEZ PATH_SAFErr Z find_modelr&r*Z model_pathrr(Zmodel_path_tupler2Z_model_path_listrBrGrFrOrHrEr[r^r/ZModelGraphTraverserr:r'rwrrrrsH         6. ) -G +$