Browse Source

Added missing autodoc pages. paver releaseok now passes

Ask Solem 14 years ago
parent
commit
5156e1b948

+ 1 - 1
Changelog

@@ -13,7 +13,7 @@
 :status: in-progress
 :status: in-progress
 :branch: master
 :branch: master
 
 
-.. _v210-important:
+.. _v220-important:
 
 
 Important Notes
 Important Notes
 ---------------
 ---------------

+ 7 - 5
celery/concurrency/evg.py

@@ -1,3 +1,10 @@
+import os
+
+from gevent import monkey
+
+if not os.environ.get("GEVENT_NOPATCH"):
+    monkey.patch_all()
+
 from gevent import Greenlet
 from gevent import Greenlet
 from gevent.pool import Pool
 from gevent.pool import Pool
 
 
@@ -24,8 +31,3 @@ class TaskPool(BasePool):
     def blocking(self, fun, *args, **kwargs):
     def blocking(self, fun, *args, **kwargs):
         Greenlet.spawn(fun, *args, **kwargs).get()
         Greenlet.spawn(fun, *args, **kwargs).get()
 
 
-    @classmethod
-    def on_import(cls):
-        from gevent import monkey
-        monkey.patch_all()
-TaskPool.on_import()

+ 5 - 2
celery/concurrency/evlet.py

@@ -1,11 +1,14 @@
+import os
 import sys
 import sys
 
 
 from time import time
 from time import time
 
 
 import eventlet
 import eventlet
 import eventlet.debug
 import eventlet.debug
-eventlet.monkey_patch()
-eventlet.debug.hub_prevent_multiple_readers(False)
+
+if not os.environ.get("EVENTLET_NOPATCH"):
+    eventlet.monkey_patch()
+    eventlet.debug.hub_prevent_multiple_readers(False)
 
 
 from eventlet import GreenPool
 from eventlet import GreenPool
 from eventlet.greenthread import spawn, spawn_after_local
 from eventlet.greenthread import spawn, spawn_after_local

+ 2 - 0
celery/tests/__init__.py

@@ -7,6 +7,8 @@ config = os.environ.setdefault("CELERY_TEST_CONFIG_MODULE",
 
 
 os.environ["CELERY_CONFIG_MODULE"] = config
 os.environ["CELERY_CONFIG_MODULE"] = config
 os.environ["CELERY_LOADER"] = "default"
 os.environ["CELERY_LOADER"] = "default"
+os.environ["EVENTLET_NOPATCH"] = "yes"
+os.environ["GEVENT_NOPATCH"] = "yes"
 
 
 
 
 def teardown():
 def teardown():

+ 1 - 1
contrib/release/doc4allmods

@@ -8,7 +8,7 @@ SKIP_FILES="celery.bin.rst
             celery.contrib.batches.rst
             celery.contrib.batches.rst
             celery.task.schedules.rst
             celery.task.schedules.rst
             celery.models.rst
             celery.models.rst
-            celery.concurrency.rst
+            celery.app.base.rst
             celery.apps.rst
             celery.apps.rst
             celery.db.rst
             celery.db.rst
             celery.db.a805d4bd.rst
             celery.db.a805d4bd.rst

+ 1 - 1
contrib/release/flakesignore.txt

@@ -30,4 +30,4 @@ celery/utils/functional.py:(.+?) redefinition of unused 'update_wrapper'
 celery/utils/functional.py:(.+?) redefinition of unused 'wraps'
 celery/utils/functional.py:(.+?) redefinition of unused 'wraps'
 celery/utils/mail.py:(.+?) redefinition of unused 'MIMEText'
 celery/utils/mail.py:(.+?) redefinition of unused 'MIMEText'
 celery/utils/__init__.py:(.+?) 'gen_unique_id' imported but unused
 celery/utils/__init__.py:(.+?) 'gen_unique_id' imported but unused
-
+celery/events/cursesmon.py:(.+?): local variable 'consumer' is assigned to but never used

+ 4 - 0
docs/conf.py

@@ -3,6 +3,10 @@
 import sys
 import sys
 import os
 import os
 
 
+# eventlet/gevent should not monkey patch anything.
+os.environ["GEVENT_NOPATCH"] = "yes"
+os.environ["EVENTLET_NOPATCH"] = "yes"
+
 this = os.path.dirname(os.path.abspath(__file__))
 this = os.path.dirname(os.path.abspath(__file__))
 
 
 # If your extensions are in another directory, add it here. If the directory
 # If your extensions are in another directory, add it here. If the directory

+ 11 - 0
docs/internals/reference/celery.concurrency.base.rst

@@ -0,0 +1,11 @@
+===============================================
+ Base Pool Interface - celery.concurrency.base
+===============================================
+
+.. contents::
+    :local:
+.. currentmodule:: celery.concurrency.base
+
+.. automodule:: celery.concurrency.base
+    :members:
+    :undoc-members:

+ 11 - 0
docs/internals/reference/celery.concurrency.evg.rst

@@ -0,0 +1,11 @@
+=============================================================
+ gevent Pool Support - celery.concurrency.evg
+=============================================================
+
+.. contents::
+    :local:
+.. currentmodule:: celery.concurrency.evg
+
+.. automodule:: celery.concurrency.evg
+    :members:
+    :undoc-members:

+ 11 - 0
docs/internals/reference/celery.concurrency.evlet.rst

@@ -0,0 +1,11 @@
+=============================================================
+ Eventlet Pool Support - celery.concurrency.evlet
+=============================================================
+
+.. contents::
+    :local:
+.. currentmodule:: celery.concurrency.evlet
+
+.. automodule:: celery.concurrency.evlet
+    :members:
+    :undoc-members:

+ 11 - 0
docs/internals/reference/celery.concurrency.rst

@@ -0,0 +1,11 @@
+==================================
+ Concurrency - celery.concurrency
+==================================
+
+.. contents::
+    :local:
+.. currentmodule:: celery.concurrency
+
+.. automodule:: celery.concurrency
+    :members:
+    :undoc-members:

+ 4 - 0
docs/internals/reference/index.rst

@@ -18,8 +18,12 @@
     celery.worker.control.builtins
     celery.worker.control.builtins
     celery.worker.control.registry
     celery.worker.control.registry
     celery.worker.state
     celery.worker.state
+    celery.concurrency
     celery.concurrency.processes
     celery.concurrency.processes
     celery.concurrency.processes.pool
     celery.concurrency.processes.pool
+    celery.concurrency.evlet
+    celery.concurrency.evg
+    celery.concurrency.base
     celery.concurrency.threads
     celery.concurrency.threads
     celery.beat
     celery.beat
     celery.backends
     celery.backends

+ 58 - 0
docs/reference/celery.app.amqp.rst

@@ -0,0 +1,58 @@
+.. currentmodule:: celery.app.amqp
+
+.. automodule:: celery.app.amqp
+
+    .. contents::
+        :local:
+
+    AMQP
+    ----
+
+    .. autoclass:: AMQP
+
+        .. attribute:: BrokerConnection
+
+            Broker connection class used.  Default is
+            :class:`kombu.connection.BrokerConnection`.
+
+        .. attribute:: Consumer
+
+            The task consumer class used.
+            Default is :class:`kombu.compat.Consumer`.
+
+        .. attribute:: queues
+
+            All currently defined task queues. (A :class:`Queues` instance).
+
+        .. automethod:: ConsumerSet
+        .. automethod:: Queues
+        .. automethod:: Router
+        .. automethod:: TaskConsumer
+        .. automethod:: TaskPublisher
+
+        .. automethod:: get_task_consumer
+        .. automethod:: get_default_queue
+        .. automethod:: get_broker_info
+        .. automethod:: format_broker_info
+
+    Queues
+    ------
+
+    .. autoclass:: Queues
+
+        .. automethod:: add
+
+        .. automethod:: options
+
+        .. automethod:: format
+
+        .. automethod:: select_subset
+
+        .. automethod:: with_defaults
+
+    TaskPublisher
+    -------------
+
+    .. autoclass:: TaskPublisher
+        :members:
+        :undoc-members:

+ 11 - 0
docs/reference/celery.app.defaults.rst

@@ -0,0 +1,11 @@
+===============================================================
+ Default configuration and introspection - celery.app.defaults
+===============================================================
+
+.. contents::
+    :local:
+.. currentmodule:: celery.app.defaults
+
+.. automodule:: celery.app.defaults
+    :members:
+    :undoc-members:

+ 11 - 0
docs/reference/celery.loaders.app.rst

@@ -0,0 +1,11 @@
+=================================
+ App Loader - celery.loaders.app
+=================================
+
+.. contents::
+    :local:
+.. currentmodule:: celery.loaders.app
+
+.. automodule:: celery.loaders.app
+    :members:
+    :undoc-members:

+ 4 - 1
docs/reference/index.rst

@@ -9,6 +9,8 @@
     :maxdepth: 2
     :maxdepth: 2
 
 
     celery.app
     celery.app
+    celery.app.amqp
+    celery.app.defaults
     celery.decorators
     celery.decorators
     celery.task.base
     celery.task.base
     celery.task.sets
     celery.task.sets
@@ -23,8 +25,9 @@
     celery.exceptions
     celery.exceptions
     celery.task.builtins
     celery.task.builtins
     celery.loaders
     celery.loaders
-    celery.loaders.base
+    celery.loaders.app
     celery.loaders.default
     celery.loaders.default
+    celery.loaders.base
     celery.registry
     celery.registry
     celery.states
     celery.states
     celery.messaging
     celery.messaging

+ 1 - 1
docs/userguide/periodic-tasks.rst

@@ -123,7 +123,7 @@ The syntax of these crontab expressions are very flexible.  Some examples:
 +-------------------------------------+--------------------------------------------+
 +-------------------------------------+--------------------------------------------+
 | crontab(minute=0, hour=0)           | Execute daily at midnight.                 |
 | crontab(minute=0, hour=0)           | Execute daily at midnight.                 |
 +-------------------------------------+--------------------------------------------+
 +-------------------------------------+--------------------------------------------+
-| crontab(minute=0, hour="*/3")       | Execute every three hours:                 |
+| crontab(minute=0, hour="\*/3")      | Execute every three hours:                 |
 |                                     | 3am, 6am, 9am, noon, 3pm, 6pm, 9pm.        |
 |                                     | 3am, 6am, 9am, noon, 3pm, 6pm, 9pm.        |
 +-------------------------------------+--------------------------------------------+
 +-------------------------------------+--------------------------------------------+
 | crontab(minute=0,                   | Same as previous.                          |
 | crontab(minute=0,                   | Same as previous.                          |

+ 0 - 3
pavement.py

@@ -69,9 +69,6 @@ def verifyindex(options):
 
 
 
 
 @task
 @task
-@cmdopts([
-    ("noerror", "E", "Ignore errors"),
-])
 def flakes(options):
 def flakes(options):
     noerror = getattr(options, "noerror", False)
     noerror = getattr(options, "noerror", False)
     sh("""find celery -name '*.py' | xargs pyflakes | perl -mstrict -nle'
     sh("""find celery -name '*.py' | xargs pyflakes | perl -mstrict -nle'