124 lines
4.8 KiB
Python
124 lines
4.8 KiB
Python
|
"""
|
||
|
|
This type stub file was generated by pyright.
|
||
|
|
"""
|
||
|
|
|
||
|
|
"""Subset of inspect module from upstream python
|
||
|
|
|
||
|
|
We use this instead of upstream because upstream inspect is slow to import, and
|
||
|
|
significantly contributes to numpy import times. Importing this copy has almost
|
||
|
|
no overhead.
|
||
|
|
|
||
|
|
"""
|
||
|
|
__all__ = ['getargspec', 'formatargspec']
|
||
|
|
def ismethod(object): # -> bool:
|
||
|
|
"""Return true if the object is an instance method.
|
||
|
|
|
||
|
|
Instance method objects provide these attributes:
|
||
|
|
__doc__ documentation string
|
||
|
|
__name__ name with which this method was defined
|
||
|
|
im_class class object in which this method belongs
|
||
|
|
im_func function object containing implementation of method
|
||
|
|
im_self instance to which this method is bound, or None
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def isfunction(object): # -> bool:
|
||
|
|
"""Return true if the object is a user-defined function.
|
||
|
|
|
||
|
|
Function objects provide these attributes:
|
||
|
|
__doc__ documentation string
|
||
|
|
__name__ name with which this function was defined
|
||
|
|
func_code code object containing compiled function bytecode
|
||
|
|
func_defaults tuple of any default values for arguments
|
||
|
|
func_doc (same as __doc__)
|
||
|
|
func_globals global namespace in which this function was defined
|
||
|
|
func_name (same as __name__)
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def iscode(object): # -> bool:
|
||
|
|
"""Return true if the object is a code object.
|
||
|
|
|
||
|
|
Code objects provide these attributes:
|
||
|
|
co_argcount number of arguments (not including * or ** args)
|
||
|
|
co_code string of raw compiled bytecode
|
||
|
|
co_consts tuple of constants used in the bytecode
|
||
|
|
co_filename name of file in which this code object was created
|
||
|
|
co_firstlineno number of first line in Python source code
|
||
|
|
co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
|
||
|
|
co_lnotab encoded mapping of line numbers to bytecode indices
|
||
|
|
co_name name with which this code object was defined
|
||
|
|
co_names tuple of names of local variables
|
||
|
|
co_nlocals number of local variables
|
||
|
|
co_stacksize virtual machine stack space required
|
||
|
|
co_varnames tuple of names of arguments and local variables
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def getargs(co): # -> tuple[list[Unknown], Unknown | None, Unknown | None]:
|
||
|
|
"""Get information about the arguments accepted by a code object.
|
||
|
|
|
||
|
|
Three things are returned: (args, varargs, varkw), where 'args' is
|
||
|
|
a list of argument names (possibly containing nested lists), and
|
||
|
|
'varargs' and 'varkw' are the names of the * and ** arguments or None.
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def getargspec(func): # -> tuple[list[Unknown], Unknown | None, Unknown | None, Unknown]:
|
||
|
|
"""Get the names and default values of a function's arguments.
|
||
|
|
|
||
|
|
A tuple of four things is returned: (args, varargs, varkw, defaults).
|
||
|
|
'args' is a list of the argument names (it may contain nested lists).
|
||
|
|
'varargs' and 'varkw' are the names of the * and ** arguments or None.
|
||
|
|
'defaults' is an n-tuple of the default values of the last n arguments.
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def getargvalues(frame): # -> tuple[list[Unknown], Unknown | None, Unknown | None, Unknown]:
|
||
|
|
"""Get information about arguments passed into a particular frame.
|
||
|
|
|
||
|
|
A tuple of four things is returned: (args, varargs, varkw, locals).
|
||
|
|
'args' is a list of the argument names (it may contain nested lists).
|
||
|
|
'varargs' and 'varkw' are the names of the * and ** arguments or None.
|
||
|
|
'locals' is the locals dictionary of the given frame.
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def joinseq(seq): # -> str:
|
||
|
|
...
|
||
|
|
|
||
|
|
def strseq(object, convert, join=...):
|
||
|
|
"""Recursively walk a sequence, stringifying each element.
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def formatargspec(args, varargs=..., varkw=..., defaults=..., formatarg=..., formatvarargs=..., formatvarkw=..., formatvalue=..., join=...): # -> LiteralString:
|
||
|
|
"""Format an argument spec from the 4 values returned by getargspec.
|
||
|
|
|
||
|
|
The first four arguments are (args, varargs, varkw, defaults). The
|
||
|
|
other four arguments are the corresponding optional formatting functions
|
||
|
|
that are called to turn names and values into strings. The ninth
|
||
|
|
argument is an optional function to format the sequence of arguments.
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|
||
|
|
def formatargvalues(args, varargs, varkw, locals, formatarg=..., formatvarargs=..., formatvarkw=..., formatvalue=..., join=...): # -> LiteralString:
|
||
|
|
"""Format an argument spec from the 4 values returned by getargvalues.
|
||
|
|
|
||
|
|
The first four arguments are (args, varargs, varkw, locals). The
|
||
|
|
next four arguments are the corresponding optional formatting functions
|
||
|
|
that are called to turn names and values into strings. The ninth
|
||
|
|
argument is an optional function to format the sequence of arguments.
|
||
|
|
|
||
|
|
"""
|
||
|
|
...
|
||
|
|
|