Ë
    3ýjC  ã                   óˆ   — d Z ddlZddlmZ ddlmZ ddlmZmZ ddl	m
Z
 ddlmZ  G d„ d	e
«      Z G d
„ de«      Zd„ Zd„ Zy)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.

Sphinx 9.0+ Compatibility
-------------------------

Sphinx 9.0 introduced a rewritten autodoc implementation. The Celery
extension requires the legacy class-based autodoc mode to function
correctly. When using Sphinx 9.0 or later, add the following to your
:file:`conf.py`:

.. code-block:: python

    autodoc_use_legacy_class_based = True

The extension will automatically enable this setting if not configured,
but it is recommended to set it explicitly to avoid warnings.
é    N)Ú	signature)Únodes)Ú
PyFunctionÚ
PyXRefRole)ÚFunctionDocumenter)ÚBaseTaskc                   óH   ‡ — e Zd ZdZdZdZed„ «       Zd„ Zdd„Z	ˆ fd„Z
ˆ xZS )	ÚTaskDocumenterzDocument task definitions.Útaské   c                 ó>   — t        |t        «      xr t        |d«      S )NÚ__wrapped__©Ú
isinstancer   Úgetattr)ÚclsÚmemberÚ
membernameÚisattrÚparents        úO/root/telegram-saas/.venv/lib/python3.12/site-packages/celery/contrib/sphinx.pyÚcan_document_memberz"TaskDocumenter.can_document_member@   s   € ä˜&¤(Ó+ÒN´¸ÀÓ0NÐNó    c                 ó  — t        | j                  dd «      }|�ht        |«      }d|j                  v sd|j                  v r6|j	                  t        |j                  j                  «       «      dd  ¬«      }t        |«      S y)Nr   Úselfr   é   )Ú
parametersÚ )r   Úobjectr   r   ÚreplaceÚlistÚvaluesÚstr)r   ÚwrappedÚsigs      r   Úformat_argszTaskDocumenter.format_argsD   sp   € Ü˜$Ÿ+™+ }°dÓ;ˆØÐÜ˜GÓ$ˆCØ˜Ÿ™Ñ'¨5°C·N±NÑ+BØ—k‘k¬T°#·.±.×2GÑ2GÓ2IÓ-JÈ1È2Ð-N�kÓO�Ü�s“8ˆOØr   c                  ó   — y ©N© )r   Úall_memberss     r   Údocument_memberszTaskDocumenter.document_membersM   s   € Ør   c                 ó†   •— t        | j                  dd «      }|rt        |d«      | j                  k(  ryt        ‰| �  «       S )Nr   Ú
__module__T)r   r   ÚmodnameÚsuperÚcheck_module)r   r$   Ú	__class__s     €r   r0   zTaskDocumenter.check_moduleP   s=   ø€ ô
 ˜$Ÿ+™+ }°dÓ;ˆÙ”w˜w¨Ó5¸¿¹ÒEØÜ‰wÑ#Ó%Ð%r   )F)Ú__name__r-   Ú__qualname__Ú__doc__ÚobjtypeÚmember_orderÚclassmethodr   r&   r+   r0   Ú__classcell__)r1   s   @r   r
   r
   :   s8   ø„ Ù$à€GØ€LàñOó ðOòó÷&ð &r   r
   c                   ó   — e Zd ZdZd„ Zy)ÚTaskDirectivezSphinx task directive.c                 ój   — t        j                  | j                  j                  j                  «      gS r(   )r   ÚTextÚenvÚconfigÚcelery_task_prefix)r   r%   s     r   Úget_signature_prefixz"TaskDirective.get_signature_prefix^   s"   € Ü—
‘
˜4Ÿ8™8Ÿ?™?×=Ñ=Ó>Ð?Ð?r   N)r2   r-   r3   r4   r@   r)   r   r   r:   r:   [   s   „ Ù ó@r   r:   c                 óB   — t        |t        «      rt        |d«      r|ryy)z&Handler for autodoc-skip-member event.r   FNr   )ÚappÚwhatÚnameÚobjÚskipÚoptionss         r   Úautodoc_skip_member_handlerrH   b   s    € ô �#”xÔ ¤W¨S°-Ô%@ÙØØr   c                 ó  — ddl }| j                  d«       t        d„ |j                  j	                  d«      dd D «       «      }|dk\  rDt        | j                  dd	«      s-t        j                  d
t        d¬«       d| j                  _
        | j                  t        «       | j                  ddt        «       | j                  ddt!        d¬«      «       | j#                  ddd«       | j%                  dt&        «       ddiS )zSetup Sphinx extension.r   Nzsphinx.ext.autodocc              3   ó2   K  — | ]  }t        |«      –— Œ y ­wr(   )Úint)Ú.0Úxs     r   ú	<genexpr>zsetup.<locals>.<genexpr>w   s   è ø€ ÒM aœ3˜qŸ6ÑMùs   ‚ú.é   )é	   r   Úautodoc_use_legacy_class_basedFzƒSphinx 9.0+ detected. celery.contrib.sphinx requires 'autodoc_use_legacy_class_based = True' in conf.py. Enabling it automatically.)Ú
stacklevelTÚpyr   )Ú
fix_parensr?   z(task)zautodoc-skip-memberÚparallel_read_safe)ÚsphinxÚsetup_extensionÚtupleÚ__version__Úsplitr   r>   ÚwarningsÚwarnÚUserWarningrR   Úadd_autodocumenterr
   Úadd_directive_to_domainr:   Úadd_role_to_domainr   Úadd_config_valueÚconnectrH   )rB   rW   Úsphinx_versions      r   Úsetupre   o   sé   € ãà×ÑÐ,Ô-ô ÑM¨6×+=Ñ+=×+CÑ+CÀCÓ+HÈÈ!Ð+LÔMÓM€NØ˜ÒÜ�s—z‘zÐ#CÀUÔKÜ�M‰Mð-ô Øõð 9=ˆC�J‰JÔ5à×Ñœ>Ô*Ø×Ñ  f¬mÔ<Ø×Ñ˜4 ¬¸tÔ)DÔEØ×ÑÐ-¨x¸Ô>Ø‡K�KÐ%Ô'BÔCð 	˜dðð r   )r4   r\   Úinspectr   Údocutilsr   Úsphinx.domains.pythonr   r   Úsphinx.ext.autodocr   Úcelery.app.taskr   r
   r:   rH   re   r)   r   r   ú<module>rk      sE   ðñ.ó^ Ý å ß 8Ý 1å $ô&Ð'ô &ôB@�Jô @ò
ór   