summaryrefslogtreecommitdiff
path: root/docs/narr/firstapp.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2010-11-02 03:35:17 -0400
committerChris McDonough <chrism@plope.com>2010-11-02 03:35:17 -0400
commit94b88987fd4f742538ccf43f5789e9c6463bca0e (patch)
tree7fcd2c8bc79c36da71b8f580d036fc834d2ffa3f /docs/narr/firstapp.rst
parent8129f9ea73ac1c1fcacc3e9ccdd42a12994e7255 (diff)
downloadpyramid-94b88987fd4f742538ccf43f5789e9c6463bca0e.tar.gz
pyramid-94b88987fd4f742538ccf43f5789e9c6463bca0e.tar.bz2
pyramid-94b88987fd4f742538ccf43f5789e9c6463bca0e.zip
- Remove references to 'WebOb' Response and just call it 'Response', and note
that it is imported from pyramid. API docs can mention its inheritance from webob (aka "Provide a webob.Response class facade for forward compat").
Diffstat (limited to 'docs/narr/firstapp.rst')
-rw-r--r--docs/narr/firstapp.rst52
1 files changed, 24 insertions, 28 deletions
diff --git a/docs/narr/firstapp.rst b/docs/narr/firstapp.rst
index 16410d07f..71219689d 100644
--- a/docs/narr/firstapp.rst
+++ b/docs/narr/firstapp.rst
@@ -26,9 +26,9 @@ configured imperatively:
.. code-block:: python
:linenos:
- from webob import Response
- from paste.httpserver import serve
from pyramid.configuration import Configurator
+ from pyramid.response import Response
+ from paste.httpserver import serve
def hello_world(request):
return Response('Hello world!')
@@ -64,26 +64,23 @@ The above script defines the following set of imports:
.. code-block:: python
:linenos:
- from webob import Response
- from paste.httpserver import serve
from pyramid.configuration import Configurator
+ from pyramid.response import Response
+ from paste.httpserver import serve
-:mod:`pyramid` uses the :term:`WebOb` library as the basis for its
-:term:`request` and :term:`response` objects. The script uses the
-:class:`webob.Response` class later in the script to create a
-:term:`response` object.
+The script imports the ``Configurator`` class from the
+``pyramid.configuration`` module. This class is used to configure
+:mod:`pyramid` for a particular application. An instance of this class
+provides methods which help configure various parts of :mod:`pyramid` for a
+given application deployment.
-Like many other Python web frameworks, :mod:`pyramid` uses the
-:term:`WSGI` protocol to connect an application and a web server
-together. The :mod:`paste.httpserver` server is used in this example
-as a WSGI server for convenience, as the ``paste`` package is a
-dependency of :mod:`pyramid` itself.
+The script uses the :class:`pyramid.response.Response` class later in the
+script to create a :term:`response` object.
-The script also imports the ``Configurator`` class from the
-``pyramid.configuration`` module. This class is used to configure
-:mod:`pyramid` for a particular application. An instance of this
-class provides methods which help configure various parts of
-:mod:`pyramid` for a given application deployment.
+Like many other Python web frameworks, :mod:`pyramid` uses the :term:`WSGI`
+protocol to connect an application and a web server together. The
+:mod:`paste.httpserver` server is used in this example as a WSGI server for
+convenience, as the ``paste`` package is a dependency of :mod:`pyramid` itself.
View Callable Declarations
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -117,14 +114,13 @@ A view callable is always called with a :term:`request` object. A
request object is a representation of an HTTP request sent to
:mod:`pyramid` via the active :term:`WSGI` server.
-A view callable is required to return a :term:`response` object
-because a response object has all the information necessary to
-formulate an actual HTTP response; this object is then converted to
-text by the upstream :term:`WSGI` server and sent back to the
-requesting browser. To return a response, each view callable creates
-an instance of the :class:`webob.Response` class. In the
-``hello_world`` function, the string ``'Hello world!'`` is passed to
-the ``Response`` constructor as the *body* of the response. In the
+A view callable is required to return a :term:`response` object because a
+response object has all the information necessary to formulate an actual HTTP
+response; this object is then converted to text by the upstream :term:`WSGI`
+server and sent back to the requesting browser. To return a response, each
+view callable creates an instance of the :class:`pyramid.response.Response`
+class. In the ``hello_world`` function, the string ``'Hello world!'`` is
+passed to the ``Response`` constructor as the *body* of the response. In the
``goodbye_world`` function, the string ``'Goodbye world!'`` is passed.
.. index::
@@ -385,9 +381,9 @@ To do so, first, create a file named ``helloworld.py``:
.. code-block:: python
:linenos:
- from webob import Response
- from paste.httpserver import serve
from pyramid.configuration import Configurator
+ from pyramid.response import Response
+ from paste.httpserver import serve
def hello_world(request):
return Response('Hello world!')