diff options
| author | Steve Piercy <web@stevepiercy.com> | 2015-10-25 00:32:53 -0700 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2015-10-25 00:32:53 -0700 |
| commit | 573b56c177496918ab11e36ac51cf16bec057c80 (patch) | |
| tree | 36551e9c7ab27fc54465920e387a8c1d76cca8b2 /docs/narr/hellotraversal.rst | |
| parent | 5b3f2be3c49407c9aeeadf9eab4d342c3b082442 (diff) | |
| download | pyramid-573b56c177496918ab11e36ac51cf16bec057c80.tar.gz pyramid-573b56c177496918ab11e36ac51cf16bec057c80.tar.bz2 pyramid-573b56c177496918ab11e36ac51cf16bec057c80.zip | |
minor grammar, rewrap 79 columns, some .rst syntax fixes
Diffstat (limited to 'docs/narr/hellotraversal.rst')
| -rw-r--r-- | docs/narr/hellotraversal.rst | 67 |
1 files changed, 31 insertions, 36 deletions
diff --git a/docs/narr/hellotraversal.rst b/docs/narr/hellotraversal.rst index 0a93b8f16..543e2171f 100644 --- a/docs/narr/hellotraversal.rst +++ b/docs/narr/hellotraversal.rst @@ -1,64 +1,60 @@ .. _hello_traversal_chapter: Hello Traversal World -====================== - +===================== .. index:: single: traversal quick example -Traversal is an alternative to URL dispatch which allows Pyramid -applications to map URLs to code. +Traversal is an alternative to URL dispatch which allows Pyramid applications +to map URLs to code. -If code speaks louder than words, maybe this will help. Here is a -single-file Pyramid application that uses traversal: +If code speaks louder than words, maybe this will help. Here is a single-file +Pyramid application that uses traversal: .. literalinclude:: hellotraversal.py :linenos: -You may notice that this application is intentionally very similar to -the "hello world" app from :doc:`firstapp`. +You may notice that this application is intentionally very similar to the +"hello world" application from :doc:`firstapp`. On lines 5-6, we create a trivial :term:`resource` class that's just a dictionary subclass. -On lines 8-9, we hard-code a :term:`resource tree` in our :term:`root -factory` function. +On lines 8-9, we hard-code a :term:`resource tree` in our :term:`root factory` +function. -On lines 11-13 we define a single :term:`view callable` that can -display a single instance of our Resource class, passed as the -``context`` argument. +On lines 11-13, we define a single :term:`view callable` that can display a +single instance of our ``Resource`` class, passed as the ``context`` argument. -The rest of the file sets up and serves our pyramid WSGI app. Line 18 -is where our view gets configured for use whenever the traversal ends -with an instance of our Resource class. +The rest of the file sets up and serves our :app:`Pyramid` WSGI app. Line 18 +is where our view gets configured for use whenever the traversal ends with an +instance of our ``Resource`` class. -Interestingly, there are no URLs explicitly configured in this -application. Instead, the URL space is defined entirely by the keys in -the resource tree. +Interestingly, there are no URLs explicitly configured in this application. +Instead, the URL space is defined entirely by the keys in the resource tree. Example requests ---------------- -If this example is running on http://localhost:8080, and the user -browses to http://localhost:8080/a/b, Pyramid will call -``get_root(request)`` to get the root resource, then traverse the tree -from there by key; starting from the root, it will find the child with -key ``"a"``, then its child with key ``"b"``; then use that as the -``context`` argument for calling ``hello_world_of_resources``. +If this example is running on http://localhost:8080, and the user browses to +http://localhost:8080/a/b, Pyramid will call ``get_root(request)`` to get the +root resource, then traverse the tree from there by key; starting from the +root, it will find the child with key ``"a"``, then its child with key ``"b"``; +then use that as the ``context`` argument for calling +``hello_world_of_resources``. -Or, if the user browses to http://localhost:8080/ , Pyramid will -stop at the root - the outermost Resource instance, in this case - and -use that as the ``context`` argument to the same view. +Or, if the user browses to http://localhost:8080/, Pyramid will stop at the +root—the outermost ``Resource`` instance, in this case—and use that as the +``context`` argument to the same view. -Or, if the user browses to a key that doesn't exist in this resource -tree, like http://localhost:8080/xyz or -http://localhost:8080/a/b/c/d, the traversal will end by raising a -KeyError, and Pyramid will turn that into a 404 HTTP response. +Or, if the user browses to a key that doesn't exist in this resource tree, like +http://localhost:8080/xyz or http://localhost:8080/a/b/c/d, the traversal will +end by raising a KeyError, and Pyramid will turn that into a 404 HTTP response. -A more complicated application could have many types of resources, -with different view callables defined for each type, and even multiple -views for each type. +A more complicated application could have many types of resources, with +different view callables defined for each type, and even multiple views for +each type. .. seealso:: @@ -66,4 +62,3 @@ views for each type. For more about *why* you might use traversal, see :doc:`muchadoabouttraversal`. - |
