G@d{0dZddlZddlmZddlmZddlmZmZddl m Z m Z ddl m Z ddlmZdd lmZdd lmZdd lmZGd d ZGddeZdS)z Help Plugin. N)Signal)SpyderAPIError)PluginsSpyderDockablePlugin)on_plugin_availableon_plugin_teardown_) get_conf_path)DEFAULT_SMALL_DELTA)HelpConfigPage) HelpWidgetceZdZdZdS) HelpActionsspyder_tutorial_actionN)__name__ __module__ __qualname__ShowSpyderTutorialAction:lib/python3.11/site-packages/spyder/plugins/help/plugin.pyrrs7rrceZdZdZdZejejejgZ ej ej ej gZ ejZeZeZeZdZeeZeZdZeZeZ eZ edZ dZ!dZ"dZ#e$ejd Z%e$ejd Z&e$ej d Z'e$ejd Z(e$ej d Z)e$ej dZ*e+ejdZ,e+ejdZ-e+ej dZ.e+ejdZ/e+ej dZ0e+ej dZ1dZ2d%dZ3d%fd Z4dZ5dZ6dZ7d&dZ8dZ9dZ:dZ;d'd!Zd$Z?xZ@S)(Helpz# Docstrings viewer widget. helpFc tdS)Nrr rrrget_namez Help.get_name=syyrc tdS)Nz;Get rich text documentation from the editor and the consoler selfs rget_descriptionzHelp.get_descriptionAs IKK Krc,|dS)Nr) create_iconrs rget_iconz Help.get_iconEs'''rc|}|j|j|j|j|||j|j|tj td|j d|_ dS)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"" !))$*ABBB"**4+CDDD 4,,..///%%d&7888#11  0$%%(# 2  r)pluginc|}|tj}|j|j||dSN)r) get_pluginrConsolesig_help_requestedr+set_object_textset_internal_consoler r4internal_consoles ron_console_availablezHelp.on_console_availableZsZ""??7?;;+33D4HIII##$455555rc|tj}|j|jdSr8)r9rEditorr;r+set_editor_docr editors ron_editor_availablezHelp.on_editor_availableas500!))$*=>>>>>rcz|tj}|j|j|j|j|j|j|j |j |j |j dSr8) 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%;<< *2243GHHH*2243GHHH2::   " " "199   ! ! ! %--d.BCCCCCrcn|tj}||dSr8)r9r Preferencesregister_plugin_preferencesr preferencess ron_preferences_availablezHelp.on_preferences_availabless0oog&9:: //55555rc|tj}|j|j|tjr|dSdSr8) r9r Shortcutssig_shortcuts_updatedr+show_intro_messageis_plugin_availableMainMenu _setup_menusr shortcutss ron_shortcuts_availablezHelp.on_shortcuts_availablexsmOOG$566  '//0GHHH  # #G$4 5 5          rc|tjr7|tjr|dSdS|dSr8)is_plugin_enabledrrZr]r_rs ron_main_menu_availablezHelp.on_main_menu_availablesp  ! !'"3 4 4 ''(9:: $!!##### $ $        rc|}|tj}|j|j|ddSr8)r)r9rr:r; disconnectr<r=r>s ron_console_teardownzHelp.on_console_teardownsY""??7?;;+66t7KLLL##D)))))rc|tj}|j|jdSr8)r9rrBr;rgrCrDs ron_editor_teardownzHelp.on_editor_teardowns500!,,T-@AAAAArcz|tj}|j|j|j|j|j|j|j |j |j |j dSr8) r9rrHrIrgrJrKrLrMrNrOr;r<rPs ron_ipython_console_teardownz Help.on_ipython_console_teardowns__W%;<< *55d6JKKK*55   " " "2==   " " "1<<   ! ! ! %001EFFFFFrcn|tj}||dSr8)r9rrTderegister_plugin_preferencesrVs ron_preferences_teardownzHelp.on_preferences_teardowns0oog&9:: 11$77777rc|tj}|j|jdSr8)r9rrZr[rgr\r`s ron_shortcuts_teardownzHelp.on_shortcuts_teardowns6OOG$566 '2243JKKKKKrc.|dSr8) _remove_menusrs ron_main_menu_teardownzHelp.on_main_menu_teardowns rc.|}|}|d}|}||||||||dS)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_fonts,,.. }}MMDM11 """"4l"CCC!!)T222**<88888rc.|dS)NT)r0)r cancelables ron_closez Help.on_closes trct| |tj}|dhdS#t $rYdSwxYw)N connect_to_oi)super apply_confr9rrBapply_plugin_settingsr)r options_setnotifyrE __class__s rrzHelp.apply_confsr ;''' __W^44F  ( (/): ; ; ; ; ;    DD s5A A)(A)c|tj}|tj}d}|r ddlm}|j}|r8ddlm}m }| |j |j |j ||jdSdS)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#344OOG$566 #'  M G G G G G G'6'L $  9 4 4 4 4 4 4 4 4  1 1$(-(6//7 2 9 9 9 9 9 9 9rcddlm}|tj}|t j|jdS)Nr)r)r) rrr9rr^!remove_item_from_application_menurrr)r rrs rrszHelp._remove_menuss[@@@@@@??7#34422  0$) 3 + + + + +rc|j|d||dS)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_shellwidgetsS -- MM3 4 4 6 6 6 ##K00000rNctj|jrat |jd5}|d}dddn #1swxYwYd|D}ng}|S)zT Load history from a text file in the user configuration directory. r Nc:g|]}|ddS)r)replace).0lines r z%Help.load_history..s&@@@$t||D"--@@@r)ospathisfileLOG_PATHopenreadsplit)r objfhlineshistorys rr.zHelp.load_historys 7>>$- ( ( dmS)) .R -- . . . . . . . . . . . . . . .A@%@@@GGGs(A..A25A2c< d|}t|jd5}||ddddS#1swxYwYdS#t ttf$rYdSwxYw)zR Save history to a text file in the user configuration directory. rwN) joinr) get_historyrrwriteUnicodeEncodeErrorUnicodeDecodeErrorEnvironmentError)r search_historyrs rr0zHelp.save_historys  !YYt'8'8'D'D'F'FGGNdmS)) )R((( ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) )"$68HI    DD s6ABA3& B3A77B:A7;BBBcz||dS)zShow the Spyder tutorial.N)switch_to_pluginr)r2rs rr2zHelp.show_tutorials6  '')))))rcR|dS)z&Show the IPython introduction message.N)r)r\rs rr\zHelp.show_intro_messages$ ,,.....rrc|||||dS)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_textsN  ((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_text6sX(  ))  '(89 *     rc|dd}||||dS)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"s D#W_gnEH&(97;KLH  %FLL&I}\**H)O"'M &((N\KKK(((   $00066106 ///??0/? 6777 D D87 D 344466546 1222  32  0111  21 w///**0/* w~...BB/.Bw5666 G G76 Gw233388438w0111LL21Lw/00010999999$+++ 1 1 1       *** ///<<<<$ 0 0 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.widgetsrrrrrrrsC  100000<<<<<<<<--------%%%%%%,,,,,,33333377777722222288888888 L L L L L L L L L L r