summaryrefslogtreecommitdiff
path: root/docs/narr/environment.rst
AgeCommit message (Collapse)Author
2011-10-06remove stray references to PasteChris McDonough
2011-09-05readd aliases to environment tablesChris McDonough
2011-09-03Updated environment documentation to include an example of accessing the ↵Charlie Choiniere
settings dictionary inside an includeme function
2011-08-22- Use [app:main] instead of a pipeline in all scaffolds and tutorialsChris McDonough
and narrative docs. - Break out awkward description of PasteDeploy entry points from project chapter into its own Paste chapter.
2011-08-21add a whatsnew-1.2 docChris McDonough
2011-08-12garden changes; fix docs renderingChris McDonough
2011-08-12add pyramid.tweens configuration value docsChris McDonough
2011-08-11add docs for pyramid.includes; allow space-separated or cr separated items ↵Chris McDonough
or both for tweens and includes
2011-07-30Updated all of the docs to reflect the new pyramid.* settings prefix.Michael Merickel
2011-07-20add more index markersChris McDonough
2011-07-12- New environment setting ``PYRAMID_PREVENT_HTTP_CACHE`` and newChris McDonough
configuration file value ``prevent_http_cache``. These are synomymous and allow you to prevent HTTP cache headers from being set by Pyramid's ``http_cache`` machinery globally in a process. see the "Influencing HTTP Caching" section of the "View Configuration" narrative chapter and the detailed documentation for this setting in the "Environment Variables and Configuration Settings" narrative chapter. - New documentation section in View Configuration narrative chapter: "Influencing HTTP Caching".
2011-06-26- Added ``mako.preprocessor`` config file parameter; allows for a MakoChris McDonough
preprocessor to be specified as a Python callable or Python dotted name. See https://github.com/Pylons/pyramid/pull/183 for rationale. Closes #183.
2011-06-05More small fixes made reading the rest of the docs and the tutorials.Christoph Zwerschke
2011-05-14add 'What's new In Pyramid 1.1' documentChris McDonough
2011-04-21add 'adding a custom settings'Chris McDonough
2011-01-16add a note explaining why you might want to use envarsCasey Duncan
2011-01-16clarifyCasey Duncan
2010-12-20remove following (confusing)Chris McDonough
2010-12-19- All environment variables which used to be prefixed with ``BFG_`` are nowChris McDonough
prefixed with ``PYRAMID_`` (e.g. ``BFG_DEBUG_NOTFOUND`` is now ``PYRAMID_DEBUG_NOTFOUND``)
2010-12-18model->resource; make docs render without warningsChris McDonough
2010-12-18resource -> assetChris McDonough
2010-12-16FeaturesChris McDonough
-------- - Added ``debug_routematch`` configuration setting that logs matched routes (including the matchdict and predicates). Documentation ------------- - Added "Debugging Route Matching" section to the urldispatch narrative documentation chapter. - Added reference to ``BFG_DEBUG_ROUTEMATCH`` envvar and ``debug_routematch`` config file setting to the Environment narrative docs chapter.
2010-12-01explain what reload_templates means wrt individual templating enginesChris McDonough
2010-11-28Normalized narrative doc, code with linenos while text+bash don'tBlaise Laflamme
2010-11-28Narrative doc cleanupBlaise Laflamme
2010-11-24- New boolean Mako settings variable ``mako.strict_undefined``. See `MakoChris McDonough
Context Variables <http://www.makotemplates.org/docs/runtime.html#context-variables>`_ for its meaning. - Depend on Mako 0.3.6+ (we now require the ``strict_undefined`` feature).
2010-11-16fix renderingChris McDonough
2010-11-16- Added Mako TemplateLookup settings for ``mako.error_handler``,Ben Bangert
``mako.default_filters``, and ``mako.imports``.
2010-11-09- All references to Pyramid-the-application were changed from :mod:`pyramid`Chris McDonough
to :app:`Pyramid`. A custom role setting was added to ``docs/conf.py`` to allow for this. (internal)
2010-10-31- Renderer factories now accept a *dictionary* rather than an absolute resourceChris McDonough
specification or an absolute path. The dictonary contains the following keys: ``name`` (the ``renderer=`` value), ``package`` (the 'current package' when the renderer configuration statement was found), ``type``: the renderer type, and ``registry``: the current registry. Third-party ``repoze.bfg`` renderer implementations that must be ported to Pyramid will need to account for this. This change was made to support more flexible Mako template rendering.
2010-10-30Adding Mako environment variables.Ben Bangert
2010-10-25convert narrative docs to PyramidChris McDonough
2010-04-25Default locale name.Chris McDonough
2010-04-25Merge i18n branch via svn merge --ignore-ancestry -r9030:9150 ↵Chris McDonough
$REPOZE_SVN/repoze.bfg/branches/i18n No foreigners were harmed in the coding of this feature.
2010-03-23affect/effect were used wrong. See ↵Carlos de la Guardia
http://grammar.quickanddirtytips.com/affect-versus-effect.aspx
2010-01-18Prep for b1Chris McDonough
Merge a bunch of paper-based docs fixes Configure logging during bfgshell.
2010-01-17Section header fixes.Chris McDonough
2010-01-11Merge of andrew-docs branch.Chris McDonough
2009-12-29Overlong lines.Chris McDonough
Fix table.
2009-12-27- Added manual index entries to generated index.Chris McDonough
2009-12-09- Remove explanation of changing the request type in a new requestChris McDonough
event subscriber, as other predicates are now usually an easier way to get this done.
2009-12-09Excise make_app from docs.Chris McDonough
2009-07-05Spellcheck.Chris McDonough
2009-07-02Rendering.Chris McDonough
2009-07-02Allow ``zcml_configure`` value to override the package.Chris McDonough
2009-07-02Document (upcoming) ``configure_zcml`` feature.Chris McDonough
2009-06-30- Add a ``reload_resources`` configuration file setting (aka theChris McDonough
``BFG_RELOAD_RESOURCES`` environment variable). When this is set to true, the server never needs to be restarted when moving files between directory resource overrides (esp. for templates currently). - Add a ``reload_all`` configuration file setting (aka the ``BFG_RELOAD_ALL`` environment variable) that implies both ``reload_resources`` and ``reload_templates``. - The ``static`` helper view class now uses a ``PackageURLParser`` in order to allow for the overriding of static resources (CSS / logo files, etc) using the ``resource`` ZCML directive. The ``PackageURLParser`` class was added to a (new) ``static`` module in BFG; it is a subclass of the ``StaticURLParser`` class in ``paste.urlparser``. - The ``repoze.bfg.templating.renderer_from_cache`` function now checks for the ``reload_resources`` setting; if it's true, it does not register a template renderer (it won't use the registry as a template renderer cache). - Add ``pkg_resources`` to the glossary. - Update the "Environment" docs to note the existence of ``reload_resources`` and ``reload_all``. - Use a colon instead of a tab as the separator between package name and relpath to form the "spec" when register a ITemplateRenderer.
2009-01-22- The ``unicode_path_segments`` configuration variable and theChris McDonough
``BFG_UNICODE_PATH_SEGMENTS`` configuration variable have been removed. Path segments are now always passed to model ``__getitem__`` methods as unicode. "True" has been the default for this setting since 0.5.4, but changing this configuration setting to false allowed you to go back to passing raw path element strings to model ``__getitem__`` methods. This services a speed goal (we get about +80 req/s by removing the check), and it's clearer just to always expect unicode path segments in model ``__getitem__`` methods.
2008-12-17 - In the past, during traversal, the ModelGraphTraverser (theChris McDonough
default traverser) always passed each URL path segment to any ``__getitem__`` method of a model object as a byte string (a ``str`` object). Now, by default the ModelGraphTraverser attempts to decode the path segment to Unicode (a ``unicode`` object) using the UTF-8 encoding before passing it to the ``__getitem__`` method of a model object. This makes it possible for model objects to be dumber in ``__getitem__`` when trying to resolve a subobject, as model objects themselves no longer need to try to divine whether or not to try to decode the path segment passed by the traverser. Note that since 0.5.4, URLs generated by repoze.bfg's ``model_url`` API will contain UTF-8 encoded path segments as necessary, so any URL generated by BFG itself will be decodeable by the traverser. If another application generates URLs to a BFG application, to be resolved successully, it should generate the URL with UTF-8 encoded path segments to be successfully resolved. The decoder is not at all magical: if a non-UTF-8-decodeable path segment (e.g. one encoded using UTF-16 or some other insanity) is passed in the URL, BFG will raise a ``TypeError`` with a message indicating it could not decode the path segment. To turn on the older behavior, where path segments were not decoded to Unicode before being passed to model object ``__getitem__`` by the traverser, and were passed as a raw byte string, set the ``unicode_path_segments`` configuration setting to a false value in your BFG application's section of the paste .ini file, for example:: unicode_path_segments = False Or start the application using the ``BFG_UNICODE_PATH_SEGMENT`` envvar set to a false value:: BFG_UNICODE_PATH_SEGMENTS=0
2008-11-02 FeaturesChris McDonough
- The ``BFG_DEBUG_AUTHORIZATION`` envvar and the ``debug_authorization`` config file value now only imply debugging of view-invoked security checks. Previously, information was printed for every call to ``has_permission`` as well, which made output confusing. To debug ``has_permission`` checks and other manual permission checks, use the debugger and print statements in your own code. - Authorization debugging info is now only present in the HTTP response body oif ``debug_authorization`` is true. - The format of authorization debug messages was improved. - A new ``BFG_DEBUG_NOTFOUND`` envvar was added and a symmetric ``debug_notfound`` config file value was added. When either is true, and a NotFound response is returned by the BFG router (because a view could not be found), debugging information is printed to stderr. When this value is set true, the body of HTTPNotFound responses will also contain the same debugging information. - ``Allowed`` and ``Denied`` responses from the security machinery are now specialized into two types: ACL types, and non-ACL types. The ACL-related responses are instances of ``repoze.bfg.security.ACLAllowed`` and ``repoze.bfg.security.ACLDenied``. The non-ACL-related responses are ``repoze.bfg.security.Allowed`` and ``repoze.bfg.security.Denied``. The allowed-type responses continue to evaluate equal to things that themselves evaluate equal to the ``True`` boolean, while the denied-type responses continue to evaluate equal to things that themselves evaluate equal to the ``False`` boolean. The only difference between the two types is the information attached to them for debugging purposes. - Added a new ``BFG_DEBUG_ALL`` envvar and a symmetric ``debug_all`` config file value. When either is true, all other debug-related flags are set true unconditionally (e.g. ``debug_notfound`` and ``debug_authorization``). Documentation - Added info about debug flag changes. - Added a section to the security chapter named "Debugging Imperative Authorization Failures" (for e.g. ``has_permssion``).