o ˷e@sNdZddgZddlZddlZddlmZddlZddlZddlZddlm Z ddl Z ddl Z ddl mZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlm Z ddlm!Z!ddl"m#Z#m$Z$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddZ2e j3j4jZ5e6j7jZ8dde j9e j:e j3e;fDZZ?e=e@jAZBe#ZCejDZEgdZFdd ZGd!d"ZHd#ee@dffd$d%ZId;d#ee@dffd'd(ZJd)d*ZKe+d+d,ZLe+d-d.ZMe+d7s r$) type_name base_class string_form namespacelengthfile definition docstringsourceinit_definitionclass_docstringinit_docstringcall_defcall_docstringismagicisaliasisclassfoundnamecKsddtD}|||S)z1Make an object info dict with all fields present.cSsi|]}|dqSNr)r"krrr Vzobject_info..) info_fieldsupdate)kwinfodictrrr object_infoTs r@cCstt|}|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_ioopenr detect_encodingreadline)objofilebufferencodinglinesrrr get_encoding[s   rQreturncCsBz|}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 isinstancestrr cleandoc)rLdsdocstrrrrr!rs     r!c Cs t|trPg}dD]=}t||}|durFt|}|rd|nd}|dd||ft|r:|tt |q |d||t |fq |rNd|SdSt |}zt |}W|St y{z t |j }WY|Stt fyzYYdSwtyYdSw)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.rYz# z %s%s = %s  )rTpropertygetattrrQappendjoinr isfunctionr getsourcer _get_wrapped TypeError __class__OSError)rLonamesourcesattrnamefnrO oname_prefixsrcrrrrcs>       rccCs(t|pt|pt|tpt|tS)zTrue if obj is a function ())r rbismethodrT_builtin_func_type_builtin_meth_typerLrrris_simple_callables rrcCs2tjdtddt|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. stacklevel__call__)warningswarnDeprecationWarningr rrrvr getfullargspecrqrrr getargspecs   r{cCs0tjdtddt|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.rsrtargsvarargsvarkwdefaults)rwrxryr formatargspec)argspecrrrformat_argspecs   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.rsrtrNr|rselfr7r2r0r,rY)rwrxrygetKeyError IndexErrorr)oinfo format_callr call_linehas_selfdocrrrcall_tips,    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)r r)rLorig_objirrrrds  rdc Cst|}d}z t|}Wt|Sty5zt|j}Wn ttfy*YnwYt|SYt|Sty@Yt|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)rdr getabsfilererfrgr)rLfnamerrrrC#s&   rCc 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)rdr getsourcelinesrerfrg)rLlinenorrrfind_source_linesFs  rcseZdZeejddddffdd Zd,deedffddZ defd d Z d d Z d dZ d,ddZ ed-ddZd,ddZd,ddZd.dedefddZddZ d/ddZ      d0d d!Zd1d"d#Zd1defd$d%Zed&d'Zgd(d(fd(d)d*d+ZZS)2rNrcsJtt|j||d||_tjd||d|_|jj|_||_| |dS)N)parentconfigrU)outrstyle) superr__init__ color_tabler Parserparserformatstr_detail_levelset_active_scheme)rrcode_color_tableschemerrrrfrrrgs  zInspector.__init__rYrRcCsztt||WSYdS)zReturn the call signature for any callable object. If any exception is generated, None is returned instead and the exception is suppressed.N)_render_signaturer)rrLrhrrr_getdefsszInspector._getdefcCsd|jjj||jjjfS)z*Return a header string with proper colors.z%s%s%s)r active_colorsheadernormal)rhrrr__head}s zInspector.__headcCs*|dur|j||jj|dSdSr8)rrr)rrrrrrs zInspector.set_active_schemecCs.td|dd|rtd|dStdS)z-Generic message when no information is found.z No %s found endzfor %sN)print)rmsgrhrrrnoinfos 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.NrYzClass constructor information: zdefinition headerrr)callablerr r5_Inspector__headrrr)rrLrhroutputrrrpdefs   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:rvzCall docstring: documentationr]) rr!rr`rr r5hasattrrrvrrra) rrLrh formatterheadrPrWinit_dscall_dsrrrpdocs,"   zInspector.pdoccCs\tzt||d}Wn tyd}Ynw|dur$|d|dSt||dS)z$Print the source code for an object.)rhNr-) linecache checkcachercrSrrr)rrLrhrmrrrpsources zInspector.psourcecCst|}|dur|d|dSt|}|dr!td|dStj|s/td|dSt| t j |dd|ddS) z0Show the whole file where an object was defined.Nr*rAz File %r is binary, not printing.z%File %r does not exist, not printing.F)skip_encoding_cookier) rrrCrDrrErFrGrrr read_py_file)rrLrhrrMrrrpfiles   $zInspector.pfiletextcCsR|d|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)rTdict)rrrr	formattedrrr_mime_formats


zInspector._mime_formatc
Cs|d}d}tt|\}}tdd|D}t||D](\}}|d}d|vr+dnd}	|||d|t|d|	|d7}q||d<|S)NrrYcss|]}t|VqdSr8len)r"rrrr	1z(Inspector.format_mime..r]r:)listzipmaxstriprr)
rbundle
text_plainrheadsbodies_lenrbodydelimrrrformat_mime+s
0zInspector.format_mimerc
sj|||dgdd}d-dtdtffdd
}fd	d
}	dr-||dd
nÈdrK|dkr=||dd|	n||dd|||ddndsSt|r||dd|	||dd|	||dd||dkrxdrx||dd|	n||dd|||dd||dd||dd n^||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).a9Retrieve 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 : container[str]
            Titles or keys to omit from output (can be set, tuple, etc., anything supporting `in`)
        rhinfodetail_levelrYrNtitlekeycsr|vs|vr
dS|}|dur7||}|d||df|dd|d|dd7<dSdS)Nrrz
z

r])rr`)rrrrfieldformatted_fieldr
omit_sectionsrrrappend_fieldVs(z)Inspector._get_info..append_fieldcs|t|dS)Nr)rr)r)rrrcode_formatter_sz+Inspector._get_info..code_formatterr4Reprr'r3rSourcer-	Docstringr,Filer*r5	Signaturer+zInit signaturer.zInit docstringr0Typer%
Subclasses
subclasseszCall signaturer1zString formr(Interactive	NamespaceLengthr)zClass docstringr/zCall docstringr2r8)rrUrrr)
rrLrhrrrr_mimerrrrr	_get_info;sL	
zInspector._get_infoTcCs.|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
        )rrN)rr)rrLrhrrrenable_html_pagerrrrrpinfos!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.rsrtr)rwrxryr)rrLrhrrrrr_infoszInspector._infocCs|durd}d}d}n	|j}|j}|j}|r?t|s.zd|d}Wn&dt|}Yndt|}|jr>|d|j7}n
t|}|durId	}t|d
||dd}	d}
t|
d
d}|rcd|	d<n|rjd|	d<nt	|j
|	d<z|j}t||	d<WnY||jkrz8t|}
d}|st
|
|
kr|
d|d|
|d}
ddt
|dd|
dD}
|
|	|<WnY|r||	d<z
tt
||	d<Wn	tyYnwd}t|}|durd
}n|drd
}n|drd}t||	d<|r.tzt|ts|s"t||}|dur|}||	d<Wn
ty-Ynw|r?||	d|s?||	d <t|rd
|	d!<z|||}Wnt y]d}Ynwz|j!}Wnt yod}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)<n|||}|r||	d*<|rzt$|d+}Wnd}Ynt|}|t%vrd}|r||kr||	d,<zt|j!}|t"krd}Wnt yd}Ynw|r!||	d#<t&|d-rUt'|sU||j(|}|rB||	d*krB||	d.<t|j(}|t)krNd}|rU||	d/<t*d0i|	S)1aCompute 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`. Keys are
        strings, values are string or None.
        NFrYz!Alias to the system command:
  %srzAlias: z	Alias to z
Docstring:
zT)r7r6r4r3rrszMagic functionr%zSystem aliasr&r'z <...> r]rcss|]}|VqdSr8)r)r"qrrrrrz!Inspector.info..r(r)rAzz9Dynamically generated function. No source code available.r*r-r,r5r.r0cSsg|]}|jqSr)__name__)r"subrrr
jr;z"Inspector.info..
, z...rr+rfr/rvr1r2r)+r3r4r(rrU__doc__r!rinttyperrfrr
expandtabsrasplitrSrCrDrrrrTr^rcrstrip_source_contains_docstringrr r5rAttributeErrorr_object_init_docstring__subclasses__r__builtin_type_docstringsr
rrrv_func_call_docstringr@)rrLrhrrr3r4ospacerWr
string_maxshalfbclassostrstr_headbinary_filerrminit_defobj_initrnames	all_namesdeflnclsclass_dsr1rrrrrs















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_docstringrS)rmrdef_noderrrrs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.
        allrYr]Nrrrsz)invalid argument string for psearch: <%s>z'invalid namespace <%s>. Valid names: %s)ignore_caseshow_all)
rrasortedrrr
ValueErrorkeyssetidaddrr=)rpatternns_table	ns_searchrr rtype_patternfiltercmdslen_cmdsr7
search_resultnamespaces_seenns_namenstmp_resrrrpsearchs>


zInspector.psearchrY)rYNr8)rYNNrr)rYNNrTr)rYNr)r
__module____qualname__rr
ANSICodeColorsrrrUrrrrrr	rrrrrrrrrrstaticmethodrr3
__classcell__rrrrresJ


9
&
a

(T
cCsg}d}d}|jD]3}|jtjkrd}n	|r|dd}|jtjkr(d}n|jtjkr7|r7|dd}|t|q|rF|dt	|t
dd|Ddkrdd|d	d
d|D}n	d|d|}|j
tjurt|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)rsNrr"rrrrrsz$_render_signature..Kz{}(
{})rYcss|]}d|VqdS)z    {},
N)rr<rrrrs

z{}({})rz -> {})
parametersvalueskindr _POSITIONAL_ONLYr`_VAR_POSITIONAL
_KEYWORD_ONLYrUrsumrrareturn_annotation_emptyformatannotation)
obj_signatureobj_nameresultpos_onlykw_onlyparamrenderedannorrrrs4


rr4)T)Tr__all__rr rrrwrEtextwraprtypesiorHtypingrIPython.corerIPython.lib.prettyrIPython.testing.skipdoctestr	
IPython.utilsr
rrIPython.utils.dir2r
IPython.utils.pathrIPython.utils.textrIPython.utils.wildcardrrIPython.utils.coloransirrrIPython.utils.py3compatrIPython.utils.colorablerIPython.utils.decoratorsrpygmentsrpygments.lexersrpygments.formattersrrFunctionTypervr
objectrr
ModuleType
MethodTyper^r	rrrorUupperrpColorsr7rr<r@rQr!rcrrr{rrrdrCrrrrrrrs


<

%#