Je{0dZddlZddlmZddlmZddlmZmZddl m Z m Z ddl m Z ddlmZdd lmZdd lmZdd lmZGd d ZGddeZy)z Help Plugin. N)Signal)SpyderAPIError)PluginsSpyderDockablePlugin)on_plugin_availableon_plugin_teardown_) get_conf_path)DEFAULT_SMALL_DELTA)HelpConfigPage) HelpWidgetceZdZdZy) HelpActionsspyder_tutorial_actionN)__name__ __module__ __qualname__ShowSpyderTutorialActiond"Z?xZ@S)&Helpz# Docstrings viewer widget. helpFctdS)Nrr rrrget_namez Help.get_name=s yrctdS)Nz;Get rich text documentation from the editor and the consoler selfs rget_descriptionzHelp.get_descriptionAs IK Krc$|jdS)Nr) create_iconrs rget_iconz Help.get_iconEs''rc|j}|jj|j|jj|j|j |j |j j|j|jtjtd|jd|_ y)NzSpyder tutorialF)text triggeredregister_shortcut) get_widgetsig_render_startedconnectsig_render_finished set_history load_historysig_item_found save_history create_actionrrr show_tutorialtutorial_action)r widgets r on_initializezHelp.on_initializeHs" !!))$*A*AB""**4+C+CD 4,,./%%d&7&78#11  0 0$%((# 2 r)pluginc|j}|jtj}|jj |j |j|yN)r) get_pluginrConsolesig_help_requestedr+set_object_textset_internal_consoler r4internal_consoles ron_console_availablezHelp.on_console_availableZsJ"??7??;++33D4H4HI##$45rc|jtj}|jj |j yr8)r9rEditorr;r+set_editor_docr editors ron_editor_availablezHelp.on_editor_availableas.0!!))$*=*=>rc|jtj}|jj |j |j j |j |jj |j|jj |j|jj |jyr8) r9rIPythonConsolesig_shellwidget_changedr+set_shellwidgetsig_shellwidget_createdsig_render_plain_text_requestedshow_plain_textsig_render_rich_text_requestedshow_rich_textr;r<r ipyconsoles ron_ipython_console_availablez!Help.on_ipython_console_availablefs__W%;%;< **2243G3GH**2243G3GH22::   "1199    ! %%--d.B.BCrcd|jtj}|j|yr8)r9r Preferencesregister_plugin_preferencesr preferencess ron_preferences_availablezHelp.on_preferences_availabless$oog&9&9: //5rc|jtj}|jj |j |j tjr|jyyr8) r9r Shortcutssig_shortcuts_updatedr+show_intro_messageis_plugin_availableMainMenu _setup_menusr shortcutss ron_shortcuts_availablezHelp.on_shortcuts_availablexsWOOG$5$56  ''//0G0GH  # #G$4$4 5     6rc|jtjr1|jtjr|j yy|j yr8)is_plugin_enabledrrZr]r_rs ron_main_menu_availablezHelp.on_main_menu_availablesI  ! !'"3"3 4''(9(9:!!#;    rc|j}|jtj}|jj |j |jdyr8)r)r9rr:r; disconnectr<r=r>s ron_console_teardownzHelp.on_console_teardownsI"??7??;++66t7K7KL##D)rc|jtj}|jj |j yr8)r9rrBr;rgrCrDs ron_editor_teardownzHelp.on_editor_teardowns.0!!,,T-@-@Arc|jtj}|jj |j |j j |j |jj |j|jj |j|jj |jyr8) r9rrHrIrgrJrKrLrMrNrOr;r<rPs ron_ipython_console_teardownz Help.on_ipython_console_teardowns__W%;%;< **55d6J6JK**55   "22==   "11<<    ! %%001E1EFrcd|jtj}|j|yr8)r9rrTderegister_plugin_preferencesrVs ron_preferences_teardownzHelp.on_preferences_teardowns$oog&9&9: 11$7rc|jtj}|jj |j yr8)r9rrZr[rgr\r`s ron_shortcuts_teardownzHelp.on_shortcuts_teardowns0OOG$5$56 ''2243J3JKrc$|jyr8) _remove_menusrs ron_main_menu_teardownzHelp.on_main_menu_teardowns rc|j}|j}|jd}|j}|j|||j |||j |y)NT) rich_text) color_scheme)get_color_schemeget_fontr)set_plain_text_fontset_rich_text_fontset_plain_text_color_scheme)r rwfont rich_fontr4s r update_fontzHelp.update_fontsh,,. }}MMDM1 """4l"C!!)T2**<8rc$|jy)NT)r0)r cancelables ron_closez Help.on_closes rct|| |jtj}|j dhy#t $rYywxYw)N connect_to_oi)super apply_confr9rrBapply_plugin_settingsr)r options_setnotifyrE __class__s rrzHelp.apply_confsJ ;' __W^^4F  ( (/): ;   s1A AAc>|jtj}|jtj}d}|rddlm}|j }|rGddlm}m }|j|j|j|j||jyy)Nr)ShortcutActions)ApplicationMenusHelpMenuSections)menu_idsectionbeforebefore_section)r9rr^rZspyder.plugins.shortcuts.pluginrShortcutSummaryActionspyder.plugins.mainmenu.apirradd_item_to_application_menur3r DocumentationSupport)r mainmenurashortcuts_summary_actionrrrs rr_zHelp._setup_menuss??7#3#34OOG$5$56 #'  G'6'L'L $  4  1 1$$(--(66//77 2 9 rcddlm}|jtj}|j t j|jy)Nr)r)r) rrr9rr^!remove_item_from_application_menurrr)r rrs rrszHelp._remove_menuss>@??7#3#3422  0 0$)) 3 +rc|jj|jd|jj |y)a Set IPython Console `shelwidget` as the current shellwidget. Parameters ---------- shellwidget: spyder.plugins.ipyconsole.widgets.shell.ShellWidget The shell widget that is going to be connected to Help. zconnect/ipython_consoleN)_controlset_help_enabledget_confr) set_shell)r shellwidgets rrJzHelp.set_shellwidgets: -- MM3 4 6 ##K0rc<tjj|jr_t |jd5}|j j d}dddDcgc]}|jdd}}|Sg}|S#1swY.xYwcc}w)zT Load history from a text file in the user configuration directory. r N)ospathisfileLOG_PATHopenreadsplitreplace)r objfhlineslinehistorys rr.zHelp.load_historys 77>>$-- (dmmS) .R - .;@@$t||D"-@G@G . .As B ,B Bc  dj|jj}t|jd5}|j |dddy#1swYyxYw#t ttf$rYywxYw)zR Save history to a text file in the user configuration directory. rwN) joinr) get_historyrrwriteUnicodeEncodeErrorUnicodeDecodeErrorEnvironmentError)r search_historyrs rr0zHelp.save_historysp  !YYt'8'D'D'FGNdmmS) )R( ) ) )"$68HI   s0AA,A A, A)%A,)A,,BBc`|j|jjy)zShow the Spyder tutorial.N)switch_to_pluginr)r2rs rr2zHelp.show_tutorials!  '')rc@|jjy)z&Show the IPython introduction message.N)r)r\rs rr\zHelp.show_intro_messages ,,.rch|j|jj|||y)a Show help in rich mode. Parameters ---------- text: str Plain text to display. collapse: bool, optional Show collapsable sections as collapsed/expanded. Default is False. img_path: str, optional Path to folder with additional images needed to correctly display the rich text help. Default is ''. )collapseimg_pathN)rr)rO)r r&rrs rrOzHelp.show_rich_texts1  ((2: ) >> help_data = { 'name': str, 'force_refresh': bool, } See Also -------- :py:meth:spyder.widgets.mixins.GetHelpMixin.show_object_info nameignore_unknown)rN)rr)r<)r options_dicts rr<zHelp.set_object_text6s;(  ))  '(89 * rc|jdd}|j|jj||y)aE Set content for help data sent from the editor. Parameters ---------- help_data: dict Dictionary of data. See the example for the expected keys. Examples -------- >>> help_data = { 'obj_text': str, 'name': str, 'argspec': str, 'note': str, 'docstring': str, 'force_refresh': bool, 'path': str, } See Also -------- :py:meth:spyder.plugins.editor.widgets.editor.EditorStack.send_to_help force_refreshF)rN)poprr)rC)r help_datars rrCzHelp.set_editor_docPs@2" ou=   (( ' ) r)Fr8)Fr)Arrr__doc__NAMErrTr:rBREQUIRESrHrZr^OPTIONALVariableExplorerTABIFYr WIDGET_CLASS CONF_SECTIONr CONF_WIDGET_CLASS CONF_FILEr rr FONT_SIZE_DELTADISABLE_ACTIONS_WHEN_HIDDENrsig_focus_changedr*r, staticmethodrr!r$r5rr@rFrRrXrbrerrhrjrlrorqrtrrrr_rsrJr.r0r2r\rOrMr<rC __classcell__)rs@rrr"sz D##W__gnnEH&&(9(97;K;KLH  % %FLL&I\*H)O"'M (NK( $0616 /?0? 6 67 D8 D 3 34656 1 12 3  0 01 2 w/*0* w~~.B/Bw556 G7 Gw223848w001L2Lw//0199$+ 1  * /<$ 0 4 rr)rr qtpy.QtCorerspyder.api.exceptionsrspyder.api.pluginsrr)spyder.api.plugin_registration.decoratorsrrspyder.api.translationsr spyder.config.baser spyder.config.fontsr spyder.plugins.help.confpager spyder.plugins.help.widgetsrrrrrrrsI  1<-%,37288 L L r