a  ³Šaþ+ã@sÊdZddlZddlmZmZddlmZmZmZddl m Z m Z ddl m Z ddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZedƒZGdd„dƒZGdd„de ƒZdS)z Help Plugin. éN)ÚQtÚSignal)Ú __docs_url__Ú __forum_url__Ú__trouble_url__)ÚPluginsÚSpyderDockablePlugin)Úon_plugin_available)Úget_translation)Ú get_conf_path)ÚDEFAULT_SMALL_DELTA)ÚConsoleActions)ÚHelpConfigPage)Ú HelpWidget)Ú start_fileÚspyderc@seZdZdZdS)Ú HelpActionsZspyder_tutorial_actionN)Ú__name__Ú __module__Ú __qualname__ÚShowSpyderTutorialAction©rrú9lib/python3.9/site-packages/spyder/plugins/help/plugin.pyr!srcs|eZdZdZdZejejejgZ ej ej ej gZ ejZeZeZeZdZeeƒZeZdZeƒZeƒZeƒZdd„Zdd„Z dd „Z!d d „Z"e#ejd d d„ƒZ$e#ejd dd„ƒZ%e#ej d dd„ƒZ&e#ejd dd„ƒZ'e#ej d dd„ƒZ(e#ej d dd„ƒZ)dd„Z*d5dd„Z+d6‡fdd„ Z,dd „Z-d!d"„Z.d7d$d%„Z/d&d'„Z0d(d)„Z1d*d+„Z2d8d-d.„Z3d/d0„Z4d1d2„Z5d3d4„Z6‡Z7S)9ÚHelpz# Docstrings viewer widget. ÚhelpFcCstdƒS)Nr©Ú_©ÚselfrrrÚget_nameAsz Help.get_namecCstdƒS)Nz;Get rich text documentation from the editor and the consolerrrrrÚget_descriptionDsÿzHelp.get_descriptioncCs | d¡S)Nr)Z create_iconrrrrÚget_iconHsz Help.get_iconcCs`| ¡}|j |j¡|j |j¡| | ¡¡|j |j¡|jt j t dƒ|j dd|_ dS)NzSpyder tutorialF)ÚtextZ triggeredZregister_shortcut)Ú get_widgetÚsig_render_startedÚconnectÚsig_render_finishedZ set_historyÚ load_historyZsig_item_foundÚ save_historyZ create_actionrrrÚ show_tutorialÚtutorial_action)rÚwidgetrrrÚ on_initializeKsüzHelp.on_initialize)ZplugincCs0| ¡}| tj¡}|j |j¡| |¡dS©N)r#Ú get_pluginrÚConsoleÚsig_help_requestedr%Úset_object_textZset_internal_console)rr+Zinternal_consolerrrÚon_console_available]s zHelp.on_console_availablecCs| tj¡}|j |j¡dSr-)r.rÚEditorr0r%Úset_editor_doc)rÚeditorrrrÚon_editor_availableds zHelp.on_editor_availablecCsV| tj¡}|j |j¡|j |j¡|j |j¡|j  |j ¡|j  |j ¡dSr-) r.rÚIPythonConsoleZsig_shellwidget_changedr%Úset_shellwidgetZsig_shellwidget_createdZsig_render_plain_text_requestedÚshow_plain_textZsig_render_rich_text_requestedÚshow_rich_textr0r1)rÚ ipyconsolerrrÚon_ipython_console_availableis ÿÿÿz!Help.on_ipython_console_availablecCs| tj¡}| |¡dSr-)r.rÚ PreferencesZregister_plugin_preferences)rZ preferencesrrrÚon_preferences_availablews zHelp.on_preferences_availablecs8ˆ tj¡}|j ‡fdd„¡ˆ tj¡r4ˆ ¡dS)Ncsˆ ¡Sr-)Úshow_intro_messagerrrrÚ‚óz-Help.on_shortcuts_available..)r.rÚ ShortcutsZsig_shortcuts_updatedr%Úis_plugin_availableÚMainMenuÚ _setup_menus)rÚ shortcutsrrrÚon_shortcuts_available|s   ÿ zHelp.on_shortcuts_availablecCs.| tj¡r"| tj¡r*| ¡n| ¡dSr-)Zis_plugin_enabledrrBrCrErrrrÚon_main_menu_available‡s   zHelp.on_main_menu_availablecCsL| ¡}| ¡}|jdd}| ¡}|j||d| ||¡| |¡dS)NT)Z rich_text)Ú color_scheme)Úget_color_schemeZget_fontr#Zset_plain_text_fontZset_rich_text_fontÚset_plain_text_color_scheme)rrIZfontZ rich_fontr+rrrÚ update_fonts  zHelp.update_fontcCs | ¡dS)NT)r()rZ cancelablerrrÚon_close™sz Help.on_closecsbtƒ |¡| ¡}d|vr*| | ¡¡| tj¡}| dh¡| tj ¡}|r^| dh¡dS)NZcolor_scheme_nameZ connect_to_oi) ÚsuperÚ apply_confr#rKrJr.rr3Zapply_plugin_settingsr7)rZ options_setZnotifyr+r5r;©Ú __class__rrrOs    zHelp.apply_confcCsf| tj¡}| tj¡}d}|r2ddlm}|j}|rbddlm}m }|j |j |j |j ||jddS)Nr)ÚShortcutActions)ÚApplicationMenusÚHelpMenuSections)Zmenu_idZsectionZbeforeZbefore_section)r.rrDrBZspyder.plugins.shortcuts.pluginrRZShortcutSummaryActionZspyder.plugins.mainmenu.apirSrTZadd_item_to_application_menur*rZ DocumentationZSupport)rZmainmenurFZshortcuts_summary_actionrRrSrTrrrrE®s   ûzHelp._setup_menuscCs$|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)Z_controlZset_help_enabledZget_confr#Z set_shell)rZ shellwidgetrrrr8Âs ÿzHelp.set_shellwidgetNcCs`tj |j¡rXt|jdƒ}| ¡ d¡}Wdƒn1s>0Ydd„|Dƒ}ng}|S)zT Load history from a text file in the user configuration directory. ÚrÚ NcSsg|]}| dd¡‘qS)rVÚ)Úreplace)Ú.0ÚlinerrrÚ ×rAz%Help.load_history..)ÚosÚpathÚisfileÚLOG_PATHÚopenÚreadÚsplit)rÚobjÚfhÚlinesÚhistoryrrrr'Ïs ,zHelp.load_historyc CsjzLd | ¡ ¡¡}t|jdƒ}| |¡Wdƒn1s@0YWntttfydYn0dS)zR Save history to a text file in the user configuration directory. rVÚwN) Újoinr#Z get_historyr`r_ÚwriteÚUnicodeEncodeErrorÚUnicodeDecodeErrorÚEnvironmentError)rZsearch_historyrdrrrr(Ýs ,zHelp.save_historycCs| ¡| ¡ ¡dS)zShow the Spyder tutorial.N)Úswitch_to_pluginr#r)rrrrr)êszHelp.show_tutorialcCs| ¡| ¡ ¡dS)z&Show the IPython introduction message.N)rmr#r?rrrrr?ïszHelp.show_intro_messagerWcCs | ¡| ¡j|||ddS)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 ''. )ÚcollapseÚimg_pathN)rmr#r:)rr"rnrorrrr:ôs ÿzHelp.show_rich_textcCs| ¡| ¡ |¡dS)z† Show help in plain mode. Parameters ---------- text: str Plain text to display. N)rmr#r9)rr"rrrr9s zHelp.show_plain_textcCs&| ¡| ¡j|d|dddS)a« Set object's name in Help's combobox. Parameters ---------- options_dict: dict Dictionary of data. See the example for the expected keys. Examples -------- >>> help_data = { 'name': str, 'force_refresh': bool, } See Also -------- :py:meth:spyder.widgets.mixins.GetHelpMixin.show_object_info ÚnameÚignore_unknown)rqN)rmr#r1)rZ options_dictrrrr1s þzHelp.set_object_textcCs*| dd¡}| ¡| ¡j||ddS)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)rrN)Úpoprmr#r4)rZ help_datarrrrrr4,s  þzHelp.set_editor_doc)F)F)N)FrW)8rrrÚ__doc__ÚNAMErr=r/r3ZREQUIRESr7rBrDZOPTIONALZVariableExplorerZTABIFYrZ WIDGET_CLASSZ CONF_SECTIONrZCONF_WIDGET_CLASSZ CONF_FILEr r_r ZFONT_SIZE_DELTAZDISABLE_ACTIONS_WHEN_HIDDENrZsig_focus_changedr$r&rr r!r,r r2r6r<r>rGrHrLrMrOrEr8r'r(r)r?r:r9r1r4Ú __classcell__rrrPrr&sX               r)rtr\Z qtpy.QtCorerrrrrrZspyder.api.pluginsrrZ)spyder.api.plugin_registration.decoratorsr Zspyder.api.translationsr Zspyder.config.baser Zspyder.config.fontsr Zspyder.plugins.console.apir Zspyder.plugins.help.confpagerZspyder.plugins.help.widgetsrZspyder.utils.qthelpersrrrrrrrrÚs