Glossary¶

ACE¶

An access control entry. An access control entry is one element in an ACL. An access control entry is a three-tuple that describes three things: an action (one of either Allow or Deny), a principal (a string describing a user or group), and a permission. For example the ACE, (Allow, 'bob', 'read') is a member of an ACL that indicates that the principal bob is allowed the permission read against the resource the ACL is attached to.

ACL¶

An access control list. An ACL is a sequence of ACE tuples. An ACL is attached to a resource instance. An example of an ACL is [ (Allow, 'bob', 'read'), (Deny, 'fred', 'write')]. If an ACL is attached to a resource instance, and that resource is findable via the context resource, it will be consulted any active security policy to determine whether a particular request can be fulfilled given the authentication information in the request.

action¶

Represents a pending configuration statement generated by a call to a configuration directive. The set of pending configuration actions are processed when pyramid.config.Configurator.commit() is called.

add-on¶

A Python distribution that uses Pyramid's extensibility to plug into a Pyramid application and provide extra, configurable services.

Agendaless Consulting¶

A consulting organization formed by Paul Everitt, Tres Seaver, and Chris McDonough.

See also

See also the stdlib documentation for more information.

Translation Context¶

A string representing the "context" in which a translation was made within a given translation domain. See the gettext documentation, 11.2.5 Using contexts for solving ambiguities for more information.

Translation Directory¶

A translation directory is a gettext translation directory. It contains language folders, which themselves contain LC_MESSAGES folders, which contain .mo files. Each .mo file represents a set of translations for a language in a translation domain. The name of the .mo file (minus the .mo extension) is the translation domain name.

Translation Domain¶

A string representing the "context" in which a translation was made. For example the word "java" might be translated differently if the translation domain is "programming-languages" than would be if the translation domain was "coffee". A translation domain is represented by a collection of .mo files within one or more translation directory directories.

Translation String¶

An instance of pyramid.i18n.TranslationString, which is a class that behaves like a Unicode string, but has several extra attributes such as domain, msgid, and mapping for use during translation. Translation strings are usually created by hand within software, but are sometimes created on the behalf of the system for automatic template translation. For more information, see Internationalization and Localization.

Translator¶

A callable which receives a translation string and returns a translated Unicode object for the purposes of internationalization. A localizer supplies a translator to a Pyramid application accessible via its translate method.

traversal¶

The act of descending "up" a tree of resource objects from a root resource in order to find a context resource. The Pyramid router performs traversal of resource objects when a root factory is specified. See the Traversal chapter for more information. Traversal can be performed instead of URL dispatch or can be combined with URL dispatch. See Combining Traversal and URL Dispatch for more information about combining traversal and URL dispatch (advanced).

truthy string¶

A string represeting a value of True. Acceptable values are t, true, y, yes, on and 1.

tween¶

A bit of code that sits between the Pyramid router's main request handling function and the upstream WSGI component that uses Pyramid as its 'app'. The word "tween" is a contraction of "between". A tween may be used by Pyramid framework extensions, to provide, for example, Pyramid-specific view timing support, bookkeeping code that examines exceptions before they are returned to the upstream WSGI application, or a variety of other features. Tweens behave a bit like WSGI middleware but they have the benefit of running in a context in which they have access to the Pyramid application registry as well as the Pyramid rendering machinery. See Registering Tweens.

URL dispatch¶

An alternative to traversal as a mechanism for locating a context resource for a view. When you use a route in your Pyramid application via a route configuration, you are using URL dispatch. See the URL Dispatch for more information.

userid¶

A userid is a string or Unicode object used to identify and authenticate a real-world user or client. A userid is supplied to an authentication policy in order to discover the user's principals. In the authentication policies which Pyramid provides, the default behavior returns the user's userid as a principal, but this is not strictly necessary in custom policies that define their principals differently.

Venusian¶

Venusian is a library which allows framework authors to defer decorator actions. Instead of taking actions when a function (or class) decorator is executed at import time, the action usually taken by the decorator is deferred until a separate "scan" phase. Pyramid relies on Venusian to provide a basis for its scan feature.

venv¶

The Python Packaging Authority's recommended tool for creating virtual environments on Python 3.3 and greater.

Note: whenever you encounter commands prefixed with $VENV (Unix) or %VENV (Windows), know that that is the environment variable whose value is the root of the virtual environment in question.

view¶

Common vernacular for a view callable.

view callable¶

A "view callable" is a callable Python object which is associated with a view configuration; it returns a response object . A view callable accepts a single argument: request, which will be an instance of a request object. An alternate calling convention allows a view to be defined as a callable which accepts a pair of arguments: context and request: this calling convention is useful for traversal-based applications in which a context is always very important. A view callable is the primary mechanism by which a developer writes user interface code within Pyramid. See Views for more information about Pyramid view callables.

view configuration¶

View configuration is the act of associating a view callable with configuration information. This configuration information helps map a given request to a particular view callable and it can influence the response of a view callable. Pyramid views can be configured via imperative configuration, or by a special @view_config decorator coupled with a scan. See View Configuration for more information about view configuration.

view deriver¶

A view deriver is a composable component of the view pipeline which is used to create a view callable. A view deriver is a callable implementing the pyramid.interfaces.IViewDeriver interface. Examples of built-in derivers including view mapper, the permission checker, and applying a renderer to a dictionary returned from the view.

View handler¶

A view handler ties together pyramid.config.Configurator.add_route() and pyramid.config.Configurator.add_view() to make it more convenient to register a collection of views as a single class when using URL dispatch. View handlers ship as part of the pyramid_handlers add-on package.

View Lookup¶

The act of finding and invoking the "best" view callable, given a request and a context resource.

view mapper¶

A view mapper is a class which implements the 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".

view name¶

The "URL name" of a view, e.g index.html. If a view is configured without a name, its name is considered to be the empty string (which implies the default view).

view predicate¶

An argument to a view configuration which evaluates to True or False for a given request. All predicates attached to a view configuration must evaluate to true for the associated view to be considered as a possible callable for a given request.

virtual environment¶

An isolated Python environment that allows packages to be installed for use by a particular application, rather than being installed system wide.

virtual root¶

A resource object representing the "virtual" root of a request; this is typically the physical root object unless Virtual Hosting is in use.

virtualenv¶

The virtualenv tool that allows one to create virtual environments. In Python 3.3 and greater, venv is the preferred tool.

Note: whenever you encounter commands prefixed with $VENV (Unix) or %VENV (Windows), know that that is the environment variable whose value is the root of the virtual environment in question.

Waitress¶

A WSGI server that runs on Unix and Windows under Python 2.7+ and Python 3.3+. Projects generated via Pyramid cookiecutters use Waitress as a WGSI server. See https://docs.pylonsproject.org/projects/waitress/en/latest/ for detailed information.

WebOb¶

WebOb is a WSGI request/response library created by Ian Bicking.

WebTest¶

WebTest is a package which can help you write functional tests for your WSGI application.

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 that your application be served as a WSGI application.

ZCML¶

Zope Configuration Markup Language, an XML dialect used by Zope and pyramid_zcml for configuration tasks.

ZODB¶

Zope Object Database, a persistent Python object store.

Zope¶

The Z Object Publishing Framework, a full-featured Python web framework.

Zope Component Architecture¶

The Zope Component Architecture (aka ZCA) is a system which allows for application pluggability and complex dispatching based on objects which implement an interface. Pyramid uses the ZCA "under the hood" to perform view dispatching and other application configuration tasks.

ZPT¶

The Zope Page Template templating language.

Glossary¶

Previous topic

This Page