""" Utility functions for dealing with URLs in pyramid """
import os
from pyramid.interfaces import IResourceURL, IRoutesMapper, IStaticURLInfo
from pyramid._compat import bytes_, lru_cache, string_types
from pyramid.encode import url_quote, urlencode
from pyramid.path import caller_package
from pyramid.threadlocal import get_current_registry
from pyramid.traversal import (
ResourceURL,
quote_path_segment,
PATH_SAFE,
PATH_SEGMENT_SAFE,
)
QUERY_SAFE = "/?:@!$&'()*+,;=" # RFC 3986
ANCHOR_SAFE = QUERY_SAFE
def parse_url_overrides(request, kw):
"""
Parse special arguments passed when generating urls.
The supplied dictionary is mutated when we pop arguments.
Returns a 3-tuple of the format:
``(app_url, qs, anchor)``.
"""
app_url = kw.pop('_app_url', None)
scheme = kw.pop('_scheme', None)
host = kw.pop('_host', None)
port = kw.pop('_port', None)
query = kw.pop('_query', '')
anchor = kw.pop('_anchor', '')
if app_url is None:
if scheme is not None or host is not None or port is not None:
app_url = request._partial_application_url(scheme, host, port)
else:
app_url = request.application_url
qs = ''
if query:
if isinstance(query, string_types):
qs = '?' + url_quote(query, QUERY_SAFE)
else:
qs = '?' + urlencode(query, doseq=True)
frag = ''
if anchor:
frag = '#' + url_quote(anchor, ANCHOR_SAFE)
return app_url, qs, frag
class URLMethodsMixin(object):
"""Request methods mixin for BaseRequest having to do with URL
generation"""
def _partial_application_url(self, scheme=None, host=None, port=None):
"""
Construct the URL defined by request.application_url, replacing any
of the default scheme, host, or port portions with user-supplied
variants.
If ``scheme`` is passed as ``https``, and the ``port`` is *not*
passed, the ``port`` value is assumed to ``443``. Likewise, if
``scheme`` is passed as ``http`` and ``port`` is not passed, the
``port`` value is assumed to be ``80``.
"""
e = self.environ
if scheme is None:
scheme = e['wsgi.url_scheme']
else:
if scheme == 'https':
if port is None:
port = '443'
if scheme == 'http':
if port is None:
port = '80'
if host is None:
host = e.get('HTTP_HOST')
if host is None:
host = e['SERVER_NAME']
if port is None:
if ':' in host:
host, port = host.split(':', 1)
else:
port = e['SERVER_PORT']
else:
port = str(port)
if ':' in host:
host, _ = host.split(':', 1)
if scheme == 'https':
if port == '443':
port = None
elif scheme == 'http':
if port == '80':
port = None
url = scheme + '://' + host
if port:
url += ':%s' % port
url_encoding = getattr(self, 'url_encoding', 'utf-8') # webob 1.2b3+
bscript_name = bytes_(self.script_name, url_encoding)
return url + url_quote(bscript_name, PATH_SAFE)
def route_url(self, route_name, *elements, **kw):
"""Generates a fully qualified URL for a named :app:`Pyramid`
:term:`route configuration`.
Use the route's ``name`` as the first positional argument.
Additional positional arguments (``*elements``) are appended to the
URL as path segments after it is generated.
Use keyword arguments to supply values which match any dynamic
path elements in the route definition. Raises a :exc:`KeyError`
exception if the URL cannot be generated for any reason (not
enough arguments, for example).
For example, if you've defined a route named "foobar" with the path
``{foo}/{bar}/*traverse``::
request.route_url('foobar',
foo='1') => <KeyError exception>
request.route_url('foobar',
foo='1',
bar='2') => <KeyError exception>
request.route_url('foobar',
foo='1',
bar='2',
traverse=('a','b')) => http://e.com/1/2/a/b
request.route_url('foobar',
foo='1',
bar='2',
traverse='/a/b') => http://e.com/1/2/a/b
Values replacing ``:segment`` arguments can be passed as strings
or Unicode objects. They will be encoded to UTF-8 and URL-quoted
before being placed into the generated URL.
Values replacing ``*remainder`` arguments can be passed as strings
*or* tuples of Unicode/string values. If a tuple is passed as a
``*remainder`` replacement value, its values are URL-quoted and
encoded to UTF-8. The resulting strings are joined with slashes
and rendered into the URL. If a string is passed as a
``*remainder`` replacement value, it is tacked on to the URL
after being URL-quoted-except-for-embedded-slashes.
If ``_query`` is provided, it will be used to compose a query string
that will be tacked on to the end of the URL. The value of ``_query``
may be a sequence of two-tuples *or* a data structure with an
``.items()`` method that returns a sequence of two-tuples
(presumably a dictionary). This data structure will be turned into
a query string per the documentation of the
:func:`pyramid.url.urlencode` function. This will produce a query
string in the ``x-www-form-urlencoded`` format. A
non-``x-www-form-urlencoded`` query string may be used by passing a
*string* value as ``_query`` in which case it will be URL-quoted
(e.g. query="foo bar" will become "foo%20bar"). However, the result
will not need to be in ``k=v`` form as required by
``x-www-form-urlencoded``. After the query data is turned into a query
string, a leading ``?`` is prepended, and the resulting string is
appended to the generated URL.
.. note::
Python data structures that are passed as ``_query`` which are
sequences or dictionaries are turned into a string under the same
rules as when run through :func:`urllib.urlencode` with the
``doseq`` argument equal to ``True``. This means that sequences can
be passed as values, and a k=v pair will be placed into the query
string for each value.
If a keyword argument ``_anchor`` is present, its string
representation will be quoted per :rfc:`3986#section-3.5` and used as
a named anchor in the generated URL
(e.g. if ``_anchor`` is passed as ``foo`` and the route URL is
``http://example.com/route/url``, the resulting generated URL will
be ``http://example.com/route/url#foo``).
.. note::
If ``_anchor`` is passed as a string, it should be UTF-8 encoded. If
``_anchor`` is passed as a Unicode object, it will be converted to
UTF-8 before being appended to the URL.
If both ``_anchor`` and ``_query`` are specified, the anchor
element will always follow the query element,
e.g. ``http://example.com?foo=1#bar``.
If any of the keyword arguments ``_scheme``, ``_host``, or ``_port``
is passed and is non-``None``, the provided value will replace the
named portion in the generated URL. For example, if you pass
``_host='foo.com'``, and the URL that would have been generated
without the host replacement is ``http://example.com/a``, the result
will be ``http://foo.com/a``.
Note that if ``_scheme`` is passed as ``https``, and ``_port`` is not
passed, the ``_port`` value is assumed to have been passed as
``443``. Likewise, if ``_scheme`` is passed as ``http`` and
``_port`` is not passed, the ``_port`` value is assumed to have been
passed as ``80``. To avoid this behavior, always explicitly pass
``_port`` whenever you pass ``_scheme``.
If a keyword ``_app_url`` is present, it will be used as the
protocol/hostname/port/leading path prefix of the generated URL.
For example, using an ``_app_url`` of
``http://example.com:8080/foo`` would cause the URL
``http://example.com:8080/foo/fleeb/flub`` to be returned from
this function if the expansion of the route pattern associated
with the ``route_name`` expanded to ``/fleeb/flub``. If
``_app_url`` is not specified, the result of
``request.application_url`` will be used as the prefix (the
default).
If both ``_app_url`` and any of ``_scheme``, ``_host``, or ``_port``
are passed, ``_app_url`` takes precedence and any values passed for
``_scheme``, ``_host``, and ``_port`` will be ignored.
This function raises a :exc:`KeyError` if the URL cannot be
generated due to missing replacement names. Extra replacement
names are ignored.
If the route object which matches the ``route_name`` argument has
a :term:`pregenerator`, the ``*elements`` and ``**kw``
arguments passed to this function might be augmented or changed.
.. versionchanged:: 1.5
Allow the ``_query`` option to be a string to enable alternative
encodings.
The ``_anchor`` option will be escaped instead of using
its raw string representation.
.. versionchanged:: 1.9
If ``_query`` or ``_anchor`` are falsey (such as ``None`` or an
empty string) they will not be included in the generated url.
"""
try:
reg = self.registry
except AttributeError:
reg = get_current_registry() # b/c
mapper = reg.getUtility(IRoutesMapper)
route = mapper.get_route(route_name)
if route is None:
raise KeyError('No such route named %s' % route_name)
if route.pregenerator is not None:
elements, kw = route.pregenerator(self, elements, kw)
app_url, qs, anchor = parse_url_overrides(self, kw)
path = route.generate(kw) # raises KeyError if generate fails
if elements:
suffix = _join_elements(elements)
if not path.endswith('/'):
suffix = '/' + suffix
else:
suffix = ''
return app_url + path + suffix + qs + anchor
def route_path(self, route_name, *elements, **kw):
"""
Generates a path (aka a 'relative URL', a URL minus the host, scheme,
and port) for a named :app:`Pyramid` :term:`route configuration`.
This function accepts the same argument as
:meth:`pyramid.request.Request.route_url` and performs the same duty.
It just omits the host, port, and scheme information in the return
value; only the script_name, path, query parameters, and anchor data
are present in the returned string.
For example, if you've defined a route named 'foobar' with the path
``/{foo}/{bar}``, this call to ``route_path``::
request.route_path('foobar', foo='1', bar='2')
Will return the string ``/1/2``.
.. note::
Calling ``request.route_path('route')`` is the same as calling
``request.route_url('route', _app_url=request.script_name)``.
:meth:`pyramid.request.Request.route_path` is, in fact,
implemented in terms of :meth:`pyramid.request.Request.route_url`
in just this way. As a result, any ``_app_url`` passed within the
``**kw`` values to ``route_path`` will be ignored.
"""
kw['_app_url'] = self.script_name
return self.route_url(route_name, *elements, **kw)
def resource_url(self, resource, *elements, **kw):
"""
Generate a string representing the absolute URL of the
:term:`resource` object based on the ``wsgi.url_scheme``,
``HTTP_HOST`` or ``SERVER_NAME`` in the request, plus any
``SCRIPT_NAME``. The overall result of this method is always a
UTF-8 encoded string.
Examples::
request.resource_url(resource) =>
http://example.com/
request.resource_url(resource, 'a.html') =>
http://example.com/a.html
request.resource_url(resource, 'a.html', query={'q':'1'}) =>
http://example.com/a.html?q=1
request.resource_url(resource, 'a.html', anchor='abc') =>
http://example.com/a.html#abc
request.resource_url(resource, app_url='') =>
/
Any positional arguments passed in as ``elements`` must be strings
Unicode objects, or integer objects. These will be joined by slashes
and appended to the generated resource URL. Each of the elements
passed in is URL-quoted before being appended; if any element is
Unicode, it will converted to a UTF-8 bytestring before being
URL-quoted. If any element is an integer, it will be converted to its
string representation before being URL-quoted.
.. warning:: if no ``elements`` arguments are specified, the resource
URL will end with a trailing slash. If any
``elements`` are used, the generated URL will *not*
end in a trailing slash.
If ``query`` is provided, it will be used to compose a query string
that will be tacked on to the end of the URL. The value of ``query``
may be a sequence of two-tuples *or* a data structure with an
``.items()`` method that returns a sequence of two-tuples
(presumably a dictionary). This data structure will be turned into
a query string per the documentation of the
:func:`pyramid.url.urlencode` function. This will produce a query
string in the ``x-www-form-urlencoded`` format. A
non-``x-www-form-urlencoded`` query string may be used by passing a
*string* value as ``query`` in which case it will be URL-quoted
(e.g. query="foo bar" will become "foo%20bar"). However, the result
will not need to be in ``k=v`` form as required by
``x-www-form-urlencoded``. After the query data is turned into a query
string, a leading ``?`` is prepended, and the resulting string is
appended to the generated URL.
.. note::
Python data structures that are passed as ``query`` which are
sequences or dictionaries are turned into a string under the same
rules as when run through :func:`urllib.urlencode` with the
``doseq`` argument equal to ``True``. This means that sequences can
be passed as values, and a k=v pair will be placed into the query
string for each value.
If a keyword argument ``anchor`` is present, its string
representation will be used as a named anchor in the generated URL
(e.g. if ``anchor`` is passed as ``foo`` and the resource URL is
``http://example.com/resource/url``, the resulting generated URL will
be ``http://example.com/resource/url#foo``).
.. note::
If ``anchor`` is passed as a string, it should be UTF-8 encoded. If
``anchor`` is passed as a Unicode object, it will be converted to
UTF-8 before being appended to the URL.
If both ``anchor`` and ``query`` are specified, the anchor element
will always follow the query element,
e.g. ``http://example.com?foo=1#bar``.
If any of the keyword arguments ``scheme``, ``host``, or ``port`` is
passed and is non-``None``, the provided value will replace the named
portion in the generated URL. For example, if you pass
``host='foo.com'``, and the URL that would have been generated
without the host replacement is ``http://example.com/a``, the result
will be ``http://foo.com/a``.
If ``scheme`` is passed as ``https``, and an explicit ``port`` is not
passed, the ``port`` value is assumed to have been passed as ``443``.
Likewise, if ``scheme`` is passed as ``http`` and ``port`` is not
passed, the ``port`` value is assumed to have been passed as
``80``. To avoid this behavior, always explicitly pass ``port``
whenever you pass ``scheme``.
If a keyword argument ``app_url`` is passed and is not ``None``, it
should be a string that will be used as the port/hostname/initial
path portion of the generated URL instead of the default request
application URL. For example, if ``app_url='http://foo'``, then the
resulting url of a resource that has a path of ``/baz/bar`` will be
``http://foo/baz/bar``. If you want to generate completely relative
URLs with no leading scheme, host, port, or initial path, you can
pass ``app_url=''``. Passing ``app_url=''`` when the resource path is
``/baz/bar`` will return ``/baz/bar``.
If ``app_url`` is passed and any of ``scheme``, ``port``, or ``host``
are also passed, ``app_url`` will take precedence and the values
passed for ``scheme``, ``host``, and/or ``port`` will be ignored.
If the ``resource`` passed in has a ``__resource_url__`` method, it
will be used to generate the URL (scheme, host, port, path) for the
base resource which is operated upon by this function.
.. seealso::
See also :ref:`overriding_resource_url_generation`.
If ``route_name`` is passed, this function will delegate its URL
production to the ``route_url`` function. Calling
``resource_url(someresource, 'element1', 'element2', query={'a':1},
route_name='blogentry')`` is roughly equivalent to doing::
traversal_path = request.resource_path(someobject)
url = request.route_url(
'blogentry',
'element1',
'element2',
_query={'a':'1'},
traverse=traversal_path,
)
It is only sensible to pass ``route_name`` if the route being named has
a ``*remainder`` stararg value such as ``*traverse``. The remainder
value will be ignored in the output otherwise.
By default, the resource path value will be passed as the name
``traverse`` when ``route_url`` is called. You can influence this by
passing a different ``route_remainder_name`` value if the route has a
different ``*stararg`` value at its end. For example if the route
pattern you want to replace has a ``*subpath`` stararg ala
``/foo*subpath``::
request.resource_url(
resource,
route_name='myroute',
route_remainder_name='subpath'
)
If ``route_name`` is passed, it is also permissible to pass
``route_kw``, which will passed as additional keyword arguments to
``route_url``. Saying ``resource_url(someresource, 'element1',
'element2', route_name='blogentry', route_kw={'id':'4'},
_query={'a':'1'})`` is roughly equivalent to::
traversal_path = request.resource_path_tuple(someobject)
kw = {'id':'4', '_query':{'a':'1'}, 'traverse':traversal_path}
url = request.route_url(
'blogentry',
'element1',
'element2',
**kw,
)
If ``route_kw`` or ``route_remainder_name`` is passed, but
``route_name`` is not passed, both ``route_kw`` and
``route_remainder_name`` will be ignored. If ``route_name``
is passed, the ``__resource_url__`` method of the resource passed is
ignored unconditionally. This feature is incompatible with
resources which generate their own URLs.
.. note::
If the :term:`resource` used is the result of a :term:`traversal`,
it must be :term:`location`-aware. The resource can also be the
context of a :term:`URL dispatch`; contexts found this way do not
need to be location-aware.
.. note::
If a 'virtual root path' is present in the request environment (the
value of the WSGI environ key ``HTTP_X_VHM_ROOT``), and the resource
was obtained via :term:`traversal`, the URL path will not include
the virtual root prefix (it will be stripped off the left hand side
of the generated URL).
.. note::
For backwards compatibility purposes, this method is also
aliased as the ``model_url`` method of request.
.. versionchanged:: 1.3
Added the ``app_url`` keyword argument.
.. versionchanged:: 1.5
Allow the ``query`` option to be a string to enable alternative
encodings.
The ``anchor`` option will be escaped instead of using
its raw string representation.
Added the ``route_name``, ``route_kw``, and
``route_remainder_name`` keyword arguments.
.. versionchanged:: 1.9
If ``query`` or ``anchor`` are falsey (such as ``None`` or an
empty string) they will not be included in the generated url.
"""
try:
reg = self.registry
except AttributeError:
reg = get_current_registry() # b/c
url_adapter = reg.queryMultiAdapter((resource, self), IResourceURL)
if url_adapter is None:
url_adapter = ResourceURL(resource, self)
virtual_path = getattr(url_adapter, 'virtual_path', None)
urlkw = {}
for name in ('app_url', 'scheme', 'host', 'port', 'query', 'anchor'):
val = kw.get(name, None)
if val is not None:
urlkw['_' + name] = val
if 'route_name' in kw:
route_name = kw['route_name']
remainder = getattr(url_adapter, 'virtual_path_tuple', None)
if remainder is None:
# older user-supplied IResourceURL adapter without 1.5
# virtual_path_tuple
remainder = tuple(url_adapter.virtual_path.split('/'))
remainder_name = kw.get('route_remainder_name', 'traverse')
urlkw[remainder_name] = remainder
if 'route_kw' in kw:
route_kw = kw.get('route_kw')
if route_kw is not None:
urlkw.update(route_kw)
return self.route_url(route_name, *elements, **urlkw)
app_url, qs, anchor = parse_url_overrides(self, urlkw)
resource_url = None
local_url = getattr(resource, '__resource_url__', None)
if local_url is not None:
# the resource handles its own url generation
d = dict(
virtual_path=virtual_path,
physical_path=url_adapter.physical_path,
app_url=app_url,
)
# allow __resource_url__ to punt by returning None
resource_url = local_url(self, d)
if resource_url is None:
# the resource did not handle its own url generation or the
# __resource_url__ function returned None
resource_url = app_url + virtual_path
if elements:
suffix = _join_elements(elements)
else:
suffix = ''
return resource_url + suffix + qs + anchor
model_url = resource_url # b/w compat forever
def resource_path(self, resource, *elements, **kw):
"""
Generates a path (aka a 'relative URL', a URL minus the host, scheme,
and port) for a :term:`resource`.
This function accepts the same argument as
:meth:`pyramid.request.Request.resource_url` and performs the same
duty. It just omits the host, port, and scheme information in the
return value; only the script_name, path, query parameters, and
anchor data are present in the returned string.
.. note::
Calling ``request.resource_path(resource)`` is the same as calling
``request.resource_path(resource, app_url=request.script_name)``.
:meth:`pyramid.request.Request.resource_path` is, in fact,
implemented in terms of
:meth:`pyramid.request.Request.resource_url` in just this way. As
a result, any ``app_url`` passed within the ``**kw`` values to
``route_path`` will be ignored. ``scheme``, ``host``, and
``port`` are also ignored.
"""
kw['app_url'] = self.script_name
return self.resource_url(resource, *elements, **kw)
def static_url(self, path, **kw):
"""
Generates a fully qualified URL for a static :term:`asset`.
The asset must live within a location defined via the
:meth:`pyramid.config.Configurator.add_static_view`
:term:`configuration declaration` (see :ref:`static_assets_section`).
Example::
request.static_url('mypackage:static/foo.css') =>
http://example.com/static/foo.css
The ``path`` argument points at a file or directory on disk which
a URL should be generated for. The ``path`` may be either a
relative path (e.g. ``static/foo.css``) or an absolute path (e.g.
``/abspath/to/static/foo.css``) or a :term:`asset specification`
(e.g. ``mypackage:static/foo.css``).
The purpose of the ``**kw`` argument is the same as the purpose of
the :meth:`pyramid.request.Request.route_url` ``**kw`` argument. See
the documentation for that function to understand the arguments which
you can provide to it. However, typically, you don't need to pass
anything as ``*kw`` when generating a static asset URL.
This function raises a :exc:`ValueError` if a static view
definition cannot be found which matches the path specification.
"""
if not os.path.isabs(path):
if ':' not in path:
# if it's not a package:relative/name and it's not an
# /absolute/path it's a relative/path; this means its relative
# to the package in which the caller's module is defined.
package = caller_package()
path = '%s:%s' % (package.__name__, path)
try:
reg = self.registry
except AttributeError:
reg = get_current_registry() # b/c
info = reg.queryUtility(IStaticURLInfo)
if info is None:
raise ValueError('No static URL definition matching %s' % path)
return info.generate(path, self, **kw)
def static_path(self, path, **kw):
"""
Generates a path (aka a 'relative URL', a URL minus the host, scheme,
and port) for a static resource.
This function accepts the same argument as
:meth:`pyramid.request.Request.static_url` and performs the
same duty. It just omits the host, port, and scheme information in
the return value; only the script_name, path, query parameters, and
anchor data are present in the returned string.
Example::
request.static_path('mypackage:static/foo.css') =>
/static/foo.css
.. note::
Calling ``request.static_path(apath)`` is the same as calling
``request.static_url(apath, _app_url=request.script_name)``.
:meth:`pyramid.request.Request.static_path` is, in fact, implemented
in terms of :meth:`pyramid.request.Request.static_url` in just this
way. As a result, any ``_app_url`` passed within the ``**kw`` values
to ``static_path`` will be ignored.
"""
if not os.path.isabs(path):
if ':' not in path:
# if it's not a package:relative/name and it's not an
# /absolute/path it's a relative/path; this means its relative
# to the package in which the caller's module is defined.
package = caller_package()
path = '%s:%s' % (package.__name__, path)
kw['_app_url'] = self.script_name
return self.static_url(path, **kw)
def current_route_url(self, *elements, **kw):
"""
Generates a fully qualified URL for a named :app:`Pyramid`
:term:`route configuration` based on the 'current route'.
This function supplements
:meth:`pyramid.request.Request.route_url`. It presents an easy way to
generate a URL for the 'current route' (defined as the route which
matched when the request was generated).
The arguments to this method have the same meaning as those with the
same names passed to :meth:`pyramid.request.Request.route_url`. It
also understands an extra argument which ``route_url`` does not named
``_route_name``.
The route name used to generate a URL is taken from either the
``_route_name`` keyword argument or the name of the route which is
currently associated with the request if ``_route_name`` was not
passed. Keys and values from the current request :term:`matchdict`
are combined with the ``kw`` arguments to form a set of defaults
named ``newkw``. Then ``request.route_url(route_name, *elements,
**newkw)`` is called, returning a URL.
Examples follow.
If the 'current route' has the route pattern ``/foo/{page}`` and the
current url path is ``/foo/1`` , the matchdict will be
``{'page':'1'}``. The result of ``request.current_route_url()`` in
this situation will be ``/foo/1``.
If the 'current route' has the route pattern ``/foo/{page}`` and the
current url path is ``/foo/1``, the matchdict will be
``{'page':'1'}``. The result of
``request.current_route_url(page='2')`` in this situation will be
``/foo/2``.
Usage of the ``_route_name`` keyword argument: if our routing table
defines routes ``/foo/{action}`` named 'foo' and
``/foo/{action}/{page}`` named ``fooaction``, and the current url
pattern is ``/foo/view`` (which has matched the ``/foo/{action}``
route), we may want to use the matchdict args to generate a URL to
the ``fooaction`` route. In this scenario,
``request.current_route_url(_route_name='fooaction', page='5')``
Will return string like: ``/foo/view/5``.
"""
if '_route_name' in kw:
route_name = kw.pop('_route_name')
else:
route = getattr(self, 'matched_route', None)
route_name = getattr(route, 'name', None)
if route_name is None:
raise ValueError('Current request matches no route')
if '_query' not in kw:
kw['_query'] = self.GET
newkw = {}
newkw.update(self.matchdict)
newkw.update(kw)
return self.route_url(route_name, *elements, **newkw)
def current_route_path(self, *elements, **kw):
"""
Generates a path (aka a 'relative URL', a URL minus the host, scheme,
and port) for the :app:`Pyramid` :term:`route configuration` matched
by the current request.
This function accepts the same argument as
:meth:`pyramid.request.Request.current_route_url` and performs the
same duty. It just omits the host, port, and scheme information in
the return value; only the script_name, path, query parameters, and
anchor data are present in the returned string.
For example, if the route matched by the current request has the
pattern ``/{foo}/{bar}``, this call to ``current_route_path``::
request.current_route_path(foo='1', bar='2')
Will return the string ``/1/2``.
.. note::
Calling ``request.current_route_path('route')`` is the same
as calling ``request.current_route_url('route',
_app_url=request.script_name)``.
:meth:`pyramid.request.Request.current_route_path` is, in fact,
implemented in terms of
:meth:`pyramid.request.Request.current_route_url` in just this
way. As a result, any ``_app_url`` passed within the ``**kw``
values to ``current_route_path`` will be ignored.
"""
kw['_app_url'] = self.script_name
return self.current_route_url(*elements, **kw)
[docs]
def route_url(route_name, request, *elements, **kw):
"""
This is a backwards compatibility function. Its result is the same as
calling::
request.route_url(route_name, *elements, **kw)
See :meth:`pyramid.request.Request.route_url` for more information.
"""
return request.route_url(route_name, *elements, **kw)
[docs]
def route_path(route_name, request, *elements, **kw):
"""
This is a backwards compatibility function. Its result is the same as
calling::
request.route_path(route_name, *elements, **kw)
See :meth:`pyramid.request.Request.route_path` for more information.
"""
return request.route_path(route_name, *elements, **kw)
[docs]
def resource_url(resource, request, *elements, **kw):
"""
This is a backwards compatibility function. Its result is the same as
calling::
request.resource_url(resource, *elements, **kw)
See :meth:`pyramid.request.Request.resource_url` for more information.
"""
return request.resource_url(resource, *elements, **kw)
model_url = resource_url # b/w compat (forever)
[docs]
def static_url(path, request, **kw):
"""
This is a backwards compatibility function. Its result is the same as
calling::
request.static_url(path, **kw)
See :meth:`pyramid.request.Request.static_url` for more information.
"""
if not os.path.isabs(path):
if ':' not in path:
# if it's not a package:relative/name and it's not an
# /absolute/path it's a relative/path; this means its relative
# to the package in which the caller's module is defined.
package = caller_package()
path = '%s:%s' % (package.__name__, path)
return request.static_url(path, **kw)
[docs]
def static_path(path, request, **kw):
"""
This is a backwards compatibility function. Its result is the same as
calling::
request.static_path(path, **kw)
See :meth:`pyramid.request.Request.static_path` for more information.
"""
if not os.path.isabs(path):
if ':' not in path:
# if it's not a package:relative/name and it's not an
# /absolute/path it's a relative/path; this means its relative
# to the package in which the caller's module is defined.
package = caller_package()
path = '%s:%s' % (package.__name__, path)
return request.static_path(path, **kw)
[docs]
def current_route_url(request, *elements, **kw):
"""
This is a backwards compatibility function. Its result is the same as
calling::
request.current_route_url(*elements, **kw)
See :meth:`pyramid.request.Request.current_route_url` for more
information.
"""
return request.current_route_url(*elements, **kw)
[docs]
def current_route_path(request, *elements, **kw):
"""
This is a backwards compatibility function. Its result is the same as
calling::
request.current_route_path(*elements, **kw)
See :meth:`pyramid.request.Request.current_route_path` for more
information.
"""
return request.current_route_path(*elements, **kw)
@lru_cache(1000)
def _join_elements(elements):
return '/'.join(
[quote_path_segment(s, safe=PATH_SEGMENT_SAFE) for s in elements]
)
