v0.0.7, immutable response object

Depend on apispec>=1.0.0b1

CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.0.7
+ - Immutable Request object.
+
+# v0.0.6:
+ - Ability to mount WSGI apps.
+ - Supply content-type when serving up the schema.
+
 # v0.0.5:
  - OpenAPI Schema support.
  - Safe load/dump yaml.

Pipfile

@@ -6,7 +6,6 @@ name = "pypi"
 [packages]
 responder = {editable = true, path = "."}
 
-
 [dev-packages]
 pytest = "*"
 "flake8" = "*"

Pipfile.lock

@@ -37,12 +37,26 @@
             ],
             "version": "==1.0.0b3"
         },
+        "asgiref": {
+            "hashes": [
+                "sha256:9b05dcd41a6a89ca8c6e7f7e4089c3f3e76b5af60aebb81ae6d455ad81989c97",
+                "sha256:b21dc4c43d7aba5a844f4c48b8f49d56277bc34937fd9f9cb93ec97fde7e3082"
+            ],
+            "version": "==2.3.2"
+        },
+        "async-timeout": {
+            "hashes": [
+                "sha256:0c3c816a028d47f659d6ff5c745cb2acf1f966da1fe5c19c77a70282b25f4c5f",
+                "sha256:4291ca197d287d274d0b6cb5d6f8f8f82d434ed288f962539ff18cc9012f9ea3"
+            ],
+            "version": "==3.0.1"
+        },
         "certifi": {
             "hashes": [
-                "sha256:376690d6f16d32f9d1fe8932551d80b23e9d393a8578c5633a2ed39a64861638",
-                "sha256:456048c7e371c089d0a77a5212fb37a2c2dce1e24146e3b7e0261736aaeaa22a"
+                "sha256:339dc09518b07e2fa7eda5450740925974815557727d6bd35d319c1524a04a4c",
+                "sha256:6d58c986d22b038c8c0df30d639f23a3e6d172a05c3583e766f4c0b785c0986a"
             ],
-            "version": "==2018.8.24"
+            "version": "==2018.10.15"
         },
         "chardet": {
             "hashes": [
@@ -111,6 +125,13 @@
             ],
             "version": "==1.0"
         },
+        "marshmallow": {
+            "hashes": [
+                "sha256:82b201ad767eb54de371c08cb1db6ca4ad2a728fa41b831e3781bf944815eb38",
+                "sha256:c250f37ac0e249a8287394a60d91f6240b674642ad999e66cd09463dbccd1d4f"
+            ],
+            "version": "==3.0.0b18"
+        },
         "parse": {
             "hashes": [
                 "sha256:9dd6048ea212cd032a342f9f6aa2b7bc222f7407c7e37bdc2777fecd36897437"
@@ -271,10 +292,10 @@
         },
         "certifi": {
             "hashes": [
-                "sha256:376690d6f16d32f9d1fe8932551d80b23e9d393a8578c5633a2ed39a64861638",
-                "sha256:456048c7e371c089d0a77a5212fb37a2c2dce1e24146e3b7e0261736aaeaa22a"
+                "sha256:339dc09518b07e2fa7eda5450740925974815557727d6bd35d319c1524a04a4c",
+                "sha256:6d58c986d22b038c8c0df30d639f23a3e6d172a05c3583e766f4c0b785c0986a"
             ],
-            "version": "==2018.8.24"
+            "version": "==2018.10.15"
         },
         "cffi": {
             "hashes": [
@@ -433,11 +454,10 @@
         },
         "marshmallow": {
             "hashes": [
-                "sha256:1ca4820515332fe61cd83551afd791dd0ee16fc70cf57883f6735e5b1d9d50ed",
-                "sha256:e076fae11bcdd6ee94b2c78d670c2ca35583dd97cc5f1d646b851c9f53368f0a"
+                "sha256:82b201ad767eb54de371c08cb1db6ca4ad2a728fa41b831e3781bf944815eb38",
+                "sha256:c250f37ac0e249a8287394a60d91f6240b674642ad999e66cd09463dbccd1d4f"
             ],
-            "index": "pypi",
-            "version": "==3.0.0b17"
+            "version": "==3.0.0b18"
         },
         "mccabe": {
             "hashes": [
@@ -590,10 +610,10 @@
         },
         "tqdm": {
             "hashes": [
-                "sha256:18f1818ce951aeb9ea162ae1098b43f583f7d057b34d706f66939353d1208889",
-                "sha256:df02c0650160986bac0218bb07952245fc6960d23654648b5d5526ad5a4128c9"
+                "sha256:a0be569511161220ff709a5b60d0890d47921f746f1c737a11d965e1b29e7b2e",
+                "sha256:e293e6d7a7f41a529a27f8d6624ab11544ccbfe82a205af6fad102545099fc21"
             ],
-            "version": "==4.26.0"
+            "version": "==4.27.0"
         },
         "twine": {
             "hashes": [

README.md

@@ -6,7 +6,6 @@
 [![image](https://img.shields.io/pypi/l/responder.svg)](https://pypi.org/project/responder/)
 [![image](https://img.shields.io/pypi/pyversions/responder.svg)](https://pypi.org/project/responder/)
 [![image](https://img.shields.io/github/contributors/kennethreitz/responder.svg)](https://github.com/kennethreitz/responder/graphs/contributors)
-[![image](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/kennethreitz)
 
 [![](https://github.com/kennethreitz/responder/raw/master/ext/small.jpg)](http://python-responder.org/)
 
@@ -25,7 +24,7 @@ if __name__ == '__main__':
     api.run()
 ```
 
-That `async` declaration is optional.
+That `async` declaration is optional. [View documentation](http://python-responder.org).
 
 This gets you a ASGI app, with a production static files server pre-installed, jinja2 templating (without additional imports), and a production webserver based on uvloop, serving up requests with gzip compression automatically.
 
@@ -34,15 +33,12 @@ This gets you a ASGI app, with a production static files server pre-installed, j
 
 > "Pleasantly very taken with python-responder. [@kennethreitz](https://twitter.com/kennethreitz) at his absolute best." —Rudraksh M.K.
 
-> "Buckle up!" —Tom Christie of [APIStar](https://github.com/encode/apistar) and [Django REST Framework](https://www.django-rest-framework.org/)
+> "ASGI is going to enable all sorts of new high-performance web services. It's awesome to see Responder starting to take advantage of that." — Tom Christie author of [Django REST Framework](https://www.django-rest-framework.org/)
 
 > "I love that you are exploring new patterns. Go go go!" — Danny Greenfield, author of [Two Scoops of Django]()
 
 > "Love what I have seen while it's in progress! Many features of Responder are from my wishlist for Flask, and it's even faster and even easier than Flask!" — Luna C.
 
-> "The most ambitious crossover event in history." —Pablo Cabezas, [on Tom Christie joining the project](https://twitter.com/pabloteleco/status/1050841098321620992?s=20)
-
-
 ## More Examples
 
 Class-based views (and setting some headers and stuff):

docs/source/index.rst

@@ -44,6 +44,18 @@ pre-installed, jinja2 templating (without additional imports), and a
 production webserver based on uvloop, serving up requests with gzip
 compression automatically.
 
+Features
+--------
+
+- A pleasant API, with a single import statement.
+- Class-based views without inheritence.
+- ASGI framework, the future of Python web services.
+- The ability to mount any ASGI / WSGI app at a subroute.
+- *f-string syntax* route declration.
+- Mutable response object, passed into each view. No need to return anything.
+- Background tasks, spawned off in a ``ThreadPoolExecutor``.
+- GraphQL support!
+
 Testimonials
 ------------
 
@@ -57,9 +69,9 @@ Testimonials
 
 ..
 
-   “Buckle up!”
+   "ASGI is going to enable all sorts of new high-performance web services. It's awesome to see Responder starting to take advantage of that."
 
-    —Tom Christie of `APIStar`_ and `Django REST Framework`_
+    —Tom Christie, author of `Django REST Framework`_
 
 ..
 

docs/source/tour.rst

@@ -68,7 +68,7 @@ Or, request YAML back::
 OpenAPI Schema Support
 ----------------------
 
-Responder comes with built-in support for OpenAPI::
+Responder comes with built-in support for OpenAPI / marshmallow::
 
     import responder
     from marshmallow import Schema, fields
@@ -118,6 +118,26 @@ Responder comes with built-in support for OpenAPI::
             200: {description: A pet to be returned, schema: $ref = "#/components/schemas/Pet"}
     tags: []
 
+
+Mount a WSGI App (e.g. Flask)
+-----------------------------
+
+Responder gives you the ability to mount another ASGI / WSGI app at a subroute::
+
+    import responder
+    from flask import Flask
+
+    api = responder.API()
+    flask = Flask(__name__)
+
+    @flask.route('/')
+    def hello():
+        return 'hello'
+
+    api.mount('/flask', flask)
+
+That's it!
+
 HSTS (Redirect to HTTPS)
 ------------------------
 

responder/__version__.py

@@ -1 +1 @@
-__version__ = "0.0.5"
+__version__ = "0.0.7"

responder/api.py

@@ -14,6 +14,7 @@ from starlette.testclient import TestClient
 from apispec import APISpec
 from apispec.ext.marshmallow import MarshmallowPlugin
 from apispec import yaml_utils
+from asgiref.wsgi import WsgiToAsgi
 
 from . import models
 from . import status_codes
@@ -104,7 +105,11 @@ class API:
             if path.startswith(path_prefix):
                 scope["path"] = path[len(path_prefix) :]
                 scope["root_path"] = root_path + path_prefix
-                return app(scope)
+                try:
+                    return app(scope)
+                except TypeError:
+                    app = WsgiToAsgi(app)
+                    return app(scope)
 
         # Call the main dispatcher.
         async def asgi(receive, send):
@@ -227,6 +232,7 @@ class API:
 
     def schema_response(self, req, resp):
         resp.status_code = status_codes.HTTP_200
+        resp.headers["Content-Type"] = "application/x-yaml"
         resp.content = self.openapi
 
     def redirect(
@@ -298,16 +304,16 @@ class API:
 
         return decorator
 
-    def mount(self, route, asgi_app):
-        """Mounts a WSGI application at a given route.
+    def mount(self, route, app):
+        """Mounts an WSGI / ASGI application at a given route.
 
         :param route: String representation of the route to be used (shouldn't be parameterized).
-        :param wsgi_app: The other WSGI app (e.g. a Flask app).
+        :param app: The other WSGI / ASGI app.
         """
-        self.apps.update({route: asgi_app})
+        self.apps.update({route: app})
 
     def session(self, base_url="http://;"):
-        """Testing HTTP client. Returns a Requests session object, able to send HTTP requests to the WSGI application.
+        """Testing HTTP client. Returns a Requests session object, able to send HTTP requests to the Responder application.
 
         :param base_url: The URL to mount the connection adaptor to.
         """

responder/models.py

@@ -91,12 +91,7 @@ class Request:
     __slots__ = [
         "_starlette",
         "formats",
-        "headers",
-        "mimetype",
-        "method",
-        "full_url",
-        "url",
-        "params",
+        "_headers",
         "_encoding",
     ]
 
@@ -109,27 +104,39 @@ class Request:
         for header, value in self._starlette.headers.items():
             headers[header] = value
 
-        self.headers = (
-            headers
-        )  #: A case-insensitive dictionary, containing all headers sent in the Request.
+        self._headers = headers
 
-        self.mimetype = self.headers.get("Content-Type", "")
+    @property
+    def headers(self):
+        """A case-insensitive dictionary, containing all headers sent in the Request."""
+        return self._headers
 
-        self.method = (
-            self._starlette.method.lower()
-        )  #: The incoming HTTP method used for the request, lower-cased.
+    @property
+    def mimetype(self):
+        return self.headers.get("Content-Type", "")
 
-        self.full_url = str(
-            self._starlette.url
-        )  #: The full URL of the Request, query parameters and all.
+    @property
+    def method(self):
+        """The incoming HTTP method used for the request, lower-cased."""
+        return self._starlette.method.lower()
 
-        self.url = rfc3986.urlparse(self.full_url)  #: The parsed URL of the Request
+    @property
+    def full_url(self):
+        """The full URL of the Request, query parameters and all."""
+        return str(self._starlette.url)
+
+    @property
+    def url(self):
+        """The parsed URL of the Request."""
+        return rfc3986.urlparse(self.full_url)
+
+    @property
+    def params(self):
+        """A dictionary of the parsed query parameters used for the Request."""
         try:
-            self.params = QueryDict(
-                self.url.query
-            )  #: A dictionary of the parsed query parameters used for the Request.
+            return QueryDict(self.url.query)
         except AttributeError:
-            self.params = {}
+            return QueryDict({})
 
     @property
     async def encoding(self):

setup.py

@@ -35,8 +35,9 @@ required = [
     "rfc3986",
     "python-multipart",
     "chardet",
-    "apispec",
+    "apispec>=1.0.0b1",
     "marshmallow",
+    "asgiref",
 ]
 
 

tests/test_responder.py

@@ -321,3 +321,14 @@ def test_schema_generation():
 
     assert dump
     assert dump["openapi"] == "3.0"
+
+
+def test_mount_wsgi_app(api, flask, session):
+    @api.route("/")
+    def hello(req, resp):
+        resp.text = "hello"
+
+    api.mount("/flask", flask)
+
+    r = session.get("http://;/flask")
+    assert r.ok