From 53901dbad3cc176c86d8ab570a2d18759fb01160 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 23 Dec 2010 18:53:08 -0500 Subject: fix references --- docs/glossary.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index a3aacebce..ed96b8afe 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -845,4 +845,10 @@ Glossary `WebTest `_ is a package which can help you write functional tests for your WSGI application. + WebError + WSGI middleware which can display debuggable traceback information in + the browser when an exception is raised by a Pyramid application. See + http://pypi.python.org/pypi/WebError . + + -- cgit v1.2.3 From b33ae924870d29f1c1a4c57fde694050a535aba2 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 26 Dec 2010 17:11:57 -0500 Subject: wording --- docs/glossary.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index ed96b8afe..49d273197 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -54,7 +54,8 @@ Glossary For example, the asset specification ``my.package:static/baz.css`` identifies the file named ``baz.css`` in the ``static`` subdirectory of the ``my.package`` - Python :term:`package`. + Python :term:`package`. See :ref:`asset_specifications` for more + info. package A directory on disk which contains an ``__init__.py`` file, making -- cgit v1.2.3 From e874b2b4fb9ca973eed1f019162c917750088f58 Mon Sep 17 00:00:00 2001 From: Jamaludin Ahmad Date: Fri, 31 Dec 2010 13:42:18 +0700 Subject: handlers_chapter -> views_chapter --- docs/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 49d273197..1abbcf84b 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -834,7 +834,7 @@ Glossary :meth:`pyramid.config.Configurator.add_route` and :meth:`pyramid.config.Configurator.add_view` to make it more convenient to register a collection of views as a single class when - using :term:`url dispatch`. See also :ref:`handlers_chapter`. + using :term:`url dispatch`. See also :ref:`views_chapter`. Deployment settings Deployment settings are settings passed to the :term:`Configurator` as a -- cgit v1.2.3 From 80aa770ad2230f01611eb6f49080321faf77d9fe Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 2 Jan 2011 04:08:18 -0500 Subject: - add a ``add_view_mapper`` API to Configurator. This API allows you to add a named implementation of a ``pyramid.interfaces.IViewMapperFactory`` interface. Its name can be passed as a ``view_mapper`` argument to ``config.add_view``. A view mapper allows objects that are meant to be used as view callables to have an arbitrary argument list and an arbitrary result. This feature will be used by Pyramid extension developers, not by "civilians". - New constructor argument to Configurator: ``default_view_mapper``. Useful to create systems that have view callables with alternate default calling conventions. - ``view_mapper`` argument to ``add_view`` should now be a view mapper *name* rather than an implementation. - Add ``view_mapper`` argument to ``view_config`` decorator constructor. - Remove (non-API) function of config.py named _map_view. - Fix docstring for ``decorator`` argument to add_view. - Factor invocation of view mapper into a viewderiver method. - Promote view rendering and decorating into viewderiver, out of view mapper. - Make requestonly into a function rather than a method of the default view mapper. --- docs/glossary.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 49d273197..4d0c53d60 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -850,6 +850,11 @@ Glossary WSGI middleware which can display debuggable traceback information in the browser when an exception is raised by a Pyramid application. See http://pypi.python.org/pypi/WebError . - + view mapper + + A view mapper is a class which implements the + :class:`pyramid.interfaces.IViewMapperFactory` interface, which performs + view argument and return value mapping. This is a plug point for + extension builders, not normally used by "civilians". -- cgit v1.2.3 From 61c6c10c29d40297c8c47fed3a56f7a6266b2c86 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 3 Jan 2011 01:21:29 -0500 Subject: fix rendering --- docs/glossary.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 5deb9f5c6..ce2d77d8d 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -852,7 +852,6 @@ Glossary http://pypi.python.org/pypi/WebError . view mapper - A view mapper is a class which implements the :class:`pyramid.interfaces.IViewMapperFactory` interface, which performs view argument and return value mapping. This is a plug point for -- cgit v1.2.3 From 8a1b50bc4027e25d5450cc6968f1f005af9d389f Mon Sep 17 00:00:00 2001 From: Casey Duncan Date: Sun, 2 Jan 2011 23:45:33 -0700 Subject: Split view chapter, move view config after templates, some reordering in view config --- docs/glossary.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 49d273197..7090b5f93 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -114,12 +114,13 @@ Glossary view configuration View configuration is the act of associating a :term:`view callable` with configuration information. This configuration - information helps map a given :term:`request` to a particular view - callable and it can influence the response of a view callable. - :app:`Pyramid` views can be configured via :term:`imperative - configuration`, :term:`ZCML` or by a special ``@view_config`` - decorator coupled with a :term:`scan`. See :ref:`views_chapter` - for more information about view configuration. + information helps map a given :term:`request` to a particular view + callable and it can influence the response of a view callable. + :app:`Pyramid` views can be configured via :term:`imperative + configuration`, :term:`ZCML` or by a special ``@view_config`` + decorator coupled with a :term:`scan`. See + :ref:`view_config_chapter` for more information about view + configuration. view name The "URL name" of a view, e.g ``index.html``. If a view is -- cgit v1.2.3 From 5653d13e554433adf34fd81b2c6593a54e7c4ea1 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 3 Jan 2011 03:10:15 -0500 Subject: - Add a new API ``pyramid.url.current_route_url``, which computes a URL based on the "current" route (if any) and its matchdict values. --- docs/glossary.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index ce2d77d8d..890f7e837 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -857,3 +857,8 @@ Glossary view argument and return value mapping. This is a plug point for extension builders, not normally used by "civilians". + matchdict + The dictionary attached to the :term:`request` object as + ``request.matchdict`` when a :term:`URL dispatch` route has been matched. + Its keys are names as identified within the route pattern; its values are + the values matched by each pattern name. -- cgit v1.2.3 From 7138ca2bb09f254bce832248d6cc844edc51ed5a Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 16 Jan 2011 16:24:08 -0500 Subject: use correct rendering --- docs/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index a7e3a7884..93d6253cc 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -285,7 +285,7 @@ Glossary WSGI `Web Server Gateway Interface `_. This is a Python standard for connecting web applications to web servers, - similar to the concept of Java Servlets. ``pyramid`` requires + similar to the concept of Java Servlets. :app:`Pyramid` requires that your application be served as a WSGI application. middleware -- cgit v1.2.3 From c9c3c487bcaedeca97bb6463a00188b0dc01203a Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 18 Jan 2011 12:25:56 -0500 Subject: - Most references to ZCML in narrative chapters have been removed or redirected to ``pyramid_zcml`` locations. --- docs/glossary.rst | 81 +++++++++++++++++++++++++++---------------------------- 1 file changed, 39 insertions(+), 42 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 93d6253cc..600092f87 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -89,9 +89,9 @@ Glossary dotted Python name A reference to a Python object by name using a string, in the form ``path.to.modulename:attributename``. Often used in Paste and - setuptools configurations. A variant is used in dotted names - within :term:`ZCML` attributes that name objects (such as the ZCML - "view" directive's "view" attribute): the colon (``:``) is not + setuptools configurations. A variant is used in dotted names within + configurator method arguments that name objects (such as the "add_view" + method's "view" and "context" attributes): the colon (``:``) is not used; in its place is a dot. view @@ -116,8 +116,8 @@ Glossary with configuration information. This configuration information helps map a given :term:`request` to a particular view callable and it can influence the response of a view callable. :app:`Pyramid` views can be - configured via :term:`imperative configuration`, :term:`ZCML` or by a - special ``@view_config`` decorator coupled with a :term:`scan`. See + configured via :term:`imperative configuration`, or by a special + ``@view_config`` decorator coupled with a :term:`scan`. See :ref:`view_config_chapter` for more information about view configuration. @@ -377,29 +377,10 @@ Glossary ultimately a :term:`view`). See also :term:`url dispatch`. route configuration - Route configuration is the act of using :term:`imperative - configuration` or a :term:`ZCML` ```` statement to - associate request parameters with a particular :term:`route` using - pattern matching and :term:`route predicate` statements. See - :ref:`urldispatch_chapter` for more information about route - configuration. - - ZCML - `Zope Configuration Markup Language - `_, an XML dialect - used by Zope and :app:`Pyramid` for configuration tasks. ZCML - is capable of performing different types of :term:`configuration - declaration`, but its primary purpose in :app:`Pyramid` is to - perform :term:`view configuration` and :term:`route configuration` - within the ``configure.zcml`` file in a :app:`Pyramid` - application. You can use ZCML as an alternative to - :term:`imperative configuration`. - - ZCML directive - A ZCML "tag" such as ```` or ````. - - ZCML declaration - The concrete use of a :term:`ZCML directive` within a ZCML file. + Route configuration is the act of associating request parameters with a + particular :term:`route` using pattern matching and :term:`route + predicate` statements. See :ref:`urldispatch_chapter` for more + information about route configuration. Zope Component Architecture The `Zope Component Architecture @@ -457,9 +438,9 @@ Glossary subscriber A callable which receives an :term:`event`. A callable becomes a - subscriber via :term:`imperative configuration` or the - ```` ZCML directive. See :ref:`events_chapter` for - more information. + subscriber via :term:`imperative configuration` or via + :term:`configuration decoration`. See :ref:`events_chapter` for more + information. request type An attribute of a :term:`request` that allows for specialization @@ -577,15 +558,13 @@ Glossary also `PEP 318 `_. configuration declaration - An individual method call made to an instance of a - :app:`Pyramid` :term:`Configurator` object which performs an - arbitrary action, such as registering a :term:`view configuration` - (via the ``view`` method of the configurator) or :term:`route - configuration` (via the ``route`` method of the configurator). A - set of configuration declarations is also usually implied via the - use of a :term:`ZCML declaration` within an application, or a set - of configuration declarations might be performed by a :term:`scan` - of code in a package. + An individual method call made to an instance of a :app:`Pyramid` + :term:`Configurator` object which performs an arbitrary action, such as + registering a :term:`view configuration` (via the ``add_view`` method of + the configurator) or :term:`route configuration` (via the ``add_route`` + method of the configurator). A set of configuration declarations is + also implied by the :term:`configuration decoration` detected by a + :term:`scan` of code in a package. configuration decoration Metadata implying one or more :term:`configuration declaration` @@ -609,8 +588,8 @@ Glossary declaration` required by your application. declarative configuration - The configuration mode in which you use :term:`ZCML` to make - a set of :term:`configuration declaration` statements. + The configuration mode in which you use :term:`ZCML` to make a set of + :term:`configuration declaration` statements. See :term:`pyramid_zcml`. Not Found view An :term:`exception view` invoked by :app:`Pyramid` when the @@ -862,3 +841,21 @@ Glossary ``request.matchdict`` when a :term:`URL dispatch` route has been matched. Its keys are names as identified within the route pattern; its values are the values matched by each pattern name. + + pyramid_zcml + An add-on package to :app:`Pyramid` which allows applications to be + configured via ZCML. It is available on :term:`PyPI`. If you use + ``pyramid_zcml``, you can use ZCML as an alternative to + :term:`imperative configuration`. + + ZCML + `Zope Configuration Markup Language + `_, an XML dialect + used by Zope and :term:`pyramid_zcml` for configuration tasks. + + ZCML directive + A ZCML "tag" such as ```` or ````. + + ZCML declaration + The concrete use of a :term:`ZCML directive` within a ZCML file. + -- cgit v1.2.3 From 78fe62ae55a25ada43b9eaaf454d9e7044981a2d Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 19 Jan 2011 01:43:52 -0500 Subject: handlers are no longer a part of the package --- docs/glossary.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 600092f87..3c6f5cb1a 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -859,3 +859,9 @@ Glossary ZCML declaration The concrete use of a :term:`ZCML directive` within a ZCML file. + pyramid_handlers + An add-on package which allows :app:`Pyramid` users to create classes + that are analogues of Pylons 1 "controllers". See + `http://docs.pylonsproject.org/projects/pyramid_handlers/dev/ + `_. + -- cgit v1.2.3 From 2323d4898fcc2f524d230025ed6a9f17906023ab Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 21 Jan 2011 02:22:17 -0500 Subject: add caveat for PyPy and Jython users --- docs/glossary.rst | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 3c6f5cb1a..a53883a72 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -811,9 +811,10 @@ Glossary View handler A view handler ties together :meth:`pyramid.config.Configurator.add_route` and - :meth:`pyramid.config.Configurator.add_view` to make it more - convenient to register a collection of views as a single class when - using :term:`url dispatch`. See also :ref:`views_chapter`. + :meth:`pyramid.config.Configurator.add_view` to make it more convenient + to register a collection of views as a single class when using + :term:`url dispatch`. View handlers ship as part of the + :term:`pyramid_handlers` add-on package. Deployment settings Deployment settings are settings passed to the :term:`Configurator` as a @@ -865,3 +866,19 @@ Glossary `http://docs.pylonsproject.org/projects/pyramid_handlers/dev/ `_. + pyramid_jinja2 + :term:`Jinja2` templating system bindings for Pyramid, documented at + http://docs.pylonsproject.org/projects/pyramid_jinja2/dev/ . This + package also includes a paster template named + ``pyramid_jinja2_starter``, which creates an application package based + on the Jinja2 templating system. + + pyramid_sqla + A package which provides a Pylons-esque paster template which sports + support for :term:`view handler` application development, + :term:`SQLAlchemy` support, and other Pylons-like features. See + https://bytebucket.org/sluggo/pyramid_sqla/wiki/html/index.html for more + information. + + + -- cgit v1.2.3 From 4cf41f4f042067b3bb0001436640ab52b15f3249 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 21 Jan 2011 13:14:32 -0500 Subject: point at Pyramid Cookbook explicitly --- docs/glossary.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index a53883a72..a4d5f8030 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -880,5 +880,10 @@ Glossary https://bytebucket.org/sluggo/pyramid_sqla/wiki/html/index.html for more information. + Pyramid Cookbook + An `additional documentation resource + `_ + for Pyramid which presents topical, practical usages of Pyramid. + -- cgit v1.2.3 From ff3ba5c39d8392452e76d66f56dc15e4a4cb5b60 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 21 Jan 2011 21:47:37 -0500 Subject: add distutils entry --- docs/glossary.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index a4d5f8030..fc9f6a729 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -885,5 +885,10 @@ Glossary `_ for Pyramid which presents topical, practical usages of Pyramid. + distutils + The standard system for packaging and distributing Python packages. See + http://docs.python.org/distutils/index.html for more information. + :term:`setuptools` is actually an *extension* of the Distutils. + -- cgit v1.2.3 From a42a1efebd872f21c2fa96382248a2459cfb483c Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Fri, 28 Jan 2011 20:16:49 -0800 Subject: minor grammar fixes ('a' vs 'an') --- docs/glossary.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index fc9f6a729..c8f1a2f12 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -181,10 +181,10 @@ Glossary :ref:`urldispatch_chapter` for more information. context - An resource in the resource tree that is found during :term:`traversal` + A resource in the resource tree that is found during :term:`traversal` or :term:`URL dispatch` based on URL data; if it's found via traversal, it's usually a :term:`resource` object that is part of a resource tree; - if it's found via :term:`URL dispatch`, it's a object manufactured on + if it's found via :term:`URL dispatch`, it's an object manufactured on behalf of the route's "factory". A context resource becomes the subject of a :term:`view`, and often has security information attached to it. See the :ref:`traversal_chapter` chapter and the @@ -487,7 +487,7 @@ Glossary available as its ``__parent__`` attribute. root factory - The "root factory" of an :app:`Pyramid` application is called + The "root factory" of a :app:`Pyramid` application is called on every request sent to the application. The root factory returns the traversal root of an application. It is conventionally named ``get_root``. An application may supply a -- cgit v1.2.3 From 7e7fc95ace9710f10439cfc45bd52d2f73b0d275 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 28 Jan 2011 23:43:07 -0500 Subject: renderings --- docs/glossary.rst | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index fc9f6a729..6c8d6a8f5 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -24,12 +24,13 @@ Glossary information about response objects. Repoze - "Repoze" is essentially a "brand" of software developed by - `Agendaless Consulting `_ and a set of - contributors. The term has no special intrinsic meaning. The - project's `website `_ has more information. - The software developed "under the brand" is available in a - `Subversion repository `_. + "Repoze" is essentially a "brand" of software developed by `Agendaless + Consulting `_ and a set of contributors. The + term has no special intrinsic meaning. The project's `website + `_ has more information. The software developed + "under the brand" is available in a `Subversion repository + `_. Pyramid was originally known as + :mod:`repoze.bfg`. setuptools `Setuptools `_ @@ -311,7 +312,8 @@ Glossary `A full-featured Python web framework `_. Pylons - `A lightweight Python web framework `_. + `A lightweight Python web framework `_ and a + predecessor of Pyramid. ZODB `Zope Object Database `_, a @@ -498,7 +500,7 @@ Glossary all URL-to-view code mappings. SQLAlchemy - `SQLAlchemy' `_ is an object + `SQLAlchemy `_ is an object relational mapper used in tutorials within this documentation. JSON @@ -618,16 +620,15 @@ Glossary information. thread local - A thread-local variable is one which is essentially a global - variable in terms of how it is accessed and treated, however, - each `thread - ` used by - the application may have a different value for this same "global" - variable. :app:`Pyramid` uses a small number of thread local - variables, as described in :ref:`threadlocals_chapter`. See also - the `threading.local documentation - ` - for more information. + A thread-local variable is one which is essentially a global variable + in terms of how it is accessed and treated, however, each `thread + `_ used by the + application may have a different value for this same "global" variable. + :app:`Pyramid` uses a small number of thread local variables, as + described in :ref:`threadlocals_chapter`. See also the `threading.local + documentation + `_ for + more information. multidict An ordered dictionary that can have multiple values for each @@ -644,11 +645,11 @@ Glossary and Chris McDonough. See also http://agendaless.com . Jython - A `Python implementation ` written for + A `Python implementation `_ written for the Java Virtual Machine. Python - The `programming language ` in which + The `programming language `_ in which :app:`Pyramid` is written. CPython @@ -863,8 +864,7 @@ Glossary pyramid_handlers An add-on package which allows :app:`Pyramid` users to create classes that are analogues of Pylons 1 "controllers". See - `http://docs.pylonsproject.org/projects/pyramid_handlers/dev/ - `_. + http://docs.pylonsproject.org/projects/pyramid_handlers/dev/ . pyramid_jinja2 :term:`Jinja2` templating system bindings for Pyramid, documented at @@ -881,9 +881,9 @@ Glossary information. Pyramid Cookbook - An `additional documentation resource - `_ - for Pyramid which presents topical, practical usages of Pyramid. + An additional documentation resource for Pyramid which presents topical, + practical usages of Pyramid available via + http://docs.pylonsproject.org/ . distutils The standard system for packaging and distributing Python packages. See -- cgit v1.2.3 From 3e4f429cce60465f2d58d0a60eb6a3adb5f9a377 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 29 Jan 2011 01:29:12 -0500 Subject: - Moved "Using ZODB With ZEO" and "Using repoze.catalog Within Pyramid" tutorials out of core documentation and into the Pyramid Tutorials site (http://docs.pylonsproject.org/projects/pyramid_tutorials/dev/). --- docs/glossary.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 6c8d6a8f5..f1a50a0af 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -461,8 +461,7 @@ Glossary An indexing and search facility (fielded and full-text) based on `zope.index `_. See `the documentation `_ for more - information. A tutorial for its usage in :app:`Pyramid` - exists in :ref:`catalog_tutorial`. + information. repoze.who `Authentication middleware `_ for -- cgit v1.2.3