o wvXj<ã@s¤dZddlmZmZddlmZddlmZddlm Z z ddl m Z m Z Wne y7ddl m Z mZ YnwGdd „d eƒZGd d „d eƒZd d „Zdd„ZdS)a]Sphinx documentation plugin used to document tasks. Introduction ============ Usage ----- The Celery extension for Sphinx requires Sphinx 2.0 or later. Add the extension to your :file:`docs/conf.py` configuration module: .. code-block:: python extensions = (..., 'celery.contrib.sphinx') If you'd like to change the prefix for tasks in reference documentation then you can change the ``celery_task_prefix`` configuration value: .. code-block:: python celery_task_prefix = '(task)' # < default With the extension installed `autodoc` will automatically find task decorated objects (e.g. when using the automodule directive) and generate the correct (as well as add a ``(task)`` prefix), and you can also refer to the tasks using `:task:proj.tasks.add` syntax. Use ``.. autotask::`` to alternatively manually document a task. é)Úabsolute_importÚunicode_literals)Ú PyFunction)ÚFunctionDocumenter)ÚBaseTask)Ú formatargspecÚgetfullargspec)rÚ getargspeccsFeZdZdZdZdZedd„ƒZdd„Zd d d „Z ‡fd d „Z ‡Z S)ÚTaskDocumenterzDocument task definitions.Útaské cCst|tƒo t|dƒS)NÚ __wrapped__©Ú isinstancerÚgetattr)ÚclsÚmemberÚ membernameÚisattrÚparent©rúR/var/www/html/myproject/venv/lib/python3.10/site-packages/celery/contrib/sphinx.pyÚcan_document_member5sz"TaskDocumenter.can_document_membercCs\t|jddƒ}|dur,t|ƒ}|dr |dddvr |dd=t|Ž}| dd¡}|SdS)Nr r)rÚselfú\z\\Ú)rÚobjectrrÚreplace)rÚwrappedÚargspecÚfmtrrrÚ format_args9s  zTaskDocumenter.format_argsFcCsdS©Nr)rÚ all_membersrrrÚdocument_membersDszTaskDocumenter.document_memberscs4t|jddƒ}|rt|dƒ|jkrdStt|ƒ ¡S)Nr Ú __module__T)rrÚmodnameÚsuperr Ú check_module)rr©Ú __class__rrr(GszTaskDocumenter.check_module)F) Ú__name__r%Ú __qualname__Ú__doc__ÚobjtypeÚ member_orderÚ classmethodrr!r$r(Ú __classcell__rrr)rr /s  r c@seZdZdZdd„ZdS)Ú TaskDirectivezSphinx task directive.cCs |jjjSr")ÚenvÚconfigÚcelery_task_prefix)rÚsigrrrÚget_signature_prefixUs z"TaskDirective.get_signature_prefixN)r+r%r,r-r7rrrrr2Rs r2cCs t|tƒrt|dƒr|rdSdS)z&Handler for autodoc-skip-member event.r FNr)ÚappÚwhatÚnameÚobjÚskipÚoptionsrrrÚautodoc_skip_member_handlerYsr>cCsD| d¡| t¡| ddt¡| ddd¡| dt¡ddiS) zSetup Sphinx extension.zsphinx.ext.autodocÚpyr r5z(task)Tzautodoc-skip-memberÚparallel_read_safe)Úsetup_extensionÚadd_autodocumenterr Úadd_directive_to_domainr2Úadd_config_valueÚconnectr>)r8rrrÚsetupfs   ÿrFN)r-Ú __future__rrÚsphinx.domains.pythonrÚsphinx.ext.autodocrÚcelery.app.taskrÚinspectrrÚ ImportErrorr r r2r>rFrrrrÚs    ÿ#