Deprecate runner module; remove path_norm

aiohttp now has normalize_path_middleware
sloria · Mar 16, 2017 · 4bfafb0 · 4bfafb0
1 parent 45cca16
commit 4bfafb0
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 312 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,12 @@
 Changelog
 *********
 
+3.0.0 (unreleased)
+==================
+
+- [runner] *Backwards-incompatible*: The `runner` module is deprecated. Install `aiohttp-devtools` and use the `adev runserver` command instead.
+- [path_norm] *Backwards-incompatible*: The `path_norm` module is removed, as it is now available in `aiohttp` in `aiohttp.web_middlewares.normalize_path_middleware`.
+
 2.0.1 (2016-04-03)
 ==================
 

diff --git a/README.rst b/README.rst
@@ -14,9 +14,8 @@ aiohttp_utils
 
 
 * Method-based handlers ("resources")
+* Routing utilities
 * Content negotiation with JSON rendering by default
-* Local development server with auto-reloading
-* And more
 
 **Everything is optional**. You can use as much (or as little) of this toolkit as you need.
 
@@ -46,15 +45,6 @@ aiohttp_utils
         }
     )
 
-    if __name__ == '__main__':
-        # Development server
-        run(
-            app,
-            app_uri='hello.app:app',
-            reload=True,
-            port=8000
-        )
-
 Install
 =======
 ::

diff --git a/aiohttp_utils/path_norm.py b/aiohttp_utils/path_norm.py
diff --git a/aiohttp_utils/runner.py b/aiohttp_utils/runner.py
@@ -14,6 +14,8 @@
 .. warning::
     Auto-reloading functionality is currently **experimental**.
 """
+import warnings
+
 from aiohttp import web
 from aiohttp.worker import GunicornWebWorker as BaseWorker
 from gunicorn.app.wsgiapp import WSGIApplication as BaseApplication
@@ -63,6 +65,9 @@ def __init__(
         reload: bool=None,
         **options
     ):
+        warnings.warn('aiohttp_utils.runner is deprecated. '
+                      'Install aiohttp-devtools and use '
+                      'the "adev runserver" command instead.', DeprecationWarning)
         self.app = app
         self.app_uri = app_uri
         self.host = host

diff --git a/docs/index.rst b/docs/index.rst
@@ -7,9 +7,8 @@ Release v\ |version|. (:ref:`Changelog <changelog>`)
 
 
 * Method-based handlers ("resources")
+* Routing utilities
 * Content negotiation with JSON rendering by default
-* Local development server with auto-reloading
-* And more
 
 **Everything is optional**. You can use as much (or as little) of this toolkit as you need.
 
@@ -39,15 +38,6 @@ Release v\ |version|. (:ref:`Changelog <changelog>`)
         }
     )
 
-    if __name__ == '__main__':
-        # Development server
-        run(
-            app,
-            app_uri='hello.app:app',
-            reload=True,
-            port=8000
-        )
-
 Install
 -------
 ::
@@ -66,9 +56,7 @@ Below are usage guides for each of the modules.
     :maxdepth: 1
 
     modules/negotiation
-    modules/path_norm
     modules/routing
-    modules/runner
 
 Project info
 ------------

diff --git a/examples/kitchen_sink.py b/examples/kitchen_sink.py
@@ -6,9 +6,10 @@
 - path normalization, and
 - local development server with reloading.
 
-Start the app with
+Start the app with the `adev runserver` command from aiohttp-devtools
 ::
-    $ python examples/resources_with_negotiation.py
+    $ pip install aiohttp-devtools
+    $ adev runserver examples/kitchen_sink.py
 
 Try it out:
 ::
@@ -20,7 +21,7 @@
 from asyncio import coroutine
 
 from aiohttp import web
-from aiohttp_utils import Response, routing, negotiation, run, path_norm
+from aiohttp_utils import Response, routing, negotiation
 
 app = web.Application(router=routing.ResourceRouter())
 
@@ -44,12 +45,3 @@ def get(self, request):
     route('/', HelloResource())
 
 negotiation.setup(app)
-path_norm.setup(app)
-
-if __name__ == "__main__":
-    run(
-        app,
-        app_uri="examples.kitchen_sink:app",
-        reload=True,
-        port=8000
-    )
diff --git a/examples/mako_example.py b/examples/mako_example.py
@@ -1,10 +1,10 @@
 """Example of using content negotiation to simultaneously support HTML and JSON representations,
 using Mako for templating. Also demonstrates app configuration.
 
-Start the app with
+Start the app with the `adev runserver` command from aiohttp-devtools
 ::
-    $ pip install mako
-    $ python examples/mako_example.py
+    $ pip install aiohttp-devtools
+    $ adev runserver examples/mako_example.py
 
 Try it out:
 ::
@@ -17,7 +17,7 @@
 from asyncio import coroutine
 
 from aiohttp import web
-from aiohttp_utils import Response, negotiation, run
+from aiohttp_utils import Response, negotiation
 
 from mako.lookup import TemplateLookup
 
@@ -84,11 +84,3 @@ def render_mako(request, data):
 app.update(CONFIG)
 negotiation.setup(app)
 app.router.add_route('GET', '/', index, template='index.html')
-
-if __name__ == "__main__":
-    run(
-        app,
-        app_uri='examples.mako_example:app',
-        reload=True,
-        port=8000,
-    )