{
    "content": [
        {
            "type": "text",
            "text": "# inspect (pydoc)\n\n**Summary:** inspect - Get useful information from live Python objects.\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **DESCRIPTION** (27 lines)\n- **CLASSES** (18 lines) — 14 subsections\n  - class ArgInfo (121 lines)\n  - class ArgSpec (121 lines)\n  - class Arguments (118 lines)\n  - class Attribute (121 lines)\n  - class BlockFinder (18 lines)\n  - class BoundArguments (63 lines)\n  - class ClassFoundException (67 lines)\n  - class ClosureVars (121 lines)\n  - class EndOfBlock (67 lines)\n  - class FrameInfo (122 lines)\n  - class FullArgSpec (130 lines)\n  - class Parameter (74 lines)\n  - class Signature (90 lines)\n  - class Traceback (119 lines)\n- **FUNCTIONS** (1 lines) — 64 subsections\n  - classify_class_attrs (25 lines)\n  - cleandoc (5 lines)\n  - currentframe (2 lines)\n  - findsource (7 lines)\n  - formatannotation (1 lines)\n  - formatannotationrelativeto (1 lines)\n  - formatargspec (11 lines)\n  - formatargvalues (7 lines)\n  - get_annotations (44 lines)\n  - getabsfile (5 lines)\n  - getargs (7 lines)\n  - getargspec (19 lines)\n  - getargvalues (7 lines)\n  - getattr_static (10 lines)\n  - getblock (2 lines)\n  - getcallargs (6 lines)\n  - getclasstree (9 lines)\n  - getclosurevars (6 lines)\n  - getcomments (4 lines)\n  - getcoroutinelocals (5 lines)\n  - getcoroutinestate (8 lines)\n  - getdoc (6 lines)\n  - getfile (2 lines)\n  - getframeinfo (8 lines)\n  - getfullargspec (15 lines)\n  - getgeneratorlocals (5 lines)\n  - getgeneratorstate (8 lines)\n  - getinnerframes (5 lines)\n  - getlineno (2 lines)\n  - getmembers (3 lines)\n  - getmodule (2 lines)\n  - getmodulename (2 lines)\n  - getmro (2 lines)\n  - getouterframes (5 lines)\n  - getsource (6 lines)\n  - getsourcefile (3 lines)\n  - getsourcelines (8 lines)\n  - indentsize (2 lines)\n  - isabstract (2 lines)\n  - isasyncgen (2 lines)\n  - isasyncgenfunction (5 lines)\n  - isawaitable (2 lines)\n  - isbuiltin (7 lines)\n  - isclass (6 lines)\n  - iscode (23 lines)\n  - iscoroutine (2 lines)\n  - iscoroutinefunction (4 lines)\n  - isdatadescriptor (8 lines)\n  - isframe (12 lines)\n  - isfunction (11 lines)\n  - isgenerator (15 lines)\n  - isgeneratorfunction (5 lines)\n  - isgetsetdescriptor (5 lines)\n  - ismemberdescriptor (5 lines)\n  - ismethod (8 lines)\n  - ismethoddescriptor (14 lines)\n  - ismodule (7 lines)\n  - isroutine (2 lines)\n  - istraceback (8 lines)\n  - signature (2 lines)\n  - stack (2 lines)\n  - trace (2 lines)\n  - unwrap (14 lines)\n  - walktree (2 lines)\n- **DATA** (24 lines)\n- **AUTHOR** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\ninspect - Get useful information from live Python objects.\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/inspect.html\n\nThe following documentation is automatically generated from the Python\nsource files.  It may be incomplete, incorrect or include features that\nare considered implementation detail and may vary between Python\nimplementations.  When in doubt, consult the module reference at the\nlocation listed above.\n\n### DESCRIPTION\n\nThis module encapsulates the interface provided by the internal special\nattributes (co*, im*, tb*, etc.) in a friendlier fashion.\nIt also provides some help for examining source code and class layout.\n\nHere are some of the useful functions provided by this module:\n\nismodule(), isclass(), ismethod(), isfunction(), isgeneratorfunction(),\nisgenerator(), istraceback(), isframe(), iscode(), isbuiltin(),\nisroutine() - check object types\ngetmembers() - get members of an object that satisfy a given condition\n\ngetfile(), getsourcefile(), getsource() - find an object's source code\ngetdoc(), getcomments() - get documentation on an object\ngetmodule() - determine the module that an object came from\ngetclasstree() - arrange classes so as to represent their hierarchy\n\ngetargvalues(), getcallargs() - get info about function arguments\ngetfullargspec() - same, with support for Python 3 features\nformatargvalues() - format an argument spec\ngetouterframes(), getinnerframes() - get info about frames\ncurrentframe() - get the current stack frame\nstack(), trace() - get info about frames on the stack or in a traceback\n\nsignature() - get a Signature object for the callable\n\ngetannotations() - safely compute an object's annotations\n\n### CLASSES\n\nbuiltins.Exception(builtins.BaseException)\nClassFoundException\nEndOfBlock\nbuiltins.object\nBlockFinder\nBoundArguments\nParameter\nSignature\nbuiltins.tuple(builtins.object)\nArgInfo\nArgSpec\nArguments\nAttribute\nClosureVars\nFrameInfo\nFullArgSpec\nTraceback\n\n#### class ArgInfo\n\n|  ArgInfo(args, varargs, keywords, locals)\n|\n|  ArgInfo(args, varargs, keywords, locals)\n|\n|  Method resolution order:\n|      ArgInfo\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new ArgInfo object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new ArgInfo object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, args, varargs, keywords, locals)\n|      Create new instance of ArgInfo(args, varargs, keywords, locals)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  args\n|      Alias for field number 0\n|\n|  varargs\n|      Alias for field number 1\n|\n|  keywords\n|      Alias for field number 2\n|\n|  locals\n|      Alias for field number 3\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('args', 'varargs', 'keywords', 'locals')\n|\n|  fielddefaults = {}\n|\n|  fields = ('args', 'varargs', 'keywords', 'locals')\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n#### class ArgSpec\n\n|  ArgSpec(args, varargs, keywords, defaults)\n|\n|  ArgSpec(args, varargs, keywords, defaults)\n|\n|  Method resolution order:\n|      ArgSpec\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new ArgSpec object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new ArgSpec object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, args, varargs, keywords, defaults)\n|      Create new instance of ArgSpec(args, varargs, keywords, defaults)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  args\n|      Alias for field number 0\n|\n|  varargs\n|      Alias for field number 1\n|\n|  keywords\n|      Alias for field number 2\n|\n|  defaults\n|      Alias for field number 3\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('args', 'varargs', 'keywords', 'defaults')\n|\n|  fielddefaults = {}\n|\n|  fields = ('args', 'varargs', 'keywords', 'defaults')\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n#### class Arguments\n\n|  Arguments(args, varargs, varkw)\n|\n|  Arguments(args, varargs, varkw)\n|\n|  Method resolution order:\n|      Arguments\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new Arguments object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new Arguments object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, args, varargs, varkw)\n|      Create new instance of Arguments(args, varargs, varkw)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  args\n|      Alias for field number 0\n|\n|  varargs\n|      Alias for field number 1\n|\n|  varkw\n|      Alias for field number 2\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('args', 'varargs', 'varkw')\n|\n|  fielddefaults = {}\n|\n|  fields = ('args', 'varargs', 'varkw')\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n#### class Attribute\n\n|  Attribute(name, kind, definingclass, object)\n|\n|  Attribute(name, kind, definingclass, object)\n|\n|  Method resolution order:\n|      Attribute\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new Attribute object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new Attribute object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, name, kind, definingclass, object)\n|      Create new instance of Attribute(name, kind, definingclass, object)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  name\n|      Alias for field number 0\n|\n|  kind\n|      Alias for field number 1\n|\n|  definingclass\n|      Alias for field number 2\n|\n|  object\n|      Alias for field number 3\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('name', 'kind', 'definingclass', 'object')\n|\n|  fielddefaults = {}\n|\n|  fields = ('name', 'kind', 'definingclass', 'object')\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n#### class BlockFinder\n\n|  Provide a tokeneater() method to detect the end of a code block.\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  tokeneater(self, type, token, srowcol, erowcol, line)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n#### class BoundArguments\n\n|  BoundArguments(signature, arguments)\n|\n|  Result of `Signature.bind` call.  Holds the mapping of arguments\n|  to the function's parameters.\n|\n|  Has the following public attributes:\n|\n|  * arguments : dict\n|      An ordered mutable mapping of parameters' names to arguments' values.\n|      Does not contain arguments' default values.\n|  * signature : Signature\n|      The Signature object that created this instance.\n|  * args : tuple\n|      Tuple of positional arguments values.\n|  * kwargs : dict\n|      Dict of keyword arguments values.\n|\n|  Methods defined here:\n|\n|  eq(self, other)\n|      Return self==value.\n|\n|  getstate(self)\n|\n|  init(self, signature, arguments)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  repr(self)\n|      Return repr(self).\n|\n|  setstate(self, state)\n|\n|  applydefaults(self)\n|      Set default values for missing arguments.\n|\n|      For variable-positional arguments (*args) the default is an\n|      empty tuple.\n|\n|      For variable-keyword arguments (kwargs) the default is an\n|      empty dict.\n|\n|  ----------------------------------------------------------------------\n|  Readonly properties defined here:\n|\n|  args\n|\n|  kwargs\n|\n|  signature\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  arguments\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  hash = None\n\n#### class ClassFoundException\n\n|  Method resolution order:\n|      ClassFoundException\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors defined here:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class ClosureVars\n\n|  ClosureVars(nonlocals, globals, builtins, unbound)\n|\n|  ClosureVars(nonlocals, globals, builtins, unbound)\n|\n|  Method resolution order:\n|      ClosureVars\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new ClosureVars object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new ClosureVars object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, nonlocals, globals, builtins, unbound)\n|      Create new instance of ClosureVars(nonlocals, globals, builtins, unbound)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  nonlocals\n|      Alias for field number 0\n|\n|  globals\n|      Alias for field number 1\n|\n|  builtins\n|      Alias for field number 2\n|\n|  unbound\n|      Alias for field number 3\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('nonlocals', 'globals', 'builtins', 'unbound')\n|\n|  fielddefaults = {}\n|\n|  fields = ('nonlocals', 'globals', 'builtins', 'unbound')\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n#### class EndOfBlock\n\n|  Method resolution order:\n|      EndOfBlock\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors defined here:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class FrameInfo\n\n|  FrameInfo(frame, filename, lineno, function, codecontext, index)\n|\n|  FrameInfo(frame, filename, lineno, function, codecontext, index)\n|\n|  Method resolution order:\n|      FrameInfo\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new FrameInfo object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new FrameInfo object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, frame, filename, lineno, function, codecontext, index)\n|      Create new instance of FrameInfo(frame, filename, lineno, function, codecontext, index)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  frame\n|      Alias for field number 0\n|\n|  filename\n|      Alias for field number 1\n|\n|  lineno\n|      Alias for field number 2\n|\n|  function\n|      Alias for field number 3\n|\n|  codecontext\n|      Alias for field number 4\n|\n|  index\n|      Alias for field number 5\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('frame', 'filename', 'lineno', 'function', 'codecon...\n|\n|  fielddefaults = {}\n|\n|  fields = ('frame', 'filename', 'lineno', 'function', 'codecontext', ...\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n#### class FullArgSpec\n\n|  FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)\n|\n|  FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)\n|\n|  Method resolution order:\n|      FullArgSpec\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new FullArgSpec object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new FullArgSpec object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)\n|      Create new instance of FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  args\n|      Alias for field number 0\n|\n|  varargs\n|      Alias for field number 1\n|\n|  varkw\n|      Alias for field number 2\n|\n|  defaults\n|      Alias for field number 3\n|\n|  kwonlyargs\n|      Alias for field number 4\n|\n|  kwonlydefaults\n|      Alias for field number 5\n|\n|  annotations\n|      Alias for field number 6\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('args', 'varargs', 'varkw', 'defaults', 'kwonlyargs'...\n|\n|  fielddefaults = {}\n|\n|  fields = ('args', 'varargs', 'varkw', 'defaults', 'kwonlyargs', 'kwon...\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n#### class Parameter\n\n|  Parameter(name, kind, *, default, annotation)\n|\n|  Represents a parameter in a function signature.\n|\n|  Has the following public attributes:\n|\n|  * name : str\n|      The name of the parameter as a string.\n|  * default : object\n|      The default value for the parameter if specified.  If the\n|      parameter has no default value, this attribute is set to\n|      `Parameter.empty`.\n|  * annotation\n|      The annotation for the parameter if specified.  If the\n|      parameter has no annotation, this attribute is set to\n|      `Parameter.empty`.\n|  * kind : str\n|      Describes how argument values are bound to the parameter.\n|      Possible values: `Parameter.POSITIONALONLY`,\n|      `Parameter.POSITIONALORKEYWORD`, `Parameter.VARPOSITIONAL`,\n|      `Parameter.KEYWORDONLY`, `Parameter.VARKEYWORD`.\n|\n|  Methods defined here:\n|\n|  eq(self, other)\n|      Return self==value.\n|\n|  hash(self)\n|      Return hash(self).\n|\n|  init(self, name, kind, *, default, annotation)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  reduce(self)\n|      Helper for pickle.\n|\n|  repr(self)\n|      Return repr(self).\n|\n|  setstate(self, state)\n|\n|  str(self)\n|      Return str(self).\n|\n|  replace(self, *, name=<class 'inspect.void'>, kind=<class 'inspect.void'>, annotation=<class 'inspect.void'>, default=<class 'inspect.void'>)\n|      Creates a customized copy of the Parameter.\n|\n|  ----------------------------------------------------------------------\n|  Readonly properties defined here:\n|\n|  annotation\n|\n|  default\n|\n|  kind\n|\n|  name\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  KEYWORDONLY = <ParameterKind.KEYWORDONLY: 3>\n|\n|  POSITIONALONLY = <ParameterKind.POSITIONALONLY: 0>\n|\n|  POSITIONALORKEYWORD = <ParameterKind.POSITIONALORKEYWORD: 1>\n|\n|  VARKEYWORD = <ParameterKind.VARKEYWORD: 4>\n|\n|  VARPOSITIONAL = <ParameterKind.VARPOSITIONAL: 2>\n|\n|  empty = <class 'inspect.empty'>\n|      Marker object for Signature.empty and Parameter.empty.\n\n#### class Signature\n\n|  Signature(parameters=None, *, returnannotation, validateparameters=True)\n|\n|  A Signature object represents the overall signature of a function.\n|  It stores a Parameter object for each parameter accepted by the\n|  function, as well as information specific to the function itself.\n|\n|  A Signature object has the following public attributes and methods:\n|\n|  * parameters : OrderedDict\n|      An ordered mapping of parameters' names to the corresponding\n|      Parameter objects (keyword-only arguments are in the same order\n|      as listed in `code.covarnames`).\n|  * returnannotation : object\n|      The annotation for the return type of the function if specified.\n|      If the function has no annotation for its return type, this\n|      attribute is set to `Signature.empty`.\n|  * bind(*args, kwargs) -> BoundArguments\n|      Creates a mapping from positional and keyword arguments to\n|      parameters.\n|  * bindpartial(*args, kwargs) -> BoundArguments\n|      Creates a partial mapping from positional and keyword arguments\n|      to parameters (simulating 'functools.partial' behavior.)\n|\n|  Methods defined here:\n|\n|  eq(self, other)\n|      Return self==value.\n|\n|  hash(self)\n|      Return hash(self).\n|\n|  init(self, parameters=None, *, returnannotation, validateparameters=True)\n|      Constructs Signature from the given list of Parameter\n|      objects and 'returnannotation'.  All arguments are optional.\n|\n|  reduce(self)\n|      Helper for pickle.\n|\n|  repr(self)\n|      Return repr(self).\n|\n|  setstate(self, state)\n|\n|  str(self)\n|      Return str(self).\n|\n|  bind(self, /, *args, kwargs)\n|      Get a BoundArguments object, that maps the passed `args`\n|      and `kwargs` to the function's signature.  Raises `TypeError`\n|      if the passed arguments can not be bound.\n|\n|  bindpartial(self, /, *args, kwargs)\n|      Get a BoundArguments object, that partially maps the\n|      passed `args` and `kwargs` to the function's signature.\n|      Raises `TypeError` if the passed arguments can not be bound.\n|\n|  replace(self, *, parameters=<class 'inspect.void'>, returnannotation=<class 'inspect.void'>)\n|      Creates a customized copy of the Signature.\n|      Pass 'parameters' and/or 'returnannotation' arguments\n|      to override them in the new copy.\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  frombuiltin(func) from builtins.type\n|      Constructs Signature for the given builtin function.\n|\n|      Deprecated since Python 3.5, use `Signature.fromcallable()`.\n|\n|  fromcallable(obj, *, followwrapped=True, globals=None, locals=None, evalstr=False) from builtins.type\n|      Constructs Signature for the given callable object.\n|\n|  fromfunction(func) from builtins.type\n|      Constructs Signature for the given python function.\n|\n|      Deprecated since Python 3.5, use `Signature.fromcallable()`.\n|\n|  ----------------------------------------------------------------------\n|  Readonly properties defined here:\n|\n|  parameters\n|\n|  returnannotation\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  empty = <class 'inspect.empty'>\n|      Marker object for Signature.empty and Parameter.empty.\n\n#### class Traceback\n\n|  Traceback(filename, lineno, function, codecontext, index)\n|\n|  Traceback(filename, lineno, function, codecontext, index)\n|\n|  Method resolution order:\n|      Traceback\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new Traceback object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods defined here:\n|\n|  make(iterable) from builtins.type\n|      Make a new Traceback object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, filename, lineno, function, codecontext, index)\n|      Create new instance of Traceback(filename, lineno, function, codecontext, index)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  filename\n|      Alias for field number 0\n|\n|  lineno\n|      Alias for field number 1\n|\n|  function\n|      Alias for field number 2\n|\n|  codecontext\n|      Alias for field number 3\n|\n|  index\n|      Alias for field number 4\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  matchargs = ('filename', 'lineno', 'function', 'codecontext', 'i...\n|\n|  fielddefaults = {}\n|\n|  fields = ('filename', 'lineno', 'function', 'codecontext', 'index')\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  ge(self, value, /)\n|      Return self>=value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  gt(self, value, /)\n|      Return self>value.\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  le(self, value, /)\n|      Return self<=value.\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  lt(self, value, /)\n|      Return self<value.\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n\n### FUNCTIONS\n\n#### classify_class_attrs\n\nReturn list of attribute-descriptor tuples.\n\nFor each name in dir(cls), the return list contains a 4-tuple\nwith these elements:\n\n0. The name (a string).\n\n1. The kind of attribute this is, one of these strings:\n'class method'    created via classmethod()\n'static method'   created via staticmethod()\n'property'        created via property()\n'method'          any other flavor of method or descriptor\n'data'            not a method\n\n2. The class which defined this attribute (a class).\n\n3. The object as obtained by calling getattr; if this fails, or if the\nresulting object does not live anywhere in the class' mro (including\nmetaclasses) then the object is looked up in the defining class's\ndict (found by walking the mro).\n\nIf one of the items in dir(cls) is stored in the metaclass it will now\nbe discovered and not have None be listed as the class in which it was\ndefined.  Any items whose home class cannot be discovered are skipped.\n\n#### cleandoc\n\nClean up indentation from docstrings.\n\nAny whitespace that can be uniformly removed from the second line\nonwards is removed.\n\n#### currentframe\n\nReturn the frame of the caller or None if this is not possible.\n\n#### findsource\n\nReturn the entire source file and starting line number for an object.\n\nThe argument may be a module, class, method, function, traceback, frame,\nor code object.  The source code is returned as a list of all the lines\nin the file and the line number indexes a line in that list.  An OSError\nis raised if the source code cannot be retrieved.\n\n#### formatannotation\n\n#### formatannotationrelativeto\n\n#### formatargspec\n\nFormat an argument spec from the values returned by getfullargspec.\n\nThe first seven arguments are (args, varargs, varkw, defaults,\nkwonlyargs, kwonlydefaults, annotations).  The other five arguments\nare the corresponding optional formatting functions that are called to\nturn names and values into strings.  The last argument is an optional\nfunction to format the sequence of arguments.\n\nDeprecated since Python 3.5: use the `signature` function and `Signature`\nobjects.\n\n#### formatargvalues\n\nFormat an argument spec from the 4 values returned by getargvalues.\n\nThe first four arguments are (args, varargs, varkw, locals).  The\nnext four arguments are the corresponding optional formatting functions\nthat are called to turn names and values into strings.  The ninth\nargument is an optional function to format the sequence of arguments.\n\n#### get_annotations\n\nCompute the annotations dict for an object.\n\nobj may be a callable, class, or module.\nPassing in an object of any other type raises TypeError.\n\nReturns a dict.  getannotations() returns a new dict every time\nit's called; calling it twice on the same object will return two\ndifferent but equivalent dicts.\n\nThis function handles several details for you:\n\n* If evalstr is true, values of type str will\nbe un-stringized using eval().  This is intended\nfor use with stringized annotations\n(\"from future import annotations\").\n* If obj doesn't have an annotations dict, returns an\nempty dict.  (Functions and methods always have an\nannotations dict; classes, modules, and other types of\ncallables may not.)\n* Ignores inherited annotations on classes.  If a class\ndoesn't have its own annotations dict, returns an empty dict.\n* All accesses to object members and dict values are done\nusing getattr() and dict.get() for safety.\n* Always, always, always returns a freshly-created dict.\n\nevalstr controls whether or not values of type str are replaced\nwith the result of calling eval() on those values:\n\n* If evalstr is true, eval() is called on values of type str.\n* If evalstr is false (the default), values of type str are unchanged.\n\nglobals and locals are passed in to eval(); see the documentation\nfor eval() for more information.  If either globals or locals is\nNone, this function may replace that value with a context-specific\ndefault, contingent on type(obj):\n\n* If obj is a module, globals defaults to obj.dict.\n* If obj is a class, globals defaults to\nsys.modules[obj.module].dict and locals\ndefaults to the obj class namespace.\n* If obj is a callable, globals defaults to obj.globals,\nalthough if obj is a wrapped function (using\nfunctools.updatewrapper()) it is first unwrapped.\n\n#### getabsfile\n\nReturn an absolute path to the source or compiled file for an object.\n\nThe idea is for each object to have a unique origin, so this routine\nnormalizes the result as much as possible.\n\n#### getargs\n\nGet information about the arguments accepted by a code object.\n\nThree things are returned: (args, varargs, varkw), where\n'args' is the list of argument names. Keyword-only arguments are\nappended. 'varargs' and 'varkw' are the names of the * and\narguments or None.\n\n#### getargspec\n\nGet the names and default values of a function's parameters.\n\nA tuple of four things is returned: (args, varargs, keywords, defaults).\n'args' is a list of the argument names, including keyword-only argument names.\n'varargs' and 'keywords' are the names of the * and  parameters or None.\n'defaults' is an n-tuple of the default values of the last n parameters.\n\nThis function is deprecated, as it does not support annotations or\nkeyword-only parameters and will raise ValueError if either is present\non the supplied callable.\n\nFor a more structured introspection API, use inspect.signature() instead.\n\nAlternatively, use getfullargspec() for an API with a similar namedtuple\nbased interface, but full support for annotations and keyword-only\nparameters.\n\nDeprecated since Python 3.5, use `inspect.getfullargspec()`.\n\n#### getargvalues\n\nGet information about arguments passed into a particular frame.\n\nA tuple of four things is returned: (args, varargs, varkw, locals).\n'args' is a list of the argument names.\n'varargs' and 'varkw' are the names of the * and  arguments or None.\n'locals' is the locals dictionary of the given frame.\n\n#### getattr_static\n\nRetrieve attributes without triggering dynamic lookup via the\ndescriptor protocol,  getattr or getattribute.\n\nNote: this function may not be able to retrieve all attributes\nthat getattr can fetch (like dynamically created attributes)\nand may find attributes that getattr can't (like descriptors\nthat raise AttributeError). It can also return descriptor objects\ninstead of instance members in some cases. See the\ndocumentation for details.\n\n#### getblock\n\nExtract the block of code at the top of the given list of lines.\n\n#### getcallargs\n\nGet the mapping of arguments to values.\n\nA dict is returned, with keys the function argument names (including the\nnames of the * and  arguments, if any), and values the respective bound\nvalues from 'positional' and 'named'.\n\n#### getclasstree\n\nArrange the given list of classes into a hierarchy of nested lists.\n\nWhere a nested list appears, it contains classes derived from the class\nwhose entry immediately precedes the list.  Each entry is a 2-tuple\ncontaining a class and a tuple of its base classes.  If the 'unique'\nargument is true, exactly one entry appears in the returned structure\nfor each class in the given list.  Otherwise, classes using multiple\ninheritance and their descendants will appear multiple times.\n\n#### getclosurevars\n\nGet the mapping of free variables to their current values.\n\nReturns a named tuple of dicts mapping the current nonlocal, global\nand builtin references as seen by the body of the function. A final\nset of unbound names that could not be resolved is also provided.\n\n#### getcomments\n\nGet lines of comments immediately preceding an object's source code.\n\nReturns None when source can't be found.\n\n#### getcoroutinelocals\n\nGet the mapping of coroutine local variables to their current values.\n\nA dict is returned, with the keys the local variable names and values the\nbound values.\n\n#### getcoroutinestate\n\nGet current state of a coroutine object.\n\nPossible states are:\nCOROCREATED: Waiting to start execution.\nCORORUNNING: Currently being executed by the interpreter.\nCOROSUSPENDED: Currently suspended at an await expression.\nCOROCLOSED: Execution has completed.\n\n#### getdoc\n\nGet the documentation string for an object.\n\nAll tabs are expanded to spaces.  To clean up docstrings that are\nindented to line up with blocks of code, any whitespace than can be\nuniformly removed from the second line onwards is removed.\n\n#### getfile\n\nWork out which source or compiled file an object was defined in.\n\n#### getframeinfo\n\nGet information about a frame or traceback object.\n\nA tuple of five things is returned: the filename, the line number of\nthe current line, the function name, a list of lines of context from\nthe source code, and the index of the current line within that list.\nThe optional second argument specifies the number of lines of context\nto return, which are centered around the current line.\n\n#### getfullargspec\n\nGet the names and default values of a callable object's parameters.\n\nA tuple of seven things is returned:\n(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations).\n'args' is a list of the parameter names.\n'varargs' and 'varkw' are the names of the * and  parameters or None.\n'defaults' is an n-tuple of the default values of the last n parameters.\n'kwonlyargs' is a list of keyword-only parameter names.\n'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.\n'annotations' is a dictionary mapping parameter names to annotations.\n\nNotable differences from inspect.signature():\n- the \"self\" parameter is always reported, even for bound methods\n- wrapper chains defined by wrapped *not* unwrapped automatically\n\n#### getgeneratorlocals\n\nGet the mapping of generator local variables to their current values.\n\nA dict is returned, with the keys the local variable names and values the\nbound values.\n\n#### getgeneratorstate\n\nGet current state of a generator-iterator.\n\nPossible states are:\nGENCREATED: Waiting to start execution.\nGENRUNNING: Currently being executed by the interpreter.\nGENSUSPENDED: Currently suspended at a yield expression.\nGENCLOSED: Execution has completed.\n\n#### getinnerframes\n\nGet a list of records for a traceback's frame and all lower frames.\n\nEach record contains a frame object, filename, line number, function\nname, a list of lines of context, and index within the context.\n\n#### getlineno\n\nGet the line number from a frame object, allowing for optimization.\n\n#### getmembers\n\nReturn all members of an object as (name, value) pairs sorted by name.\nOptionally, only return members that satisfy a given predicate.\n\n#### getmodule\n\nReturn the module an object was defined in, or None if not found.\n\n#### getmodulename\n\nReturn the module name for a given file, or None.\n\n#### getmro\n\nReturn tuple of base classes (including cls) in method resolution order.\n\n#### getouterframes\n\nGet a list of records for a frame and all higher (calling) frames.\n\nEach record contains a frame object, filename, line number, function\nname, a list of lines of context, and index within the context.\n\n#### getsource\n\nReturn the text of the source code for an object.\n\nThe argument may be a module, class, method, function, traceback, frame,\nor code object.  The source code is returned as a single string.  An\nOSError is raised if the source code cannot be retrieved.\n\n#### getsourcefile\n\nReturn the filename that can be used to locate an object's source.\nReturn None if no way can be identified to get the source.\n\n#### getsourcelines\n\nReturn a list of source lines and starting line number for an object.\n\nThe argument may be a module, class, method, function, traceback, frame,\nor code object.  The source code is returned as a list of the lines\ncorresponding to the object and the line number indicates where in the\noriginal source file the first line of code was found.  An OSError is\nraised if the source code cannot be retrieved.\n\n#### indentsize\n\nReturn the indent size, in spaces, at the start of a line of text.\n\n#### isabstract\n\nReturn true if the object is an abstract base class (ABC).\n\n#### isasyncgen\n\nReturn true if the object is an asynchronous generator.\n\n#### isasyncgenfunction\n\nReturn true if the object is an asynchronous generator function.\n\nAsynchronous generator functions are defined with \"async def\"\nsyntax and have \"yield\" expressions in their body.\n\n#### isawaitable\n\nReturn true if object can be passed to an ``await`` expression.\n\n#### isbuiltin\n\nReturn true if the object is a built-in function or method.\n\nBuilt-in functions and methods provide these attributes:\ndoc         documentation string\nname        original name of this function or method\nself        instance to which a method is bound, or None\n\n#### isclass\n\nReturn true if the object is a class.\n\nClass objects provide these attributes:\ndoc         documentation string\nmodule      name of module in which this class was defined\n\n#### iscode\n\nReturn true if the object is a code object.\n\nCode objects provide these attributes:\ncoargcount         number of arguments (not including *,  args\nor keyword only arguments)\ncocode             string of raw compiled bytecode\ncocellvars         tuple of names of cell variables\ncoconsts           tuple of constants used in the bytecode\ncofilename         name of file in which this code object was created\ncofirstlineno      number of first line in Python source code\ncoflags            bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=arg\n| 16=nested | 32=generator | 64=nofree | 128=coroutine\n| 256=iterablecoroutine | 512=asyncgenerator\ncofreevars         tuple of names of free variables\ncoposonlyargcount  number of positional only arguments\ncokwonlyargcount   number of keyword only arguments (not including  arg)\ncolnotab           encoded mapping of line numbers to bytecode indices\nconame             name with which this code object was defined\nconames            tuple of names other than arguments and function locals\nconlocals          number of local variables\ncostacksize        virtual machine stack space required\ncovarnames         tuple of names of arguments and local variables\n\n#### iscoroutine\n\nReturn true if the object is a coroutine.\n\n#### iscoroutinefunction\n\nReturn true if the object is a coroutine function.\n\nCoroutine functions are defined with \"async def\" syntax.\n\n#### isdatadescriptor\n\nReturn true if the object is a data descriptor.\n\nData descriptors have a set or a delete attribute.  Examples are\nproperties (defined in Python) and getsets and members (defined in C).\nTypically, data descriptors will also have name and doc attributes\n(properties, getsets, and members have both of these attributes), but this\nis not guaranteed.\n\n#### isframe\n\nReturn true if the object is a frame object.\n\nFrame objects provide these attributes:\nfback          next outer frame object (this frame's caller)\nfbuiltins      built-in namespace seen by this frame\nfcode          code object being executed in this frame\nfglobals       global namespace seen by this frame\nflasti         index of last attempted instruction in bytecode\nflineno        current line number in Python source code\nflocals        local namespace seen by this frame\nftrace         tracing function for this frame, or None\n\n#### isfunction\n\nReturn true if the object is a user-defined function.\n\nFunction objects provide these attributes:\ndoc         documentation string\nname        name with which this function was defined\ncode        code object containing compiled function bytecode\ndefaults    tuple of any default values for arguments\nglobals     global namespace in which this function was defined\nannotations dict of parameter annotations\nkwdefaults  dict of keyword only parameters with defaults\n\n#### isgenerator\n\nReturn true if the object is a generator.\n\nGenerator objects provide these attributes:\niter        defined to support iteration over container\nclose           raises a new GeneratorExit exception inside the\ngenerator to terminate the iteration\ngicode         code object\ngiframe        frame object or possibly None once the generator has\nbeen exhausted\ngirunning      set to 1 when generator is executing, 0 otherwise\nnext            return the next item from the container\nsend            resumes the generator and \"sends\" a value that becomes\nthe result of the current yield-expression\nthrow           used to raise an exception inside the generator\n\n#### isgeneratorfunction\n\nReturn true if the object is a user-defined generator function.\n\nGenerator function objects provide the same attributes as functions.\nSee help(isfunction) for a list of attributes.\n\n#### isgetsetdescriptor\n\nReturn true if the object is a getset descriptor.\n\ngetset descriptors are specialized descriptors defined in extension\nmodules.\n\n#### ismemberdescriptor\n\nReturn true if the object is a member descriptor.\n\nMember descriptors are specialized descriptors defined in extension\nmodules.\n\n#### ismethod\n\nReturn true if the object is an instance method.\n\nInstance method objects provide these attributes:\ndoc         documentation string\nname        name with which this method was defined\nfunc        function object containing implementation of method\nself        instance to which this method is bound\n\n#### ismethoddescriptor\n\nReturn true if the object is a method descriptor.\n\nBut not if ismethod() or isclass() or isfunction() are true.\n\nThis is new in Python 2.2, and, for example, is true of int.add.\nAn object passing this test has a get attribute but not a set\nattribute, but beyond that the set of attributes varies.  name is\nusually sensible, and doc often is.\n\nMethods implemented via descriptors that also pass one of the other\ntests return false from the ismethoddescriptor() test, simply because\nthe other tests promise more -- you can, e.g., count on having the\nfunc attribute (etc) when an object passes ismethod().\n\n#### ismodule\n\nReturn true if the object is a module.\n\nModule objects provide these attributes:\ncached      pathname to byte compiled file\ndoc         documentation string\nfile        filename (missing for built-in modules)\n\n#### isroutine\n\nReturn true if the object is any kind of function or method.\n\n#### istraceback\n\nReturn true if the object is a traceback.\n\nTraceback objects provide these attributes:\ntbframe        frame object at this level\ntblasti        index of last attempted instruction in bytecode\ntblineno       current line number in Python source code\ntbnext         next inner traceback object (called by this level)\n\n#### signature\n\nGet a signature object for the passed callable.\n\n#### stack\n\nReturn a list of records for the stack above the caller's frame.\n\n#### trace\n\nReturn a list of records for the stack below the current exception.\n\n#### unwrap\n\nGet the object wrapped by *func*.\n\nFollows the chain of :attr:`wrapped` attributes returning the last\nobject in the chain.\n\n*stop* is an optional callback accepting an object in the wrapper chain\nas its sole argument that allows the unwrapping to be terminated early if\nthe callback returns a true value. If the callback never returns a true\nvalue, the last object in the chain is returned as usual. For example,\n:func:`signature` uses this to stop unwrapping if any object in the\nchain has a ``signature`` attribute defined.\n\n:exc:`ValueError` is raised if a cycle is encountered.\n\n#### walktree\n\nRecursive helper function for getclasstree().\n\n### DATA\n\nCOROCLOSED = 'COROCLOSED'\nCOROCREATED = 'COROCREATED'\nCORORUNNING = 'CORORUNNING'\nCOROSUSPENDED = 'COROSUSPENDED'\nCOASYNCGENERATOR = 512\nCOCOROUTINE = 128\nCOGENERATOR = 32\nCOITERABLECOROUTINE = 256\nCONESTED = 16\nCONEWLOCALS = 2\nCONOFREE = 64\nCOOPTIMIZED = 1\nCOVARARGS = 4\nCOVARKEYWORDS = 8\nGENCLOSED = 'GENCLOSED'\nGENCREATED = 'GENCREATED'\nGENRUNNING = 'GENRUNNING'\nGENSUSPENDED = 'GENSUSPENDED'\nTPFLAGSISABSTRACT = 1048576\nk = 512\nmoddict = {'ArgInfo': <class 'inspect.ArgInfo'>, 'ArgSpec': <class 'i...\nmodulesbyfile = {}\nv = 'ASYNCGENERATOR'\n\n### AUTHOR\n\n('Ka-Ping Yee <ping@lfw.org>', 'Yury Selivanov <yselivanov@sprymix.com>')\n\n### FILE\n\n/usr/lib/python3.10/inspect.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "inspect",
        "section": "",
        "mode": "pydoc",
        "summary": "inspect - Get useful information from live Python objects.",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "MODULE REFERENCE",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 27,
                "subsections": []
            },
            {
                "name": "CLASSES",
                "lines": 18,
                "subsections": [
                    {
                        "name": "class ArgInfo",
                        "lines": 121
                    },
                    {
                        "name": "class ArgSpec",
                        "lines": 121
                    },
                    {
                        "name": "class Arguments",
                        "lines": 118
                    },
                    {
                        "name": "class Attribute",
                        "lines": 121
                    },
                    {
                        "name": "class BlockFinder",
                        "lines": 18
                    },
                    {
                        "name": "class BoundArguments",
                        "lines": 63
                    },
                    {
                        "name": "class ClassFoundException",
                        "lines": 67
                    },
                    {
                        "name": "class ClosureVars",
                        "lines": 121
                    },
                    {
                        "name": "class EndOfBlock",
                        "lines": 67
                    },
                    {
                        "name": "class FrameInfo",
                        "lines": 122
                    },
                    {
                        "name": "class FullArgSpec",
                        "lines": 130
                    },
                    {
                        "name": "class Parameter",
                        "lines": 74
                    },
                    {
                        "name": "class Signature",
                        "lines": 90
                    },
                    {
                        "name": "class Traceback",
                        "lines": 119
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "classify_class_attrs",
                        "lines": 25
                    },
                    {
                        "name": "cleandoc",
                        "lines": 5
                    },
                    {
                        "name": "currentframe",
                        "lines": 2
                    },
                    {
                        "name": "findsource",
                        "lines": 7
                    },
                    {
                        "name": "formatannotation",
                        "lines": 1
                    },
                    {
                        "name": "formatannotationrelativeto",
                        "lines": 1
                    },
                    {
                        "name": "formatargspec",
                        "lines": 11
                    },
                    {
                        "name": "formatargvalues",
                        "lines": 7
                    },
                    {
                        "name": "get_annotations",
                        "lines": 44
                    },
                    {
                        "name": "getabsfile",
                        "lines": 5
                    },
                    {
                        "name": "getargs",
                        "lines": 7
                    },
                    {
                        "name": "getargspec",
                        "lines": 19
                    },
                    {
                        "name": "getargvalues",
                        "lines": 7
                    },
                    {
                        "name": "getattr_static",
                        "lines": 10
                    },
                    {
                        "name": "getblock",
                        "lines": 2
                    },
                    {
                        "name": "getcallargs",
                        "lines": 6
                    },
                    {
                        "name": "getclasstree",
                        "lines": 9
                    },
                    {
                        "name": "getclosurevars",
                        "lines": 6
                    },
                    {
                        "name": "getcomments",
                        "lines": 4
                    },
                    {
                        "name": "getcoroutinelocals",
                        "lines": 5
                    },
                    {
                        "name": "getcoroutinestate",
                        "lines": 8
                    },
                    {
                        "name": "getdoc",
                        "lines": 6
                    },
                    {
                        "name": "getfile",
                        "lines": 2
                    },
                    {
                        "name": "getframeinfo",
                        "lines": 8
                    },
                    {
                        "name": "getfullargspec",
                        "lines": 15
                    },
                    {
                        "name": "getgeneratorlocals",
                        "lines": 5
                    },
                    {
                        "name": "getgeneratorstate",
                        "lines": 8
                    },
                    {
                        "name": "getinnerframes",
                        "lines": 5
                    },
                    {
                        "name": "getlineno",
                        "lines": 2
                    },
                    {
                        "name": "getmembers",
                        "lines": 3
                    },
                    {
                        "name": "getmodule",
                        "lines": 2
                    },
                    {
                        "name": "getmodulename",
                        "lines": 2
                    },
                    {
                        "name": "getmro",
                        "lines": 2
                    },
                    {
                        "name": "getouterframes",
                        "lines": 5
                    },
                    {
                        "name": "getsource",
                        "lines": 6
                    },
                    {
                        "name": "getsourcefile",
                        "lines": 3
                    },
                    {
                        "name": "getsourcelines",
                        "lines": 8
                    },
                    {
                        "name": "indentsize",
                        "lines": 2
                    },
                    {
                        "name": "isabstract",
                        "lines": 2
                    },
                    {
                        "name": "isasyncgen",
                        "lines": 2
                    },
                    {
                        "name": "isasyncgenfunction",
                        "lines": 5
                    },
                    {
                        "name": "isawaitable",
                        "lines": 2
                    },
                    {
                        "name": "isbuiltin",
                        "lines": 7
                    },
                    {
                        "name": "isclass",
                        "lines": 6
                    },
                    {
                        "name": "iscode",
                        "lines": 23
                    },
                    {
                        "name": "iscoroutine",
                        "lines": 2
                    },
                    {
                        "name": "iscoroutinefunction",
                        "lines": 4
                    },
                    {
                        "name": "isdatadescriptor",
                        "lines": 8
                    },
                    {
                        "name": "isframe",
                        "lines": 12
                    },
                    {
                        "name": "isfunction",
                        "lines": 11
                    },
                    {
                        "name": "isgenerator",
                        "lines": 15
                    },
                    {
                        "name": "isgeneratorfunction",
                        "lines": 5
                    },
                    {
                        "name": "isgetsetdescriptor",
                        "lines": 5
                    },
                    {
                        "name": "ismemberdescriptor",
                        "lines": 5
                    },
                    {
                        "name": "ismethod",
                        "lines": 8
                    },
                    {
                        "name": "ismethoddescriptor",
                        "lines": 14
                    },
                    {
                        "name": "ismodule",
                        "lines": 7
                    },
                    {
                        "name": "isroutine",
                        "lines": 2
                    },
                    {
                        "name": "istraceback",
                        "lines": 8
                    },
                    {
                        "name": "signature",
                        "lines": 2
                    },
                    {
                        "name": "stack",
                        "lines": 2
                    },
                    {
                        "name": "trace",
                        "lines": 2
                    },
                    {
                        "name": "unwrap",
                        "lines": 14
                    },
                    {
                        "name": "walktree",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 24,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}