diff options
| author | Chris McDonough <chrism@plope.com> | 2011-12-08 04:26:15 -0500 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2011-12-08 04:26:15 -0500 |
| commit | 56df902d0a5bcd29a2b4c3dfafab9a09d6f0c29d (patch) | |
| tree | 3459444e6c27303505695f24d014a32b33036587 /docs | |
| parent | 101e0964d2c51404cdd71a28fad45921858e7191 (diff) | |
| download | pyramid-56df902d0a5bcd29a2b4c3dfafab9a09d6f0c29d.tar.gz pyramid-56df902d0a5bcd29a2b4c3dfafab9a09d6f0c29d.tar.bz2 pyramid-56df902d0a5bcd29a2b4c3dfafab9a09d6f0c29d.zip | |
- New APIs: ``pyramid.path.AssetResolver`` and
``pyramid.path.DottedNameResolver``. The former can be used to resolve
asset specifications, the latter can be used to resolve dotted names to
modules or packages.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 1 | ||||
| -rw-r--r-- | docs/api/path.rst | 13 | ||||
| -rw-r--r-- | docs/glossary.rst | 6 | ||||
| -rw-r--r-- | docs/whatsnew-1.3.rst | 6 |
4 files changed, 26 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst index dc75e45e0..979e8f490 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -21,6 +21,7 @@ documentation is organized alphabetically by module name. api/interfaces api/location api/paster + api/path api/registry api/renderers api/request diff --git a/docs/api/path.rst b/docs/api/path.rst new file mode 100644 index 000000000..045d77da2 --- /dev/null +++ b/docs/api/path.rst @@ -0,0 +1,13 @@ +.. _path_module: + +:mod:`pyramid.path` +--------------------------- + +.. automodule:: pyramid.path + + .. autoclass:: DottedNameResolver + :members: + + .. autoclass:: AssetResolver + :members: + diff --git a/docs/glossary.rst b/docs/glossary.rst index 399b78cdf..e4de15bd6 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -977,3 +977,9 @@ Glossary a running Pyramid application. An introspectable is associated with a :term:`action` by virtue of the :meth:`pyramid.config.Configurator.action` method. + + asset descriptor + An instance representing an :term:`asset specification` provided by the + :meth:`pyramid.path.AssetResolver.resolve` method. It supports the + methods and attributes documented in + :class:`pyramid.interfaces.IAssetDescriptor`. diff --git a/docs/whatsnew-1.3.rst b/docs/whatsnew-1.3.rst index 44c55e208..9bb10d1d0 100644 --- a/docs/whatsnew-1.3.rst +++ b/docs/whatsnew-1.3.rst @@ -43,6 +43,12 @@ New APIs were added to support introspection Minor Feature Additions ----------------------- +- New APIs: :class:`pyramid.path.AssetResolver` and + :class:`pyramid.path.DottedNameResolver`. The former can be used to + resolve an :term:`asset specification` to an API that can be used to read + the asset's data, the latter can be used to resolve a :term:`dotted Python + name` to a module or a package. + - A ``mako.directories`` setting is no longer required to use Mako templates Rationale: Mako template renderers can be specified using an absolute asset spec. An entire application can be written with such asset specs, |