a |f(@sfdZddlZddlZddlZddlmZddlmZGdddeZdd d Z dd d Z dd dZdS)a- Sphinx directive integration ============================ We usually need to document the life-cycle of functions and classes: when they are created, modified or deprecated. To do that, `Sphinx `_ has a set of `Paragraph-level markups `_: - ``versionadded``: to document the version of the project which added the described feature to the library, - ``versionchanged``: to document changes of a feature, - ``deprecated``: to document a deprecated feature. The purpose of this module is to defined decorators which adds this Sphinx directives to the docstring of your function and classes. Of course, the ``@deprecated`` decorator will emit a deprecation warning when the function/method is called or the class is constructed. N)ClassicAdapter) deprecatedcsDeZdZdZdddedffdd ZfddZfd d ZZS) SphinxAdaptera Sphinx adapter -- *for advanced usage only* This adapter override the :class:`~deprecated.classic.ClassicAdapter` in order to add the Sphinx directives to the end of the function/class docstring. Such a directive is a `Paragraph-level markup `_ - The directive can be one of "versionadded", "versionchanged" or "deprecated". - The version number is added if provided. - The reason message is obviously added in the directive block if not empty. NFcs4|s td||_||_tt|j||||ddS)a Construct a wrapper adapter. :type directive: str :param directive: Sphinx directive: can be one of "versionadded", "versionchanged" or "deprecated". :type reason: str :param reason: Reason message which documents the deprecation in your library (can be omitted). :type version: str :param version: Version of your project which deprecates this feature. If you follow the `Semantic Versioning `_, the version number has the format "MAJOR.MINOR.PATCH". :type action: str :param action: A warning filter used to activate or not the deprecation warning. Can be one of "error", "ignore", "always", "default", "module", or "once". If ``None`` or empty, the the global filtering mechanism is used. See: `The Warnings Filter`_ in the Python documentation. :type category: type :param category: The warning category to use for the deprecation warning. By default, the category class is :class:`~DeprecationWarning`, you can inherit this class to define your own deprecation warning category. :type line_length: int :param line_length: Max line length of the directive text. If non nul, a long text is wrapped in several lines. z3'version' argument is required in Sphinx directives)reasonversionactioncategoryN) ValueError directive line_lengthsuperr__init__)selfr rrr r r  __class__KD:\Projects\storyit_web\backend\venv\Lib\site-packages\deprecated/sphinx.pyr,s +zSphinxAdapter.__init__c s4|jr dnd}|j|j|jdg}|jdkr6|jdnd}t|j}|D]0}|rx| tj ||dddqR| dqR|j pd}|jd d pdg}t |d krtd|d d nd}|d |}|rtjdd|tjdd}nd}|ddd|D7}||_ |jdvr$|Stt||S)z Add the Sphinx directive to your class or function. :param wrapped: Wrapped class or function. :return: the decorated class or function. z.. {directive}:: {version}z.. {directive}::)r riz )widthinitial_indentsubsequent_indentrT)keependsNrz\n+$flagsz  css|]}d|VqdS)z{} N)format).0linerrr z)SphinxAdapter.__call__..> versionaddedversionchanged)rrr r textwrapdedentrstrip splitlinesextendfillappend__doc__lenjoinresubDOTALLrr__call__) rwrappedfmtZ div_linesrrZ paragraph docstringlinesrrrr2^s6    (  zSphinxAdapter.__call__cs*tt|||}tjdd|tjd}|S)a Get the deprecation warning message (without Sphinx cross-referencing syntax) for the user. :param wrapped: Wrapped class or function. :param instance: The object to which the wrapped function was bound when it was called. :return: The warning message. .. versionadded:: 1.2.12 Strip Sphinx cross-referencing syntax from warning message. z*(?: : [a-zA-Z]+ )? : [a-zA-Z]+ : (`[^`]*`)z\1r)rrget_deprecated_msgr/r0X)rr3instancemsgrrrr7sz SphinxAdapter.get_deprecated_msg) __name__ __module__ __qualname__r,DeprecationWarningrr2r7 __classcell__rrrrrs2 /rrrcCstd|||d}|S)a2 This decorator can be used to insert a "versionadded" directive in your function/class docstring in order to documents the version of the project which adds this new functionality in your library. :param str reason: Reason message which documents the addition in your library (can be omitted). :param str version: Version of your project which adds this feature. If you follow the `Semantic Versioning `_, the version number has the format "MAJOR.MINOR.PATCH", and, in the case of a new functionality, the "PATCH" component should be "0". :type line_length: int :param line_length: Max line length of the directive text. If non nul, a long text is wrapped in several lines. :return: the decorated function. r#rrr rrrr adapterrrrr#sr#cCstd|||d}|S)a This decorator can be used to insert a "versionchanged" directive in your function/class docstring in order to documents the version of the project which modifies this functionality in your library. :param str reason: Reason message which documents the modification in your library (can be omitted). :param str version: Version of your project which modifies this feature. If you follow the `Semantic Versioning `_, the version number has the format "MAJOR.MINOR.PATCH". :type line_length: int :param line_length: Max line length of the directive text. If non nul, a long text is wrapped in several lines. :return: the decorated function. r$r@rArBrrrr$sr$cKsD|dd}|dt}||d<||d<||d<tf||d|S)ax This decorator can be used to insert a "deprecated" directive in your function/class docstring in order to documents the version of the project which deprecates this functionality in your library. :param str reason: Reason message which documents the deprecation in your library (can be omitted). :param str version: Version of your project which deprecates this feature. If you follow the `Semantic Versioning `_, the version number has the format "MAJOR.MINOR.PATCH". :type line_length: int :param line_length: Max line length of the directive text. If non nul, a long text is wrapped in several lines. Keyword arguments can be: - "action": A warning filter used to activate or not the deprecation warning. Can be one of "error", "ignore", "always", "default", "module", or "once". If ``None``, empty or missing, the the global filtering mechanism is used. - "category": The warning category to use for the deprecation warning. By default, the category class is :class:`~DeprecationWarning`, you can inherit this class to define your own deprecation warning category. :return: a decorator used to deprecate a function. .. versionchanged:: 1.2.13 Change the signature of the decorator to reflect the valid use cases. r r adapter_clsrrr )r rD)popr_classic_deprecated)rrr kwargsr rDrrrrs #  r)rrr)rrr)rrr) r,r/r%ZwraptZdeprecated.classicrrrFrr#r$rrrrs