OwlCyberSecurity - MANAGER
Edit File: docstring.cpython-38.pyc
U ��]� � @ s� d dl Z d dlmZ G dd� de�Ze�d�G dd� de��Zejddd �d d � �Zd d � Ze� Z dd� Z ejddd �dd� �Z dS )� N)�cbookc @ s4 e Zd ZdZdd� Zdd� Zdd� Zedd � �Zd S ) � SubstitutionaG A decorator that performs %-substitution on an object's docstring. This decorator should be robust even if ``obj.__doc__`` is None (for example, if -OO was passed to the interpreter). Usage: construct a docstring.Substitution with a sequence or dictionary suitable for performing substitution; then decorate a suitable function with the constructed object, e.g.:: sub_author_name = Substitution(author='Jason') @sub_author_name def some_function(x): "%(author)s wrote this function" # note that some_function.__doc__ is now "Jason wrote this function" One can also use positional arguments:: sub_first_last_names = Substitution('Edgar Allen', 'Poe') @sub_first_last_names def some_function(x): "%s %s wrote the Raven" c O s |r|rt d��|p|| _d S )Nz+Only positional or keyword args are allowed)� TypeError�params��self�args�kwargs� r �6/usr/lib/python3/dist-packages/matplotlib/docstring.py�__init__! s zSubstitution.__init__c C s |j r| j | j; _ |S �N)�__doc__r )r �funcr r r �__call__& s zSubstitution.__call__c O s | j j||� dS )zW Update ``self.params`` (which must be a dict) with the supplied args. N)r �updater r r r r + s zSubstitution.updatec C s | � }||_ |S )a( In the case where the params is a mutable sequence (list or dictionary) and it may change before this class is called, one may explicitly use a reference to the params rather than using *args or **kwargs which will copy the values and not reference them. )r )�clsr �resultr r r � from_params1 s zSubstitution.from_paramsN) �__name__� __module__� __qualname__r r r r � classmethodr r r r r r s r z3.1c @ s" e Zd ZdZddd�Zdd� ZdS ) �Appenderaf A function decorator that will append an addendum to the docstring of the target function. This decorator should be robust even if func.__doc__ is None (for example, if -OO was passed to the interpreter). Usage: construct a docstring.Appender with a string to be joined to the original docstring. An optional 'join' parameter may be supplied which will be used to join the docstring and addendum. e.g. add_copyright = Appender("Copyright (c) 2009", join=' ') @add_copyright def my_dog(has='fleas'): "This docstring will have a copyright below" pass � c C s || _ || _d S r )�addendum�join)r r r r r r r R s zAppender.__init__c C s$ |j | jg}|j o | j�|�|_ |S r )r r r )r r Zdocitemsr r r r V s zAppender.__call__N)r )r r r r r r r r r r r > s r zinspect.getdoc())Z alternativec C s | j ot�| j �| _ | S )z Dedent a docstring (if present))r r �dedent�r r r r r \ s r c s � fdd�}|S )z:Copy a docstring from another source function (if present)c s � j r� j | _ | S r )r ��target��sourcer r �do_copye s zcopy.<locals>.do_copyr )r" r# r r! r �copyc s r$ c C s t �| �| _t| �S )z@Dedent *func*'s docstring, then interpolate it with ``interpd``.)�inspectZgetdocr �interpdr r r r �dedent_interpdq s r' z#docstring.copy() and cbook.dedent()c s � fdd�S )zOA decorator that will copy the docstring from the source and then dedent itc s t t� �| ��S r )r r$ r r! r r �<lambda> � z copy_dedent.<locals>.<lambda>r r! r r! r � copy_dedentw s r* ) r% Z matplotlibr �objectr Z deprecatedr r r$ r& r' r* r r r r �<module> s 8