You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
166 lines
4.1 KiB
166 lines
4.1 KiB
"""
|
|
This type stub file was generated by pyright.
|
|
"""
|
|
|
|
from collections.abc import Mapping
|
|
|
|
"""Extract reference documentation from the NumPy source tree.
|
|
|
|
Copyright (C) 2008 Stefan van der Walt <stefan@mentat.za.net>, Pauli Virtanen <pav@iki.fi>
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:
|
|
|
|
1. Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
2. Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in
|
|
the documentation and/or other materials provided with the
|
|
distribution.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
|
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
|
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
"""
|
|
def strip_blank_lines(l):
|
|
"Remove leading and trailing blank lines from a list of lines"
|
|
...
|
|
|
|
class Reader:
|
|
"""A line-based string reader.
|
|
|
|
"""
|
|
def __init__(self, data) -> None:
|
|
"""
|
|
Parameters
|
|
----------
|
|
data : str
|
|
String with lines separated by '\n'.
|
|
|
|
"""
|
|
...
|
|
|
|
def __getitem__(self, n):
|
|
...
|
|
|
|
def reset(self): # -> None:
|
|
...
|
|
|
|
def read(self): # -> Literal['']:
|
|
...
|
|
|
|
def seek_next_non_empty_line(self): # -> None:
|
|
...
|
|
|
|
def eof(self): # -> bool:
|
|
...
|
|
|
|
def read_to_condition(self, condition_func): # -> list[Unknown]:
|
|
...
|
|
|
|
def read_to_next_empty_line(self): # -> list[Unknown]:
|
|
...
|
|
|
|
def read_to_next_unindented_line(self): # -> list[Unknown]:
|
|
...
|
|
|
|
def peek(self, n=...): # -> Literal['']:
|
|
...
|
|
|
|
def is_empty(self): # -> bool:
|
|
...
|
|
|
|
|
|
|
|
class ParseError(Exception):
|
|
def __str__(self) -> str:
|
|
...
|
|
|
|
|
|
|
|
Parameter = ...
|
|
class NumpyDocString(Mapping):
|
|
"""Parses a numpydoc string to an abstract representation
|
|
|
|
Instances define a mapping from section title to structured data.
|
|
|
|
"""
|
|
sections = ...
|
|
def __init__(self, docstring, config=...) -> None:
|
|
...
|
|
|
|
def __getitem__(self, key):
|
|
...
|
|
|
|
def __setitem__(self, key, val): # -> None:
|
|
...
|
|
|
|
def __iter__(self): # -> Iterator[str]:
|
|
...
|
|
|
|
def __len__(self): # -> int:
|
|
...
|
|
|
|
_role = ...
|
|
_funcbacktick = ...
|
|
_funcplain = ...
|
|
_funcname = ...
|
|
_funcnamenext = ...
|
|
_funcnamenext = ...
|
|
_description = ...
|
|
_func_rgx = ...
|
|
_line_rgx = ...
|
|
empty_description = ...
|
|
def __str__(self, func_role=...) -> str:
|
|
...
|
|
|
|
|
|
|
|
def indent(str, indent=...): # -> LiteralString:
|
|
...
|
|
|
|
def dedent_lines(lines): # -> list[str]:
|
|
"""Deindent a list of lines maximally"""
|
|
...
|
|
|
|
def header(text, style=...):
|
|
...
|
|
|
|
class FunctionDoc(NumpyDocString):
|
|
def __init__(self, func, role=..., doc=..., config=...) -> None:
|
|
...
|
|
|
|
def get_func(self): # -> tuple[Any | Overload[(__o: object, /) -> None, (__name: str, __bases: tuple[type, ...], __dict: dict[str, Any], **kwds: Any) -> None] | Unknown, Any | str]:
|
|
...
|
|
|
|
def __str__(self) -> str:
|
|
...
|
|
|
|
|
|
|
|
class ClassDoc(NumpyDocString):
|
|
extra_public_methods = ...
|
|
def __init__(self, cls, doc=..., modulename=..., func_doc=..., config=...) -> None:
|
|
...
|
|
|
|
@property
|
|
def methods(self): # -> list[Unknown] | list[str]:
|
|
...
|
|
|
|
@property
|
|
def properties(self): # -> list[Unknown] | list[str]:
|
|
...
|
|
|
|
|
|
|