v0.2.3

Fix CBV

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.3.2
+- Overall improvements.
+
+# v0.2.2
+- Show traceback info when background tasks raise exceptions.
+
 # v0.2.1
 - api.requests.
 

README.md

@@ -123,7 +123,7 @@ Boom.
 Install the latest release:
 
 
-    $ pipenv install responder
+    $ pipenv install responder --pre
     ✨🍰✨
 
 

docs/source/index.rst

@@ -105,6 +105,7 @@ User Guides
    quickstart
    tour
    deployment
+   testing
    api
 
 
@@ -113,7 +114,7 @@ Installing Responder
 
 .. code-block:: shell
 
-    $ pipenv install responder
+    $ pipenv install responder --pre
     ✨🍰✨
 
 Only **Python 3.6+** is supported.

docs/source/testing.rst

@@ -0,0 +1,81 @@
+Building and Testing with Responder
+===================================
+
+Responder comes with a first-class, well supported test client for your ASGI web services: **Requests**.
+
+Here, we'll go over the basics of setting up a proper Python package and adding testing to it.
+
+The Basics
+----------
+
+Your repository should look like this::
+
+    Pipfile   Pipfile.lock   api.py  test_api.py
+
+``$ cat api.py``::
+
+    import responder
+
+    api = responder.API()
+
+    @api.route("/")
+    def hello_world(req, resp):
+        resp.text = "hello, world!"
+
+    if __name__ == "__main__":
+        api.run()
+
+
+``$ cat Pipfile``::
+
+    [[source]]
+    url = "https://pypi.org/simple"
+    verify_ssl = true
+    name = "pypi"
+
+    [packages]
+    responder = "*"
+
+    [dev-packages]
+    pytest = "*"
+
+    [requires]
+    python_version = "3.7"
+
+    [pipenv]
+    allow_prereleases = true
+
+Writing Tests
+-------------
+
+``$ cat test_api.py``::
+
+    import pytest
+    import api as service
+
+    @pytest.fixture
+    def api():
+        return service.api
+
+
+    def test_hello_world(api):
+        r = api.requests.get("/")
+        assert r.text == "hello, world!"
+
+``$ pytest``::
+
+    ...
+    ========================== 1 passed in 0.10 seconds ==========================
+
+
+(Optional) Proper Python Package
+--------------------------------
+
+Optionally, you can not rely on relative imports, and instead install your api as a proper package. This requires:
+
+1. A `proper setup.py <https://github.com/kennethreitz/setup.py>`_ file.
+2. ``$ pipenv install -e . --dev``
+
+This will allow you to only specify your dependencies once: in ``setup.py``. ``$ pipenv lock`` will automatically lock your transitive dependencies (e.g. Responder), even if it's not specified in the ``Pipfile``.
+
+This will ensure that your application gets installed in every developer's environment, using Pipenv.

docs/source/tour.rst

@@ -50,23 +50,6 @@ Serve a GraphQL API::
 Visiting the endpoint will render a *GraphiQL* instance, in the browser.
 
 
-Built-in Testing Client (Requests)
-----------------------------------
-
-We can then send a query to our service::
-
-    >>> requests = api.session()
-    >>> r = requests.get("http://;/graph", params={"query": "{ hello }"})
-    >>> r.json()
-    {'data': {'hello': 'Hello stranger'}}
-
-
-Or, request YAML back::
-
-    >>> r = requests.get("http://;/graph", params={"query": "{ hello(name:\"john\") }"}, headers={"Accept": "application/x-yaml"})
-    >>> print(r.text)
-    data: {hello: Hello john}
-
 OpenAPI Schema Support
 ----------------------
 
@@ -174,13 +157,37 @@ You can easily read a Request's session data, that can be trusted to have origin
     >>> req.session
     {'username': 'kennethreitz'}
 
-**Note**: if you are using this in production, you should pass the ``secret_key`` argument to ``API(...)``.
+**Note**: if you are using this in production, you should pass the ``secret_key`` argument to ``API(...)``::
 
+    api = responder.API(secret_key=os.environ['SECRET_KEY'])
+
+Using Requests Test Client
+--------------------------
+
+Responder comes with a first-class, well supported test client for your ASGI web services: **Requests**.
+
+Here's an example of a test (written with pytest)::
+
+    import myapi
+
+    @pytest.fixture
+    def api():
+        return myapi.api
+
+    def test_response(api):
+        hello = "hello, world!"
+
+        @api.route('/some-url')
+        def some_view(req, resp):
+            resp.text = hello
+
+        r = api.requests.get(url=api.url_for(some_view))
+        assert r.text == hello
 
 HSTS (Redirect to HTTPS)
 ------------------------
 
-Want HSTS?
+Want HSTS (to redirect all traffic to HTTPS)?
 
 ::
 

responder/__version__.py

@@ -1 +1 @@
-__version__ = "0.2.1"
+__version__ = "0.2.3"

responder/api.py

@@ -201,7 +201,6 @@ class API:
                 return route
 
     def _prepare_cookies(self, resp):
-        # print(resp.cookies)
         if resp.cookies:
             header = " ".join([f"{k}={v}" for k, v in resp.cookies.items()])
             resp.headers["Set-Cookie"] = header
@@ -230,7 +229,6 @@ class API:
 
         # Create the response object.
         cont = False
-
         if route:
             if not route.uses_websocket:
                 resp = models.Response(req=req, formats=self.formats)
@@ -255,11 +253,11 @@ class API:
                 except Exception:
                     self.default_response(req, resp, error=True)
 
-            if route.is_class_based or cont:
+            elif route.is_class_based or cont:
                 try:
                     view = route.endpoint(**params)
                 except TypeError:
-                    view = route.endpoint
+                    view = route.endpoint()
 
                 # Run on_request first.
                 try:
@@ -292,7 +290,6 @@ class API:
         else:
             resp = models.Response(req=req, formats=self.formats)
             self.default_response(req, resp, notfound=True)
-
         self.default_response(req, resp)
 
         self._prepare_session(resp)
@@ -328,6 +325,7 @@ class API:
         if default:
             self.default_endpoint = endpoint
 
+        # Can we remove it ?
         try:
             if callable(endpoint):
                 endpoint.is_routed = True
@@ -335,7 +333,7 @@ class API:
             pass
 
         self.routes[route] = Route(route, endpoint, websocket=websocket)
-        # TODO: A better datastructer or sort it once the app is loaded
+        # TODO: A better data structure or sort it once the app is loaded
         self.routes = dict(
             sorted(self.routes.items(), key=lambda item: item[1]._weight())
         )
@@ -356,6 +354,7 @@ class API:
 
     def static_response(self, req, resp):
         index = (self.static_dir / "index.html").resolve()
+        resp.content = ""
         if os.path.exists(index):
             with open(index, "r") as f:
                 resp.text = f.read()
@@ -474,7 +473,7 @@ class API:
             elif route_object.endpoint_name == endpoint:
                 return route_object
 
-    def url_for(self, endpoint, testing=False, **params):
+    def url_for(self, endpoint, **params):
         # TODO: Absolute_url
         """Given an endpoint, returns a rendered URL for its route.
 
@@ -483,7 +482,7 @@ class API:
         """
         route_object = self._route_for(endpoint)
         if route_object:
-            return route_object.url(testing=testing, **params)
+            return route_object.url(**params)
         raise ValueError
 
     def static_url(self, asset):

responder/background.py

@@ -1,3 +1,4 @@
+import traceback
 import multiprocessing
 import concurrent.futures
 
@@ -20,8 +21,15 @@ class BackgroundQueue:
         return f
 
     def task(self, f):
+        def on_future_done(fs):
+            try:
+                fs.result()
+            except:
+                traceback.print_exc()
+
         def do_task(*args, **kwargs):
             result = self.run(f, *args, **kwargs)
+            result.add_done_callback(on_future_done)
             return result
 
         return do_task

responder/routes.py

@@ -57,12 +57,8 @@ class Route:
         results = parse(self.route, s)
         return results.named if results else {}
 
-    def url(self, testing=False, **params):
-        url = self.route.format(**params)
-        if testing:
-            url = f"http://;{url}"
-
-        return url
+    def url(self, **params):
+        return self.route.format(**params)
 
     def _weight(self):
         params = set(self._param_pattern.findall(self.route))
@@ -76,9 +72,11 @@ class Route:
     @property
     def is_class_based(self):
         return hasattr(self.endpoint, "__class__")
-
+     
+    @property
     def is_function(self):
+        # TODO: Should we remove is_routed ? 
         routed = hasattr(self.endpoint, "is_routed")
         code = hasattr(self.endpoint, "__code__")
         kwdefaults = hasattr(self.endpoint, "__kwdefaults__")
-        return all((routed, code, kwdefaults))
+        return all((callable(self.endpoint), code, kwdefaults))

tests/test_responder.py

@@ -65,7 +65,7 @@ def test_class_based_view_registration(api):
 def test_class_based_view_parameters(api):
     @api.route("/{greeting}")
     class Greeting:
-        def on_request(req, resp, *, greeting):
+        def on_request(self, req, resp, *, greeting):
             resp.text = f"{greeting}, world!"
 
     assert api.session().get("http://;/Hello").ok