numpy.compat._inspect

module documentation

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.

Constant CO​_NEWLOCALS Undocumented
Constant CO​_OPTIMIZED Undocumented
Constant CO​_VARARGS Undocumented
Constant CO​_VARKEYWORDS Undocumented
Function formatargspec Format an argument spec from the 4 values returned by getargspec.
Function formatargvalues Format an argument spec from the 4 values returned by getargvalues.
Function getargs Get information about the arguments accepted by a code object.
Function getargspec Get the names and default values of a function's arguments.
Function getargvalues Get information about arguments passed into a particular frame.
Function iscode Return true if the object is a code object.
Function isfunction Return true if the object is a user-defined function.
Function ismethod Return true if the object is an instance method.
Function joinseq Undocumented
Function strseq Recursively walk a sequence, stringifying each element.
CO_NEWLOCALS =

Undocumented

CO_OPTIMIZED =

Undocumented

CO_VARARGS =

Undocumented

CO_VARKEYWORDS =

Undocumented

def formatargspec(args, varargs=None, varkw=None, defaults=None, formatarg=str, formatvarargs=(lambda name: '*' + name), formatvarkw=(lambda name: '**' + name), formatvalue=(lambda value: '=' + repr(value)), join=joinseq):

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=str, formatvarargs=(lambda name: '*' + name), formatvarkw=(lambda name: '**' + name), formatvalue=(lambda value: '=' + repr(value)), join=joinseq):

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.

def getargs(co):

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):

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):

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 iscode(object):

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 isfunction(object):

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 ismethod(object):

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 joinseq(seq):

Undocumented

def strseq(object, convert, join=joinseq):
Recursively walk a sequence, stringifying each element.