,]c@sdZddlZddljZddlZddlZddlmZddl m Z m Z m Z m Z ddlmZmZmZmZmZmZmZmZmZmZmZmZddlmZmZddlmZddl m!Z!m"Z"m#Z#dd l$m%Z%dd l&m'Z'dd l(m)Z)dd l*m+Z+m,Z,dd l-m.Z/ddl-m0Z0ddl1m2Z2m3Z3m4Z4m5Z5m6Z6ddl7m8Z8m9Z9m:Z:m;Z;ddl<m=Z=ddl>m?Z?ddl@mAZAddlBmCZCejDde!dddde?fdYZEde)fdYZFdefdYZGdefd YZHd!e fd"YZId#e'fd$YZJdS(%s Help PluginiN(tPYQT5(tQThreadtQUrltSignaltSlot( t QActionGroupt QComboBoxt QGroupBoxt QHBoxLayouttQLabelt QLineEdittQMenut QMessageBoxt QSizePolicyt QToolButtont QVBoxLayouttQWidget(tQWebEnginePaget WEBENGINE(t dependencies(t_t get_conf_pathtget_module_source_path(tDEFAULT_SMALL_DELTA(tSpyderPluginWidget(tPluginConfigPage(tget_meth_class_insttto_text_string(t icon_manager(tprograms(tCSS_PATHtgenerate_contextt sphinxifytusagetwarning(t add_actionst create_actiontcreate_toolbuttontcreate_plugin_layout(t FrameWebView(tEditableComboBox(t FindReplace(t codeeditortsphinxsDShow help for objects in the Editor and Consoles in a dedicated panetrequired_versions>=0.6.6tObjectComboBoxcBsGeZdZeeeZdZddZdZ e dZ RS(s) QComboBox handling object names cCsJtj||||_|jtjtjidt6dt6|_ dS(Nt( R(t__init__thelpt setSizePolicyR t ExpandingtFixedtTruetFalsettips(tselftparent((s2lib/python2.7/site-packages/spyder/plugins/help.pyR/8s cCs2|jjstS|dkr.|j}ntjdt|dsMtSt |}t}|jj dr|jj }|dk r|j |dt}qn|s.|jj }|dk r.y|j |}Wq+tjk r'|jj }y|j |}Wq(tjk r#q(Xq+Xq.n|S(sReturn True if string is valids^[a-zA-Z0-9_\.]*$itautomatic_importt force_importN(R0tsource_is_consoleR4tNonet currentTexttretsearchtstrR5Rt get_optiontinternal_shellt is_definedt get_shelltsocketterror(R7tqstrtobjtxttshell_is_definedtshell((s2lib/python2.7/site-packages/spyder/plugins/help.pytis_valid>s0     cCs|j|jdS(N(tvalidateR=(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytvalidate_current_textZscCs|j|}|jr|dk r|r^| r^|j|j||jjttq|r|j|j j tq|jjttndS(s)Reimplemented to avoid formatting actionsN( RKthasFocusR<tshow_tipR6tvalidtemitR5tselectedtlineEdittcursorWordForward(R7RGteditingRP((s2lib/python2.7/site-packages/spyder/plugins/help.pyRL]s  N( t__name__t __module__t__doc__RtboolRPR/R<RKRMR4RL(((s2lib/python2.7/site-packages/spyder/plugins/help.pyR-1s    tHelpConfigPagecBseZdZRS(cCsLttd}ttd}|jt|jtdd}tjd}tjdd}|j|py|| r| rtd}|j |n|jtd d }t }|j ||j ||j ||j |ttd } |jtd d } tjdd} | j| | stj d} td} | dtd| 7} | j | nt }|j | | j |ttd}|jtdd}t }|j ||j |t }|j ||j | |j ||jd|j |dS(NsAutomatic connectionssThis pane can automatically show an object's help information after a left parenthesis is written next to it. Below you can decide to which plugin you want to connect it to turn on this feature.tEditorsconnect/editortropetjedis>=0.8.1s[This feature requires the Rope or Jedi libraries. It seems you don't have either installed.sIPython Consolesconnect/ipython_consolesAdditional featuressRender mathematical equationstmathR+s>=1.1s-This feature requires Sphinx 1.1 or superior.s s!Sphinx %s is currently installed.s Source codes Wrap linestwrapi(RRR t setWordWrapR4tcreate_checkboxRtis_module_installedt setEnabledt setToolTipRt addWidgett setLayouttget_module_versiont addStretch(R7tconnections_grouptconnections_labelt editor_boxtrope_installedtjedi_installedt editor_tipt ipython_boxtconnections_layouttfeatures_grouptmath_boxt req_sphinxt sphinx_vert sphinx_tiptfeatures_layouttsourcecode_groupt wrap_mode_boxtsourcecode_layouttvlayout((s2lib/python2.7/site-packages/spyder/plugins/help.pyt setup_pageqsR                      (RVRWR{(((s2lib/python2.7/site-packages/spyder/plugins/help.pyRZpstRichTextcBs5eZdZdZddZdZdZRS(s) WebView widget with find dialog cCstj||t||_t||_|jj|jj|jjt }|j dddd|j |j|j |j|j |dS(Ni( RR/R'twebviewR)t find_widgett set_editort web_widgetthideRtsetContentsMarginsReRf(R7R8tlayout((s2lib/python2.7/site-packages/spyder/plugins/help.pyR/s  cCs|jj|d|dS(sSet fontt fixed_fontN(R}tset_font(R7tfontR((s2lib/python2.7/site-packages/spyder/plugins/help.pyRscCs|jj||dS(s Set html textN(R}tsetHtml(R7t html_texttbase_url((s2lib/python2.7/site-packages/spyder/plugins/help.pytset_htmlscCs|jd|jjdS(NR.(RR}turl(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytclearsN(RVRWRXR/R<RRR(((s2lib/python2.7/site-packages/spyder/plugins/help.pyR|s    t PlainTextcBsGeZdZeZdZddZdZdZ dZ RS(s2 Read-only editor widget with find dialog c stj|d_tj_jjdtdddtdtjjj fdjj t t _ j jjj jt}|jdddd|jj|jj j|dS(Nt linenumberstlanguagetpytscrollflagareat edge_linecs jjS(N(t focus_changedRQ((R7(s2lib/python2.7/site-packages/spyder/plugins/help.pytR.i(RR/R<teditorR*t CodeEditort setup_editorR5Rtconnectt setReadOnlyR4R)R~RRRRReRf(R7R8R((R7s2lib/python2.7/site-packages/spyder/plugins/help.pyR/s    cCs|jj|d|dS(sSet fontt color_schemeN(RR(R7RR((s2lib/python2.7/site-packages/spyder/plugins/help.pyRscCs|jj|dS(sSet color schemeN(Rtset_color_scheme(R7R((s2lib/python2.7/site-packages/spyder/plugins/help.pyRscCsm|jj||jj||r9|jjdn|jjd|jj||jjddS(NRtsof(Rtset_highlight_current_linetset_occurrence_highlightingt set_languageR<tset_texttset_cursor_position(R7ttexttis_code((s2lib/python2.7/site-packages/spyder/plugins/help.pyRscCs|jjdS(N(RR(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pyRsN( RVRWRXRRR/R<RRRR(((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs     t SphinxThreadcBsMeZdZeeZeeZddZde ddZ dZ RS(s& A worker thread for handling rich text rendering. Parameters ---------- doc : str or dict A string containing a raw rst text or a dict containing the doc string components to be rendered. See spyder_kernels.utils.dochelpers.getdoc for description. context : dict A dict containing the substitution variables for the layout template html_text_no_doc : unicode Text to be rendered if doc string cannot be extracted. math_option : bool Use LaTeX math rendering. R.cCs;tt|jd|_d|_||_t|_dS(N( tsuperRR/R<tdoctcontextthtml_text_no_docR5t math_option(R7R((s2lib/python2.7/site-packages/spyder/plugins/help.pyR/s    cCsA|jr=||_||_||_||_|jndS(s,Start thread to render a given documentationN(twaitRRRtimg_pathtstart(R7RRRR((s2lib/python2.7/site-packages/spyder/plugins/help.pytrenders      c Cs|j}|j}|dk rt|tkr)d|jkr)ytd|dd|dd|dd|jd|j}t |d|}|ddkrt |d|d|dgrt d}|d 7}n t d }|d |7}nWq~t k r%}|j jt|dSXq|jdk ryt ||j}Wq~t k rz}|j jt|dSXqn|jj|dS( Nt docstringtnametargspectnoteR^RR.s"No further documentation availables
sNo documentation availables
%s
(RRR<ttypetdicttkeysRRRR tanyRt Exceptiont error_msgRQRRt html_ready(R7RRRtmsgRF((s2lib/python2.7/site-packages/spyder/plugins/help.pytrun(s6   $    !    N( RVRWRXRR@RRR/R<R5RR(((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs     tHelpcBseZdZdZeZeeZeZ e Z d7dZ dZdZdZdZdZdZed Zd Zd Zd Zd ZdZdZd7dZdZdZedZ dZ!d7dZ"dZ#e$e%dZ&dZ'dZ(dZ)dZ*dZ+dZ,dZ-dZ.ed d!Z/d"Z0e$d#Z1d$Z2e$e$e%e$e%e%e3e3d%Z4eed&Z5ed'Z6ed(Z7d7d)Z8d*Z9e$e%d+Z:e$e%d,Z;e$e%d-Z<e$e%d.Z=e$d/Z>d0Z?d1Z@d2ZAd7d3ZBd4ZCd5ZDed6ZERS(8s" Docstrings viewer widget R0c Cstrtj||d|ntj||d|_d|_|jtd|_d|_ d|_ t ||_ t ||_|j}|j|j||j jj|jdt|tdd|j|_|jj|jd|j jjjt|j jj|jf|j|jdd|_t|_ddg|_d|_ t!}|j"ddddtd}t#j$d krt%d |}n t%|}|j&|t'||_(|j(j)td td g|j(j*j+|j,t-j.d  r[t-j.dd r[|j(j/|j/n|j&|j(|j0d|j&t%tdt1||_2|j&|j2t3||_4|j4j5t6|j&|j4|j2j7|jd|j2j)|j8|j2j9dd|j2j:j+|j;t6|_<|jdt6|_=t|tdd|j>|_?t|tdd|j@|_At|tdd|jB|_CtD|}|jEt6|jF|j?|jF|jCt|tdd|jG|_H|jd}|jHj|tI|d|jJ|_K|j&|jK|jLtI|dtddtMjNd}|jOtPjQtR|} t| |jC|j?|jAd|jHg|jS| |j&||j=r|jTn |jU|j?j|j= |jCj|j=|j,tV|} | j&|j | j&|j|jW| tXdtY|j|_Z|jZj[j+|j\|jZj]j+|j^|jj_} t`s| jajbtcjdn| jej+|jft6|_gdS( NtmainsNo documentation availableR_s Wrap linesttoggledt rich_textitSourcetdarwins tConsoleR[R\R]s>=0.8.1i tObjecttmax_history_entriesR.t rich_modes Plain Texts Show Sources Rich TextsAutomatic importR9t triggeredRtOptionsticont tooloptionsR(hRRR/R<RBtconsoletinitialize_pluginRt no_doc_stringt_last_console_cbt_last_editor_cbRt plain_textR|Rtget_color_schemetset_plain_text_fonttget_plugin_fontRttoggle_wrap_modeRAR$t wrap_actiont setCheckedt readonly_menut addSeparatorR#tset_rich_text_fontRJR5tlockedt _last_textst_last_editor_docRRtsystplatformR ReRt source_combotaddItemstcurrentIndexChangedRtsource_changedRRbRt addSpacingR-tcomboR t object_editRR4t setMaxCountt load_historyt setItemTextRPt force_refreshRt rich_helpttoggle_plain_texttplain_text_actionttoggle_show_sourcetshow_source_actionttoggle_rich_texttrich_text_actionRt setExclusivet addActionttoggle_auto_importtauto_import_actionR%t toggle_lockedt locked_buttont_update_lock_icontimaRt setPopupModeRt InstantPopupR tsetMenutswitch_to_rich_texttswitch_to_plain_textR&RfRR"t_sphinx_threadRt_on_sphinx_thread_html_readyRt_on_sphinx_thread_error_msgR}RtpagetsetLinkDelegationPolicyRtDelegateAllLinkst linkClickedthandle_link_clickst _starting_up( R7R8Rt layout_editttxtt source_labelt help_actionstauto_import_statetoptions_buttontmenuRtview((s2lib/python2.7/site-packages/spyder/plugins/help.pyR/Ss             "                      cCs|jj|jj|dS(s3Action to be performed on first plugin registrationN(Rttabify_pluginstvariableexplorer(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pyton_first_registrationscCs tdS(sReturn widget titleR(R(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytget_plugin_titlescCs tjdS(sReturn widget iconR0(RR(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytget_plugin_iconscCs|jjj|jS(sq Return the widget to give focus to when this plugin's dockwidget is raised on top-level (RRSt selectAll(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytget_focus_widgetscCsgS(s*Return a list of actions related to plugin((R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytget_plugin_actionsscCs^|jj|jj|jj||jjj||jjj|_|jj|_dS(s'Register plugin in Spyder's main windowN( RRRtplugin_focus_changedtadd_dockwidgetRtset_helpRJRB(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytregister_plugins cCstS(s3Perform actions before parent main window is closed(R4(R7t cancelable((s2lib/python2.7/site-packages/spyder/plugins/help.pytclosing_pluginscCs-|jr)t|_|j|jndS(sRefresh widgetN(RR5Rtshow_intro_message(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytrefresh_plugins   cCsN|j}|j}|jdt}|j|d||j|dS(sUpdate font from PreferencesRRN(RRR4RR(R7RRt rich_font((s2lib/python2.7/site-packages/spyder/plugins/help.pyt update_fonts   c Csd}|j}d}d}|j|}|jj|d}|j|}||krn|j|n||kr|j|n||kr|j|n|jjj d|g|jj j d|gdS(s*Apply configuration file's plugin settingstcolor_scheme_namet connect_to_oiR_R^toptionsN( RRARRtset_plain_text_color_schemeRttoggle_math_modeRRtapply_plugin_settingst ipyconsole( R7R!tcolor_scheme_ntcolor_scheme_ot connect_ntwrap_ntwrap_otmath_ntmath_o((s2lib/python2.7/site-packages/spyder/plugins/help.pyR$s     cCs|jjdkS(s Return True if source is Consolei(Rt currentIndex(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pyR;.scCs|jjddS(Ni(RtsetCurrentIndex(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytswitch_to_editor_source2scCs|jjddS(Ni(RR.(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytswitch_to_console_source5scCs|jrI|jj|jj|jjt|jjtn:|jj|jj|jj t|jj t|j dS(N( R;RtshowRRRRcR4Rt setDisabledt restore_text(R7tindex((s2lib/python2.7/site-packages/spyder/plugins/help.pyR8s     cCs%|jr||_n ||_dS(N(R;RR(R7tcallback((s2lib/python2.7/site-packages/spyder/plugins/help.pyt save_textGs  cCs|jr|j}n |j}|dkrY|jrI|jjq|jjnJ|d}|d}||t||jkr|j n |j dS(Nii( R;RRR<tis_plain_text_modeRRRRRR(R7tcbtfunctargs((s2lib/python2.7/site-packages/spyder/plugins/help.pyR3Ms         cCs'|jjr|jjS|jjSdS(N(Rt isVisibleR~R(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pyR~as cCs |jj|d|jdS(sSet rich text mode fontRN(RRR(R7R((s2lib/python2.7/site-packages/spyder/plugins/help.pyRhscCs|jj|d|dS(sSet plain text mode fontRN(RR(R7RR((s2lib/python2.7/site-packages/spyder/plugins/help.pyRlscCs|jj|dS(s Set plain text mode color schemeN(RR(R7R((s2lib/python2.7/site-packages/spyder/plugins/help.pyR"pscCs'|jjj||jd|dS(sToggle wrap modeR_N(RRRt set_option(R7tchecked((s2lib/python2.7/site-packages/spyder/plugins/help.pyRtscCs|jd|dS(sToggle math modeR^N(R<(R7R=((s2lib/python2.7/site-packages/spyder/plugins/help.pyR#zscCs |jjS(s(Return True if plain text mode is active(RR;(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pyR7~scCs |jjS(s'Return True if rich text mode is active(RR;(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pytis_rich_text_modescCs7t|_|jj|jj|jjtdS(sSwitch to plain text modeN( R5RRR1RRRRR4(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs   cCsGt|_|jj|jj|jjt|jjt dS(sSwitch to rich text modeN( R4RRRRR1RRRR5(R7((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs    cCst|tkr|d}|rZdjdt|d|ddt|dg}nd}|drdjd||ddg}nd}|drdjd |dd g}nd}dj||||d g}n|}|jj|||j|jj||gd S( sSet plain text docsRR.t=s s Rs Definition: RsType: s ---- RN(RRtjointlenRRR6(R7RRRt rst_titlet definitionRt full_text((s2lib/python2.7/site-packages/spyder/plugins/help.pytset_plain_texts$   cCs3|jj|||j|jj||gdS(s Set rich textN(RRR6(R7RR((s2lib/python2.7/site-packages/spyder/plugins/help.pytset_rich_text_htmlscCstd}td}tjdkr0d}nd}|jrtd}td}td}|d |d d d |d f}|jt||||tjtn@dtd}||d|f}||7}|j |dt dS(NsHere you can get help of any object by pressing %s in front of it, either on the Editor or the Console.%sHelp can also be shown automatically after writing a left parenthesis next to an object. You can activate this behavior in %s.sPreferences > HelpRsCmd+IsCtrl+ItUsagesNew to Spyder? Read ourttutorialsss

sss %ssMPlease consider installing Sphinx to get documentation rendered in rich text.s R( RRRR>RFR!Rt fromLocalFileRRER5(R7t intro_messagetprefstshortcutttitlettutorial_messageRHtinstall_sphinx((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs$         R.cCs=|j|jtd|d|}|j||dS(sShow text in rich modetcollapseRN(tswitch_to_pluginRRtrender_sphinx_doc(R7RRPRR((s2lib/python2.7/site-packages/spyder/plugins/help.pytshow_rich_texts  cCs+|j|j|j|dtdS(sShow text in plain modeRN(RQRRER5(R7R((s2lib/python2.7/site-packages/spyder/plugins/help.pytshow_plain_texts  cCsQ|jtd}tj|d}t|j}|j|dtdS(sAShow the Spyder tutorial in the Help plugin, opening it if neededsspyder.utils.helps tutorial.rstRPN(RQRtospR@topentreadRSR4(R7t tutorial_pathRHR((s2lib/python2.7/site-packages/spyder/plugins/help.pyt show_tutorials   cCsgt|j}|dkr+|jn8|jdrJtj|n|jjjt |dS(Nsspy://tutorialthttp( RttoStringRYt startswithRt start_fileRR}tloadR(R7R((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs   cCsW|rS|jr(|jddtqS|jdk rS|j|jdtqSndS(NR(R;tset_object_textR<R4Rtset_editor_doc(R7RPRU((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs  cCs|jr| rdS|jt}|dkrNt|jj}t}n|j|d|}|rt| rtdS|r|jj |n|r|j n|j dk r|j j tn|j |d||j dk r|j j tndS(sSet object analyzed by HelpNtignore_unknowntforce(RR0R4R<RRR=R5t show_helptadd_textt save_historyt dockwidgett blockSignalst_Help__eventually_raise_help(R7RRRat add_to_combotfound((s2lib/python2.7/site-packages/spyder/plugins/help.pyR_s&     cCs|jr| rdS|j||_|jj|d|jrT|j|n|j|dt|j dk r|j j t n|j |dd||j dk r|j j tndS(s Use the help plugin to show docstring dictionary computed with introspection plugin from the Editor plugin Ntobj_textRRRb(RR/RRtsetTextRRRRER5RfR<RgR4Rh(R7RR((s2lib/python2.7/site-packages/spyder/plugins/help.pyR`s   cCs|jj}t|jdr|jr|s?|jjr|j r|sb||j|kr|jj|j}|j j|kr|jj dk r|jj j|kr|j qqn||j|Sphinx %s.
Incompatible Sphinx version or doc string decoding failed.

Error message:
%sN( RRRRR4RRgR tcriticalR(R7RRt((s2lib/python2.7/site-packages/spyder/plugins/help.pyRs    cCsx|j}|dkrdSt|}|j|s|jdrj|jj|dtrj|j}qd}d}d}n|dk r|j|}|j|}nt }|j r|j ||dk S|j r|}|dkra|}|dkr|j }|rt SqqanF|}|dkr[|}|dkratd}|rXt Sqant}|j|d|tS(s Show helpNR9R:sNo source code available.R(RDR<RRCRARBR4Rt get_sourceR5RRRRRRRE(R7RkRaRJRt source_textRthlp_text((s2lib/python2.7/site-packages/spyder/plugins/help.pyRcsH                  N(FRVRWRXt CONF_SECTIONRZtCONFIGWIDGET_CLASSRRtRtFONT_SIZE_DELTARRR<R/RRRRRRR5RRRR$R;R/R0RR6R3tpropertyR~RRR"RRYRR#R7R>RRRERFRRSRTRYRR4RR_R`RhRReRRRRRRRRDRRRRRc(((s2lib/python2.7/site-packages/spyder/plugins/help.pyRGsz                                         (KRXR>tos.pathtpathRURERtqtpyRt qtpy.QtCoreRRRRtqtpy.QtWidgetsRRRRR R R R R RRRtqtpy.QtWebEngineWidgetsRRtspyderRtspyder.config.baseRRRtspyder.config.fontsRtspyder.pluginsRtspyder.plugins.configdialogRtspyder.py3compatRRt spyder.utilsRRRtspyder.utils.help.sphinxifyRRR R!R"tspyder.utils.qthelpersR#R$R%R&tspyder.widgets.browserR'tspyder.widgets.comboboxesR(tspyder.widgets.findreplaceR)tspyder.widgets.sourcecodeR*taddR-RZR|RRR(((s2lib/python2.7/site-packages/spyder/plugins/help.pyts<   "R("?=3I