Deprecate gaiohttp worker and document alternatives

[berkerpeksag]

Fixes #1338

[asvetlov]

Thank you for PR!

[berkerpeksag]

Thanks for the review, @asvetlov. I've just tweaked the docs a bit. @tilgovi can I get a review from you too?

[benoitc]

we should just mark it as deprecated. documentation is already here to point to external asyncio workers. "The 'gaiohttp' worker is deprecated. Please look at "link to worker page" for an alternative worker supporting asyncio."

[kennethreitz]

man, i just started using it this week! :)

[benoitc]

same as above

[benoitc]

idem. just tell it's deprecated.

[benoitc]

i would would reformulate by saying that "The 'gaiohttp' worker is deprecated. Please look at "link to worker page" for an alternative worker supporting asyncio.

[benoitc]

cc @berkerpeksag

[tilgovi]

Looks great. Thanks for doing this. Agree with Benoit that the text doesn't need to suggest aiohttp.worker.GunicornWebWorker in particular, just a link to the docs that discuss the three options.

[kennethreitz]

Excited to get this merged.

[Code0x58]

I think this kind of thing should be using Python's inbuilt warning logging facilities, with a DeprecationWarning. This may be a separarte issue if there are other similar depreciation warnings.

[Code0x58]

I made #1590/#1591 to use warnings in the other two places.

[tilgovi]

Anything else to do here?

[berkerpeksag]

Anything else to do here?

Sorry for my late response. I'm going to address review comments and merge it this weekend.

[berkerpeksag]

Agree with Benoit that the text doesn't need to suggest aiohttp.worker.GunicornWebWorker in particular, just a link to the docs that discuss the three options.

@tilgovi could you be more specific and give a link of that page? Did you mean http://docs.gunicorn.org/en/latest/design.html#async-workers ? I think it would be nice to point out a drop-in replacement in --worker-class documentation.

Here's my diff:

diff --git a/docs/source/run.rst b/docs/source/run.rst
index 516d2ea..4eacb0a 100644
--- a/docs/source/run.rst
+++ b/docs/source/run.rst
@@ -61,7 +61,7 @@ Commonly Used Arguments
   to run. You'll definitely want to read the production page for the
   implications of this parameter. You can set this to ``$(NAME)``
   where ``$(NAME)`` is one of ``sync``, ``eventlet``, ``gevent``,
-  ``tornado``, ``gthread``, ``gaiohttp`` (deprecated in Gunicorn 19.8).
+  ``tornado``, ``gthread``, ``gaiohttp`` (deprecated).
   ``sync`` is the default. See the :ref:`worker-class` documentation for more
   information.
 * ``-n APP_NAME, --name=APP_NAME`` - If setproctitle_ is installed you can
diff --git a/gunicorn/config.py b/gunicorn/config.py
index b74227d..169f10f 100644
--- a/gunicorn/config.py
+++ b/gunicorn/config.py
@@ -624,9 +624,7 @@ class WorkerClass(Setting):
         * ``gevent``   - Requires gevent >= 0.13
         * ``tornado``  - Requires tornado >= 0.2
         * ``gthread``  - Python 2 requires the futures package to be installed
-        * ``gaiohttp`` - Deprecated. Please use
-          ``aiohttp.worker.GunicornWebWorker`` instead. See :ref:`asyncio-workers`
-          for more information on how to use it.
+        * ``gaiohttp`` - Deprecated.
 
         Optionally, you can provide your own worker by giving Gunicorn a
         Python path to a subclass of ``gunicorn.workers.base.Worker``.
diff --git a/gunicorn/workers/gaiohttp.py b/gunicorn/workers/gaiohttp.py
index a5412cc..7d0227a 100644
--- a/gunicorn/workers/gaiohttp.py
+++ b/gunicorn/workers/gaiohttp.py
@@ -19,8 +19,8 @@ if sys.version_info >= (3, 4):
             from gunicorn.workers._gaiohttp import AiohttpWorker
 
         util.warn(
-            "The 'gaiohttp' worker is deprecated. Please install 'aiohttp' "
-            "and pass 'aiohttp.worker.GunicornWebWorker' to --worker-class."
+            "The 'gaiohttp' worker is deprecated. See --worker-class "
+            "documentation for more information."
         )
         __all__ = ['AiohttpWorker']
 else:

[tilgovi]

I think linking to the new docs on AsyncIO from the documentation / usage for --worker-class is great, but I don't mind a direct reference to aiohttp.worker.GunicornWorker in the usage either. Both are fine!