o Ďi@sUdZddgZddlmZddlmZddlmZddlZddl Z ddlZddl Z ddl Z ddl Z ddlZddlZddlmZmZmZmZmZmZmZmZmZddlZdd lmZdd lmZdd lm Z dd l!m"Z"m#Z#dd l$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8dZ9ee:eee:e:ffZ;eeddZ?ej@jAjZBeCjDjZEddejFejGej@eHfDZIeJeKZLeJe:jMZNe.ZOe"jPZQGd d!d!eZReSeRjd?Z`d@dAZad-ee:fdBdCZbdDdEZcGdFdde0Zdd-e:fdGdHZedS)KzTools for inspecting Python objects. Uses syntax highlighting for presenting the various information elements. Similar in spirit to the inspect module, but all calls take a name argument to reference the name under which an object is being read. Inspector InspectColors) dataclass) signature)dedentN) castAnyOptionalDictUnionList TypedDict TypeAliasTuple)page)pretty) skip_doctest) PyColorizeopenpy) safe_hasattr) compress_user)indent)list_namespace typestr2type) TermColors) Colorable)undoc) highlight) PythonLexer) HtmlFormatter__custom_documentations__UnformattedBundleBundlec@sJeZdZUeed<eed<eed<eeed<eed<eed<ddZd S) OInfoismagicisaliasfound namespaceparentobjcCs t||S)zGet a field from the object for backward compatibility with before 8.12 see https://github.com/h5py/h5py/issues/2253 )getattr)selffieldr-Q/home/jeff/fluffinator/venv/lib/python3.10/site-packages/IPython/core/oinspect.pygetKs z OInfo.getN) __name__ __module__ __qualname__bool__annotations__r strrr/r-r-r-r.r#Bs   r#cCst|ttddS)NT) noclasses)rrr)coder-r-r.pylight\sr8cCsh|]}t|qSr-)inspectgetdoc).0tr-r-r. bs r=c@seZdZUeeed<eeed<eeed<eeed<eeed<eeed<eeed<eeed<eeed <eeed <eeed <eeed <eeed <eeed<eeed<eed<eed<eed<eed<eed<dS)InfoDict type_name base_class string_formr'lengthfile definition docstringsourceinit_definitionclass_docstringinit_docstringcall_defcall_docstring subclassesr$r%isclassr&nameN)r0r1r2r r5r4r3r-r-r-r.r>ts*                r>cCs0|dkrtjdtddtStdtd|)N info_fieldszfIPython.core.oinspect's `info_fields` is considered for deprecation and may be removed in the Future.  stacklevelzmodule z has no attribute )warningswarnDeprecationWarning _info_fieldsAttributeErrorr0)rNr-r-r. __getattr__srXc@sBeZdZUdZeed<eeed<eed<e ed<e e ed<dS)InspectorHookDatazData passed to the mime hookr)info info_dict detail_level omit_sectionsN) r0r1r2__doc__rr4r r#r>intlistr5r-r-r-r.rYs  rYF)rMr%r$rNr&rMr%r$returnc sL|fddtD|d<|d<|d<|d<|d<td iS) z1Make an object info dict with all fields present.csi|] }|vr|dqSNr-)r;kinfodictr-r. szobject_info..rNr&rMr%r$Nr-)rVr>)rNr&rMr%r$kwr-rdr. object_infos rhcCstt|}|dur dS|drdStj|sdSt|d}t|j \}}Wd|S1s3wY|S)znGet encoding for python source file defining obj Returns None if obj is not defined in a sourcefile. Nz.soz.dllz.pydrb) find_fileendswithospathisfile stdlib_ioopenrdetect_encodingreadline)r)ofilebufferencoding_linesr-r-r. get_encodings   rxcCsBz|}Wn tyYn wt|trt|St|}|S)a=Stable wrapper around inspect.getdoc. This can't crash because of attribute problems. It also attempts to call a getdoc() method on the given object. This allows objects which provide their docstrings via non-standard mechanisms (like Pyro proxies) to still be inspected by ipython's ? system. )r: Exception isinstancer5r9cleandoc)r)dsdocstrr-r-r.r:s     r:c Cst|trTg}dD]A}t||}|durJt|}|rd|nd}|dd||ft|r>t|}|r=|t |q |d||t |fq |rRd|SdSt |}zt|}W|St yz t|j }WY|Stt fy~YYdSwtyYdSw)alWrapper around inspect.getsource. This can be modified by other projects to provide customized source extraction. Parameters ---------- obj : object an object whose source code we will attempt to extract oname : str (optional) a name under which the object is known Returns ------- src : unicode or None )fgetfsetfdelNz%s.r~z# z %s%s = %s  )rzpropertyr*rxappendjoinr9 isfunction getsourcerr _get_wrapped TypeError __class__OSError) r)onamesourcesattrnamefnrv oname_prefix_srcsrcr-r-r.rsD       rcCs(t|pt|pt|tpt|tS)zTrue if obj is a function ())r9rismethodrz_builtin_func_type_builtin_meth_typer)r-r-r.is_simple_callable)s rcCs2tjdtddt|drt|s|j}t|S)zWrapper around :func:`inspect.getfullargspec` In addition to functions and methods, this can also handle objects with a ``__call__`` attribute. DEPRECATED: Deprecated since 7.10. Do not use, will be removed. z]`getargspec` function is deprecated as of IPython 7.10and will be removed in future versions.rPrQ__call__)rSrTrUrrrr9getfullargspecrr-r-r. getargspec.s   rcCs0tjdtddt|d|d|d|dS)a Format argspect, convenience wrapper around inspect's. This takes a dict instead of ordered arguments and calls inspect.format_argspec with the arguments in the necessary order. DEPRECATED (since 7.10): Do not use; will be removed in future versions. za`format_argspec` function is deprecated as of IPython 7.10and will be removed in future versions.rPrQargsvarargsvarkwdefaults)rSrTrUr9 formatargspec)argspecr-r-r.format_argspec@s   rTc Cstjdtdd|d}|durd}n*z |dddk}Wn ttfy)Yn w|r6|dd d|d<|d t|}|d }|durL|d }|durV|d d}||fS)z?DEPRECATED since 6.0. Extract call tip data from an oinfo dict.zZ`call_tip` function is deprecated as of IPython 6.0and will be removed in future versions.rPrQrNrrr+rNrKrIrEr~)rSrTrUr/KeyError IndexErrorr)oinfo format_callr call_linehas_selfdocr-r-r.call_tipQs,    rcCs:|}d}t|dr|j}|d7}|dkr|St|ds |S)aNGet the original object if wrapped in one or more @decorators Some objects automatically construct similar objects on any unrecognised attribute access (e.g. unittest.mock.call). To protect against infinite loops, this will arbitrarily cut off after 100 levels of obj.__wrapped__ attribute access. --TK, Jan 2016 r __wrapped__rd)rr)r)orig_objir-r-r.rws  rc Csnt|}d}zt|}W|Sty-z t|j}WY|Sttfy,YY|Swty6Y|Sw)a^Find the absolute path to the file where an object was defined. This is essentially a robust wrapper around `inspect.getabsfile`. Returns None if no file can be found. Parameters ---------- obj : any Python object Returns ------- fname : str The absolute path to the file where the object was defined. N)rr9 getabsfilerrr)r)fnamer-r-r.rks"   rkc Csrt|}z t|d}W|Sty/z t|jd}WY|Sttfy.YYdSwty8YdSw)aWFind the line number in a file where an object was defined. This is essentially a robust wrapper around `inspect.getsourcelines`. Returns None if no file can be found. Parameters ---------- obj : any Python object Returns ------- lineno : int The line number where the object definition starts. rN)rr9getsourcelinesrrr)r)linenor-r-r.find_source_liness  rcseZdZejdddjddZeej ddddffdd Z d;d e e dffd d Z d e fd dZddZddZd;ddZedd)ed*e d+ee d,e!d#e ee e"d(fd ef d-d.Z#     (d?d+ee fd/d0Z$d@d1d2Z%d@d e&fd3d4Z'e(d5d6Z)gd7d7fd7d8d9d:Z*Z+S)ArTzKdictionary of mime to callable to add information into help mimebundle dict)confighelp)rNrcsJtt|j||d||_tjd||d|_|jj|_||_| |dS)N)r(rr5)outr(style) superr__init__ color_tablerParserparserformatstr_detail_levelset_active_scheme)r+rcode_color_tableschemerr(rrr-r.rs   zInspector.__init__r~racCs*t|sdSztt||WSYdS)zReturn the call signature for any callable object. If any exception is generated, None is returned instead and the exception is suppressed.N)callable_render_signaturer)r+r)rr-r-r._getdefs zInspector._getdefcCsd|jjj||jjjfS)z*Return a header string with proper colors.z%s%s%s)r active_colorsheadernormal)r+hr-r-r.__heads zInspector.__headcCs*|dur|j||jj|dSdSrb)rrr)r+rr-r-r.rs zInspector.set_active_schemecCs.td|dd|rtd|dStdS)z-Generic message when no information is found.z No %s found endzfor %sN)print)r+msgrr-r-r.noinfos zInspector.noinfocCsht|s tddSd}t|r|d}|||}|dur(|d|dSt|||dddS)zwPrint the call signature for any callable object. If the object is a class, print the constructor information.zObject is not callable.Nr~zClass constructor information: zdefinition headerrr)rrr9rM_Inspector__headrrr)r+r)rroutputr-r-r.pdefs   zInspector.pdefc Cs|j}g}t|}|r||d|}|r#||d|t|t|rEt|drEt|j}|durD||d|t|nt|dr_t|j }|r_||d|t||si| d|dSt d |dS) aPrint the docstring for any object. Optional: -formatter: a function to run the docstring through for specially formatted docstrings. Examples -------- In [1]: class NoInit: ...: pass In [2]: class NoDoc: ...: def __init__(self): ...: pass In [3]: %pdoc NoDoc No documentation found for NoDoc In [4]: %pdoc NoInit No documentation found for NoInit In [5]: obj = NoInit() In [6]: %pdoc obj No documentation found for obj In [5]: obj2 = NoDoc() In [6]: %pdoc obj2 No documentation found for obj2 z plain/textzClass docstring:rNzInit docstring:rzCall docstring: documentationr) rr:r/rrr9rMhasattrrrrrr) r+r)r formatterheadlinesr|init_dscall_dsr-r-r.pdocs,"   zInspector.pdoccCs\tzt||d}Wn tyd}Ynw|dur$|d|dSt||dS)z$Print the source code for an object.)rNrF) linecache checkcacherryrrr)r+r)rrr-r-r.psourcePs zInspector.psourcecCst|}|dur|d|dSt|}|durtddS|dr+td|dStj|s9td|dSt| t j |dd|d dS) z0Show the whole file where an object was defined.NrCzCould not find file for objectriz File %r is binary, not printing.z%File %r does not exist, not printing.F)skip_encoding_cookier) rrrkrrlrmrnrorrr read_py_file)r+r)rrrtr-r-r.pfile_s    $zInspector.pfiletextcCsX|dt|dd}|dur|S||}t|ts$|d|ddSt|fi|S)aRReturn a mime bundle representation of the input text. - if `formatter` is None, the returned mime bundle has a ``text/plain`` field, with the input text. a ``text/html`` field with a ``
`` tag containing the input text.

        - if ``formatter`` is not None, it must be a callable transforming the
          input text into a mime bundle. Default values for ``text/plain`` and
          ``text/html`` representations are the ones described above.

        Note:

        Formatters returning strings are supported but this behavior is deprecated.

        z
z

text/plain	text/htmlN)htmlescaperzdict)r+rrr	formattedr-r-r._mime_formatxs
zInspector._mime_formatbundlec
CsBt|dts	J|dD]	}t|tsJq
i}g}tdd|dD}|dD])\}}|d}d|vr9dnd}|||d|t|d||q*d||d<d|vrt|dtshJ|dD]	}t|tsuJqlt|dttfrddd|dD|d<|	D]
}	|	d	vrq||	||	<q|S)
zRFormat a mimebundle being created by _make_info_unformatted into a real mimebundlercss|]	\}}t|VqdSrblen)r;r_r-r-r.	z(Inspector.format_mime..rr:rcss$|]
\}}d|d|VqdS)z
z

Nr-)r;rbodyr-r-r.rs")rr)
rzr`tuplemaxstriprrrrkeys)
r+ritemnew_br_lenrrdelimrcr-r-r.format_mimes4
(zInspector.format_mimetitlekeyr]c	Csd||vs||vr
dS||}|dur0|||}|d||df|d||dfdSdS)z^Append an info value to the unformatted mimebundle being constructed by _make_info_unformattedNrr)rr)	r+rrrrZr]rr,formatted_fieldr-r-r._append_info_fields
zInspector._append_info_fieldc	sggd}	d-dtdtdtffdd
}dtffd	d
}dr+||dd
|SdrJ|dkr;||dd|n||dd|||dd|SdsRt|r||dd|||dd|||dd||dkrwdrw||dd|n||dd|||dd||dd||dd |S||dd|||d!d"|||dd||d#d
d$d%kr||d&d$||d'd(||dd|dkrԈdr||dd|n||dd|||d)d*|||dd|||d+d,||S).z;Assemble the mimebundle as unformatted lists of informationrNrrrcsj||||ddS)N)rrrZr]r)r)rrrrrZr]r+r-r.append_fields
z6Inspector._make_info_unformatted..append_fieldracs|t|dS)Nr)rr8)r)r+r-r.code_formattersz8Inspector._make_info_unformatted..code_formatterr%ReprrAr$rSourcerF	DocstringrEFilerCrM	SignaturerDzInit signaturerGzInit docstringrITyper?
SubclassesrLzCall signaturerJzString formr'Interactive	NamespaceLengthrBzClass docstringrHzCall docstringrKrb)r!r5r"r)	r+r)rZrr\r]rrrr-rr._make_info_unformatteds^/(z Inspector._make_info_unformattedr-r)rrZr\cCs|j||||d}t|}|j|||||d}|jrZt|||||d}	|jD]1\}
}ddt|j	D}t
|dkrD||	}
n
tjdt
dd	|||}
|
d
urY|
||
<q(||S)a4Retrieve an info dict and format it.

        Parameters
        ----------
        obj : any
            Object to inspect and return info from
        oname : str (default: ''):
            Name of the variable pointing to `obj`.
        formatter : callable
        info
            already computed information
        detail_level : integer
            Granularity of detail level, if set to 1, give more information.
        omit_sections : list[str]
            Titles or keys to omit from output (can be set, tuple, etc., anything supporting `in`)
        rrZr\)r\r])r)rZr[r\r]cSsg|]}|jtjjkr|qSr-)defaultr9	Parameter)r;	parameterr-r-r.
Ns
z'Inspector._get_info..rzMIME hook format changed in IPython 8.22; hooks should now accept a single parameter (InspectorHookData); support for hooks requiring two-parameters (obj and info) will be removed in a future versionrPrQN)rZr`r

mime_hooksrYitemsr9r
parametersvaluesrrSrTrUr)r+r)rrrZr\r]r[r	hook_datarhookrequired_parametersresr-r-r.	_get_info!sB


zInspector._get_infoc	Cs:|dusJ|j||||||d}|s|d=t|dS)a Show detailed information about an object.

        Optional arguments:

        - oname: name of the variable pointing to the object.

        - formatter: callable (optional)
              A special formatter for docstrings.

              The formatter is a callable that takes a string as an input
              and returns either a formatted string or a mime type bundle
              in the form of a dictionary.

              Although the support of custom formatter returning a string
              instead of a mime type bundle is deprecated.

        - info: a structure with some information fields which may have been
          precomputed already.

        - detail_level: if set to 1, more information is given.

        - omit_sections: set of section keys and titles to omit
        N)r]r)rr)	r+r)rrrZr\enable_html_pagerr]info_br-r-r.pinfobs!zInspector.pinfocCs"tjdtdd|j||||dS)z
        Inspector.info() was likely improperly marked as deprecated
        while only a parameter was deprecated. We "un-deprecate" it.
        zThe `Inspector.info()` method has been un-deprecated as of 8.0 and the `formatter=` keyword removed. `Inspector._info` is now an alias, and you can just call `.info()` directly.rPrQr)rSrTrUrZ)r+r)rrZr\r-r-r._infoszInspector._infoc 	Cs,|durd}d}d}n	|j}|j}|j}|dd}d}	d}
|r8|jdur8t|jtr8t|jt}||d}	t	t
iddtD|d||dd	}|	rQ|	}
n8|r|t|skzd
|d}
Wn)dt
|}
Ynd
t
|}
|jr{|
d|j7}
n
t|}|durd}
n|}
|
|
}
d}t|dd}|rd|d<n|rd|d<nt|j|d<z|j}t
||d<WnY||jkrz6t
|}|st||kr|d|d||d}ddtddd|dD}||d<WnY|r||d<z
t
t||d<Wn
tyYnwd}t|}|dur&d}n|dr/d}n|d r7d!}t||d"<|rltzt|tsN|s`t ||}|dur\|!}||d#<Wn
tykYnw|
r}|"|d#|
s}|
|d$<t#$|rd|d%<z|%||}Wnt&yd}Ynwz|j'}Wnt&yd}Yn$w|durz|%||}Wn
t&yYnwt|}|t(krd}|r||d&<|r||d'<d(d)t)|D}t|d*krd+|}nd+|dd*d,g}||d-<|S|%||}|r||d.<|
r>zt|d/}Wnd}Ynt|}|t*vr2d}|r>|
|kr>||d0<zt|j'}|t(krKd}Wnt&yXd}Ynw|r`||d'<t+|d1rt,|s|%|j-|}|r||d.kr||d2<t|j-}|t.krd}|r||d3<|S)4asCompute a dict with detailed information about an object.

        Parameters
        ----------
        obj : any
            An object to find information about
        oname : str (default: '')
            Name of the variable pointing to `obj`.
        info : (default: None)
            A struct (dict like with attr access) with some information fields
            which may have been precomputed already.
        detail_level : int (default:0)
            If set to 1, more information is given.

        Returns
        -------
        An object info dict with known fields from `info_fields` (see `InfoDict`).
        NFr~.cSsi|]}|dqSrbr-)r;r,r-r-r.rfz"Inspector.info..T)rNr&r%r$rLz!Alias to the system command:
  %srzAlias: z	Alias to z
Docstring:
zrPzMagic functionr?zSystem aliasr@z <...> rrrAcss|]}|VqdSrb)r)r;qr-r-r.rs
z!Inspector.info..r'rBrizz9Dynamically generated function. No source code available.rCrFrErMrGrIcSsg|]}|jqSr-)r0)r;subr-r-r.rNr"z"Inspector.info..
, z...rLrDrrHrrJrK)/r$r%r'splitr(r	HOOK_NAMEr*r/rr>rVrr5r^r:r_typer0rrr
expandtabsrryrkrlrrrrzrrrstrip_source_contains_docstringr9rMrrWr_object_init_docstring__subclasses___builtin_type_docstringsrrr_func_call_docstring) r+r)rrZr\r$r%ospaceatt_nameparents_docspreludeparents_docs_dictrr|
ds_or_None
string_maxshalfbclassostrbinary_filerrinit_defobj_initrnames	all_namesdeflnclsclass_dsrJrr-r-r.rZs@








2




zInspector.infocCs8ztt|j\}t||kWStyYdSw)z
        Check whether the source *src* contains the docstring *doc*.

        This is is helper function to skip displaying the docstring if the
        source already contains it, avoiding repetition of information.
        F)astparserr
get_docstringry)rrdef_noder-r-r.r.sz$Inspector._source_contains_docstringF)
list_typescCsd}d}|rtdttdS|}	t|	}
|
dkr#|	d}n|
dkr,|	\}}ntd||D]}||vrDtd	||fq4tt}}
|D]"}||}t	||
vr[qN|
t	|t|||||d
}||qNtdt|dS)aSearch namespaces with wildcards for objects.

        Arguments:

        - pattern: string containing shell-like wildcards to use in namespace
          searches and optionally a type specification to narrow the search to
          objects of that type.

        - ns_table: dict of name->namespaces for search.

        Optional arguments:

          - ns_search: list of namespace names to include in search.

          - ignore_case(False): make the search case-insensitive.

          - show_all(False): show all names, including those starting with
            underscores.

          - list_types(False): list all available object types for object matching.
        allr~rNrrrPz)invalid argument string for psearch: <%s>z'invalid namespace <%s>. Valid names: %s)ignore_caseshow_all)
rrsortedrr)r
ValueErrorrsetidaddrupdate)r+patternns_table	ns_searchrKrLrItype_patternfiltercmdslen_cmdsrN
search_resultnamespaces_seenns_namenstmp_resr-r-r.psearchs>


zInspector.psearchr~)r~Nrb)r~NNrr-)r~NNrTr-)r~Nr),r0r1r2	traitletsr
tagrrrANSICodeColorsrrr5rrrrrrrrrrrr!r"rrrr
rr	r#r_rrrrr>rZstaticmethodr.r_
__classcell__r-r-rr.rs

9
"&

R
D

)n
cCs
g}d}d}|jD]6}|jtjjkrd}n	|r |dd}|jtjjkr*d}n|jtjjkr:|r:|dd}|t	|q|rI|dt
|tdd|Ddkrgd|d	
d
d|D}n	d|d
|}|jtjurt|j}|d
|7}|S)z
    This was mostly taken from inspect.Signature.__str__.
    Look there for the comments.
    The only change is to add linebreaks when this gets too long.
    FT/*css|]	}t|dVqdS)rPNrr;rr-r-r.rrz$_render_signature..Kz{}(
{})r~css|]}d|VqdS)z    {},
N)rrhr-r-r.rs

z{}({})r(z -> {})rrkindr9rPOSITIONAL_ONLYrVAR_POSITIONALKEYWORD_ONLYr5rsumrrreturn_annotation_emptyformatannotation)
obj_signatureobj_nameresultpos_onlykw_onlyparamrenderedannor-r-r.rs4


rr`)T)fr^__all__dataclassesrr9rtextwraprrEriorprrmtypesrStypingrrr	r
rrr
rrraIPython.corerIPython.lib.prettyrIPython.testing.skipdoctestr
IPython.utilsrrIPython.utils.dir2rIPython.utils.pathrIPython.utils.textrIPython.utils.wildcardrrIPython.utils.coloransirIPython.utils.colorablerIPython.utils.decoratorsrpygmentsrpygments.lexersrpygments.formattersrr*r5r!r4r"r#r8FunctionTyperr2objectrr/
ModuleType
MethodTyperr1r+rJrupperrColorsrcrr>r`rrVrXrYr3rhrxr:rrrrrrrkrrrr-r-r-r.s, 


?

%#