B FŽ0dçã@sxdZddlZddlZddlmZgZeeeddœdd„Zedœd d „Zed d d ƒedd dƒede eƒdƒeƒZ dS)z=A module for creating docstrings for sphinx ``data`` domains.éNé)ÚNDArray)ÚnameÚvalueÚdocÚreturncCst |||f¡dS)zþAppend ``_docstrings_list`` with a docstring for `name`. Parameters ---------- name : str The name of the object. value : str A string-representation of the object. doc : str The docstring of the object. N)Ú_docstrings_listÚappend)rrr©r úM/var/www/html/venv/lib/python3.7/site-packages/numpy/typing/_add_docstring.pyÚ add_newdoc s r )rc Csg}xðtD]è\}}}t |¡ dd¡}| d¡}g}d}x’|D]Š}t d|¡} | r¶|r¶t | ¡¡} | dkrŒd}| |   d¡›d| ›¡nd}| |   d¡›d | ›¡| d¡q>| |›|›¡q>Wd  |¡}| d |›d |›d|›¡q Wd  |¡S) zaConvert all docstrings in ``_docstrings_list`` into a single sphinx-legible text block. Ú z Úz^(\s+)[-=]+\s*$ZExamplesrz .. rubric:: z z.. admonition:: z .. data:: z :value: ) rÚtextwrapÚdedentÚreplaceÚsplitÚreÚmatchÚpopr ÚgroupÚjoin) Z type_list_retrrrÚsÚlinesÚ new_linesÚindentÚlineÚmÚprevr r r Ú_parse_docstringss(      rZ ArrayLikeztyping.Union[...]aG A `~typing.Union` representing objects that can be coerced into an `~numpy.ndarray`. Among others this includes the likes of: * Scalars. * (Nested) sequences. * Objects implementing the `~class.__array__` protocol. See Also -------- :term:`array_like`: Any scalar or sequence that can be interpreted as an ndarray. Examples -------- .. code-block:: python >>> import numpy as np >>> import numpy.typing as npt >>> def as_array(a: npt.ArrayLike) -> np.ndarray: ... return np.array(a) Z DTypeLikeaª A `~typing.Union` representing objects that can be coerced into a `~numpy.dtype`. Among others this includes the likes of: * :class:`type` objects. * Character codes or the names of :class:`type` objects. * Objects with the ``.dtype`` attribute. See Also -------- :ref:`Specifying and constructing data types ` A comprehensive overview of all objects that can be coerced into data types. Examples -------- .. code-block:: python >>> import numpy as np >>> import numpy.typing as npt >>> def as_dtype(d: npt.DTypeLike) -> np.dtype: ... return np.dtype(d) raÐ A :term:`generic ` version of `np.ndarray[Any, np.dtype[+ScalarType]] `. Can be used during runtime for typing arrays with a given dtype and unspecified shape. Examples -------- .. code-block:: python >>> import numpy as np >>> import numpy.typing as npt >>> print(npt.NDArray) numpy.ndarray[typing.Any, numpy.dtype[+ScalarType]] >>> print(npt.NDArray[np.float64]) numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]] >>> NDArrayInt = npt.NDArray[np.int_] >>> a: NDArrayInt = np.arange(10) >>> def func(a: npt.ArrayLike) -> npt.NDArray[Any]: ... return np.array(a) ) Ú__doc__rrZ_generic_aliasrrÚstrr rÚreprZ _docstringsr r r r Ús !