summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial/debugtoolbar.rst
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-04-16 14:07:28 -0700
committerSteve Piercy <web@stevepiercy.com>2016-04-16 14:52:37 -0700
commitd729f7d47b90d47d7e40fd5d1df449582f1c4eca (patch)
tree1ae26e5443801e881009a40169a394a9561bdacb /docs/quick_tutorial/debugtoolbar.rst
parent1eea18ab7f1428ba8ac01a238f03ddbf8483593b (diff)
downloadpyramid-d729f7d47b90d47d7e40fd5d1df449582f1c4eca.tar.gz
pyramid-d729f7d47b90d47d7e40fd5d1df449582f1c4eca.tar.bz2
pyramid-d729f7d47b90d47d7e40fd5d1df449582f1c4eca.zip
Merge pull request #2505 from stevepiercy/docs/quick-tour-gotcher-nose
Docs/quick tour gotcher nose
Diffstat (limited to 'docs/quick_tutorial/debugtoolbar.rst')
-rw-r--r--docs/quick_tutorial/debugtoolbar.rst53
1 files changed, 29 insertions, 24 deletions
diff --git a/docs/quick_tutorial/debugtoolbar.rst b/docs/quick_tutorial/debugtoolbar.rst
index 1f89cd319..aaf904390 100644
--- a/docs/quick_tutorial/debugtoolbar.rst
+++ b/docs/quick_tutorial/debugtoolbar.rst
@@ -6,31 +6,34 @@
Error handling and introspection using the ``pyramid_debugtoolbar`` add-on.
+
Background
==========
-As we introduce the basics we also want to show how to be productive in
-development and debugging. For example, we just discussed template
-reloading and earlier we showed ``--reload`` for application reloading.
+As we introduce the basics, we also want to show how to be productive in
+development and debugging. For example, we just discussed template reloading,
+and earlier we showed ``--reload`` for application reloading.
+
+``pyramid_debugtoolbar`` is a popular Pyramid add-on which makes several tools
+available in your browser. Adding it to your project illustrates several points
+about configuration.
-``pyramid_debugtoolbar`` is a popular Pyramid add-on which makes
-several tools available in your browser. Adding it to your project
-illustrates several points about configuration.
Objectives
==========
-- Install and enable the toolbar to help during development
+- Install and enable the toolbar to help during development.
+
+- Explain Pyramid add-ons.
-- Explain Pyramid add-ons
+- Show how an add-on gets configured into your application.
-- Show how an add-on gets configured into your application
Steps
=====
-#. First we copy the results of the previous step, as well as install
- the ``pyramid_debugtoolbar`` package:
+#. First we copy the results of the previous step, as well as install the
+ ``pyramid_debugtoolbar`` package:
.. code-block:: bash
@@ -54,6 +57,7 @@ Steps
#. Open http://localhost:6543/ in your browser. See the handy
toolbar on the right.
+
Analysis
========
@@ -66,16 +70,16 @@ The ``pyramid_debugtoolbar`` Python package is also a Pyramid add-on, which
means we need to include its add-on configuration into our web application. We
could do this with imperative configuration in ``tutorial/__init__.py`` by
using ``config.include``. Pyramid also supports wiring in add-on configuration
-via our ``development.ini`` using ``pyramid.includes``. We use this to load
-the configuration for the debugtoolbar.
+via our ``development.ini`` using ``pyramid.includes``. We use this to load the
+configuration for the debugtoolbar.
You'll now see an attractive button on the right side of your browser, which
-you may click to provide introspective access to debugging information in a
-new browser tab. Even better, if your web application generates an error, you
-will see a nice traceback on the screen. When you want to disable this
-toolbar, there's no need to change code: you can remove it from
-``pyramid.includes`` in the relevant ``.ini`` configuration file (thus showing
-why configuration files are handy.)
+you may click to provide introspective access to debugging information in a new
+rowser tab. Even better, if your web application generates an error, you will
+see a nice traceback on the screen. When you want to disable this toolbar,
+there's no need to change code: you can remove it from ``pyramid.includes`` in
+the relevant ``.ini`` configuration file (thus showing why configuration files
+are handy).
Note that the toolbar injects a small amount of HTML/CSS into your app just
before the closing ``</body>`` tag in order to display itself. If you start to
@@ -85,13 +89,14 @@ temporarily.
.. seealso:: See also :ref:`pyramid_debugtoolbar <toolbar:overview>`.
+
Extra Credit
============
#. Why don't we add ``pyramid_debugtoolbar`` to the list of
``install_requires`` dependencies in ``debugtoolbar/setup.py``?
-#. Introduce a bug into your application: Change:
+#. Introduce a bug into your application. Change:
.. code-block:: python
@@ -105,7 +110,7 @@ Extra Credit
def hello_world(request):
return xResponse('<body><h1>Hello World!</h1></body>')
- Save, and visit http://localhost:6543/ again. Notice the nice
- traceback display. On the lowest line, click the "screen" icon to the
- right, and try typing the variable names ``request`` and ``Response``.
- What else can you discover?
+ Save, and visit http://localhost:6543/ again. Notice the nice traceback
+ display. On the lowest line, click the "screen" icon to the right, and try
+ typing the variable names ``request`` and ``Response``. What else can you
+ discover?