G@dCdZddlmZmZmZmZddlmZmZm Z m Z ddl m Z gdZ GddZiejdejd ejd ejd ejd ejd ejdejdejdejdejdejdejdejdejdejdejdej dej!dej"dej#dej$dej%dej&dej'd ej(d!ej)d"ej*d#i Z+Gd$d%Z,Gd&d'Z-Gd(d)Z.d*d*e,j/e,j0e,j1ge.j2d+d,d*id,d*id,d*id*d-d.ej34Did/d*d*d0Z5d*d*d*d*d1d*d*d2gd3d4d*d2gd5d*d6d2gid7d,d*id,d*id,d*id,d*id,d*id,d*id,d*id,d*id,d*id,d*id,d*id8Z6e5e6d9Z7Gd:d;Z8dZ;d=gd?ZdBgdCZ?dAd=iZ@dDgiZAdEd=d=dFiZBidGe;dHd=dIe<dJe=dKd=dLd=dMd=dNd=dOd=dPd=dQe>dRd=dSd=dTe?dUd=dVe@dWeAeBdBdXZCGdYdZZDGd[d\ZEGd]d^ZFGd_d`ZGGdadbZHGdcddZIGdedfZJGdgdhZKdiZLGdjdke ZMGdldmeeMZNdBS)na" General Spyder completion API constants and enumerations. The constants and enums presented on this file correspond to a superset of those used by the Language Server Protocol (LSP), available at: https://microsoft.github.io/language-server-protocol/specifications/specification-current/ )AnyOptionalTupleUnion)SignalQObjectSlotQt)SpyderConfigurationObserver)BashzC#Cppz CSS/LESS/SASSGoGraphQLGroovyElixirErlangFortranHaxeHTMLJava JavaScriptJSONJuliaKotlinOCamlPHPRRustScalaSwift TypeScriptceZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdS) SymbolKindzLSP workspace symbol constants. N) __name__ __module__ __qualname____doc__FILEMODULE NAMESPACEPACKAGECLASSMETHODPROPERTYFIELD CONSTRUCTORENUM INTERFACEFUNCTIONVARIABLECONSTANTSTRINGNUMBERBOOLEANARRAYOBJECTKEYNULL ENUM_MEMBERSTRUCTEVENTOPERATORTYPE_PARAMETER BLOCK_COMMENTCELL=lib/python3.11/site-packages/spyder/plugins/completion/api.pyr#r##s)) D FIG E FH EK DIHHH F FG E F C DK F EHNM DDDrar#filemodule namespacepackageclassmethodpropertyfield constructorenum interfacefunctionvariableconstantstringnumberbooleanarrayobjectkeynull enum_memberstructeventoperatortype_parameter blockcommentcellceZdZdZdZdZdZdS)ResourceOperationKindz"LSP workspace resource operations.createrenamedeleteN)r@rArBrCCREATERENAMEDELETEr`rarbrris#,, F F FFFrarceZdZdZdZdZdS)FileChangeTyper$r%r&N)r@rArBCREATEDCHANGEDDELETEDr`rarbrrssGGGGGrarc"eZdZdZdZdZdZdZdS)FailureHandlingKindz'LSP workspace modification error codes.abort transactionalundotextOnlyTransactionalN)r@rArBrCABORT TRANSACTIONALUNDOTEXT_ONLY_TRANSACTIONALr`rarbrrys/11 E#M D6rarT)documentChangesresourceOperationsfailureHandlingdynamicRegistrationvalueSetc<g|]}t|t|Sr`) isinstanceint).0values rb rs64445&uc224444ra)r symbolKind) applyEdit workspaceEditdidChangeConfigurationdidChangeWatchedFilessymbolexecuteCommandworkspaceFolders configuration)rwillSavewillSaveWaitUntildidSave plaintext)snippetSupportdocumentationFormat)rcompletionItem)r contentFormatr)rsignatureInformation)synchronization completionhover signatureHelp referencesdocumentHighlightdocumentSymbol formattingrangeFormattingonTypeFormatting definition codeActioncodeLens documentLinkr) workspace textDocumentceZdZdZdZdZdZdS)TextDocumentSyncKindz=Text document synchronization modes supported by a lsp-serverrr$r%N)r@rArBrCNONEFULL INCREMENTALr`rarbrrys#GG D DKKKrar includeTextF) openClosechangerrsave)resolveProvidertriggerCharactersrrN)firstTriggerCharactermoreTriggerCharactercommandsr) supportedchangeNotificationstextDocumentSync hoverProvidercompletionProvidersignatureHelpProviderdefinitionProviderreferencesProviderdocumentHighlightProviderdocumentSymbolProviderworkspaceSymbolProvidercodeActionProvidercodeLensProviderdocumentFormattingProviderdocumentRangeFormattingProvider documentOnTypeFormattingProviderrenameProviderdocumentLinkProviderexecuteCommandProvider)r experimentalc"eZdZdZdZdZdZdZdS) LSPEventTypesz%Language Server Protocol event types.rrwindowrN)r@rArBrCDOCUMENT WORKSPACEWINDOW CODE_LENSr`rarbrrs(//HI FIIIrarceZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ!d Z"d!Z#d"Z$d#Z%d$Z&d%Z'd&Z(d'Z)d(Z*d)Z+d*Z,d+Z-d,Z.d-Z/d.Z0d/S)0CompletionRequestTypesz0Language Server Protocol request/response types. initialize initializedshutdownexitz$/cancelRequestzwindow/showMessagezwindow/showMessageRequestzwindow/logMessageztelemetry/eventzclient/registerCapabilityzclient/unregisterCapabilityzworkspace/workspaceFoldersz#workspace/didChangeWorkspaceFolderszworkspace/configurationz workspace/didChangeConfigurationzworkspace/didChangeWatchedFileszworkspace/symbolzworkspace/executeCommandzworkspace/applyEditztextDocument/publishDiagnosticsztextDocument/didOpenztextDocument/didChangeztextDocument/willSaveztextDocument/willSaveWaitUntilztextDocument/didSaveztextDocument/didCloseztextDocument/completionzcompletionItem/resolveztextDocument/hoverztextDocument/signatureHelpz textDocument/referencesztextDocument/documentHighlightztextDocument/documentSymbolztextDocument/formattingztextDocument/foldingRangeztextDocument/rangeFormattingztextDocument/onTypeFormattingztextDocument/definitionztextDocument/codeActionztextDocument/codeLenszcodeLens/resolveztextDocument/documentLinkzdocumentLink/resolveztextDocument/renameztextDocument/cursorEventN)1r@rArBrC INITIALIZE INITIALIZEDSHUTDOWNEXITCANCEL_REQUESTWINDOW_SHOW_MESSAGEWINDOW_SHOW_MESSAGE_REQUESTWINDOW_LOG_MESSAGETELEMETRY_EVENTCLIENT_REGISTER_CAPABILITYCLIENT_UNREGISTER_CAPABILITYWORKSPACE_FOLDERSWORKSPACE_FOLDERS_CHANGEWORKSPACE_CONFIGURATIONWORKSPACE_CONFIGURATION_CHANGEWORKSPACE_WATCHED_FILES_UPDATEWORKSPACE_SYMBOLWORKSPACE_EXECUTE_COMMANDWORKSPACE_APPLY_EDITDOCUMENT_PUBLISH_DIAGNOSTICSDOCUMENT_DID_OPENDOCUMENT_DID_CHANGEDOCUMENT_WILL_SAVEDOCUMENT_WILL_SAVE_UNTILDOCUMENT_DID_SAVEDOCUMENT_DID_CLOSEDOCUMENT_COMPLETIONCOMPLETION_RESOLVEDOCUMENT_HOVERDOCUMENT_SIGNATUREDOCUMENT_REFERENCESDOCUMENT_HIGHLIGHTDOCUMENT_SYMBOLDOCUMENT_FORMATTINGDOCUMENT_FOLDING_RANGEDOCUMENT_RANGE_FORMATTINGDOCUMENT_ON_TYPE_FORMATTINGDOCUMENT_DEFINITIONDOCUMENT_CODE_ACTIONDOCUMENT_CODE_LENSCODE_LENS_RESOLVEDOCUMENT_LINKSDOCUMENT_LINK_RESOLVEDOCUMENT_RENAMEDOCUMENT_CURSOR_EVENTr`rarbrr"s::JKH D&N."=,'O!<#@ 4D7%G"%F") :0#D .20?.031)N5493O38 >"A340*0N2+O6rarc"eZdZdZdZdZdZdZdS)DiagnosticSeverityzLSP diagnostic severity levels.r$r%r&r'N)r@rArBrCERRORWARNING INFORMATIONHINTr`rarbr r [s()) EGK DDDrar cZeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdS)CompletionItemKindz"LSP completion element categories.r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5N)r@rArBrCTEXTrIrOrLrKrPrHrNrErJUNITVALUErMKEYWORDSNIPPETCOLORrD REFERENCEr`rarbr&r&esn,, D FHK EH EI FH D E DGG E DIIIrar&ceZdZdZdZdZdS)InsertTextFormatz$LSP completion text interpretations.r$r%N)r@rArBrC PLAIN_TEXTr+r`rarbr/r/{s..JGGGrar/ceZdZdZdZdZdZdS)TextDocumentSaveReasonz'LSP text document saving action causes.r$r%r&N)r@rArBrCMANUAL AFTER_DELAY FOCUS_OUTr`rarbr2r2s#11 FKIIIrar2ceZdZdZdZdS)ClientConstantszInternal LSP Client constants.z lsp-cancelN)r@rArBrCCANCELr`rarbr7r7s(( FFFrar7ceZdZdZdZdS)WorkspaceUpdateKindadditiondeletionN)r@rArBADDITIONDELETIONr`rarbr:r:sHHHHrar:zspyder.completionsceZdZdZdZdZdS)CompletionConfigurationObserverz Extension to the :class:`spyder.api.config.mixins.SpyderConfigurationObserver` mixin implementation to consider a nested provider configuration. ct|D]}t||d}t|dr|j}t |dkr|xj|hzc_|D]\}}|(d}|dkr d|jdf}n||}|j |i}| |g}| ||||<||j|<dS)z7Gather all the methods decorated with `on_conf_change`.N _conf_listenr$ completions __sectionprovider_configurationvalues) dirgetattrhasattrrBlen_multi_option_listenersCOMPLETION_PROVIDER_NAME_wrap_provider_option_configuration_listenersgetappend)self method_namerhinfosectionoptionsection_listenersoption_listenerss rb_gather_observersz1CompletionConfigurationObserver._gather_observerss.t99 O OKT;55Fv~.. O*t99q==00[MA00'+OOOGV"/![00 8 $ = (&FF &*%?%?%G%GF(,(E(I(I)%)%%'8'<'d7Z< d?d8ed9e0efd:Z=dS)@SpyderCompletionProviderz Spyder provider API for completion providers. All completion providers must implement this interface in order to interact with Spyder CodeEditor and Projects manager. NFz0.1.0c||jnd|_tj||t|||_||_dS)a Main completion provider constructor. Parameters ---------- parent: spyder.plugins.completion.plugin.CompletionPlugin Instance of the completion plugin that manages this provider config: dict Current provider configuration values, whose keys correspond to the ones defined on `CONF_DEFAULTS` and the values correspond to the current values according to the Spyder configuration system. NrC) CONF_SECTIONr__init__r@mainconfig)rQparentrbs rbr`z!SpyderCompletionProvider.__init__s[!' 2$008E  v&&&'00666  rareturncdS)z8Return a human readable name of the completion provider.r`rQs rbget_namez!SpyderCompletionProvider.get_namesrralanguagefilenamecdS)a Register file to perform completions. If a language provider is not available for a given file, then this method should keep a queue, such that files can be initialized once a server is available. Parameters ---------- language: str Programming language of the given file filename: str Filename to register codeeditor: spyder.plugins.editor.widgets.codeeditor.CodeEditor Codeeditor to send the provider configurations Nr`)rQrirj codeeditors rb register_filez&SpyderCompletionProvider.register_file rareq_typereqreq_idcdS)a Send completion/introspection request from Spyder. The completion request `req_type` needs to have a response. Parameters ---------- language: str Programming language for the incoming request req_type: str Type of request, one of :class:`spyder.plugins.completion.api.CompletionRequestTypes` req: dict Request body { 'filename': str, **kwargs: request-specific parameters } req_id: int Request identifier for response Notes ----- A completion client should always reply to the `textDocument/completion` request, even if the answer is empty. Nr`)rQrirorprqs rb send_requestz%SpyderCompletionProvider.send_requests 6 ranotification_type notificationcdS)aD Send notification to completion server based on Spyder changes. All notifications sent won't return a response by the provider. Parameters ---------- language: str Programming language for the incoming request notification_type: str Type of request, one of :class:`spyder.plugins.completion.api.CompletionRequestTypes` notification: dict Request body { 'filename': str, **kwargs: request-specific parameters } Nr`)rQrirtrus rbsend_notificationz*SpyderCompletionProvider.send_notifications ( racdS)a Send a broadcast notification across all programming languages. Parameters ---------- notification_type: str Type of request, one of :class:`spyder.plugins.completion.CompletionTypes` notification: dict Notification body { **kwargs: notification-specific parameters } Nr`)rQrtrus rbbroadcast_notificationz/SpyderCompletionProvider.broadcast_notificationrnraresponseresp_idcdS)a$ Send response for server request. Parameters ---------- response: dict Response body for server { **kwargs: response-specific keys } resp_id: int Request identifier for response Nr`)rQrzr{s rb send_responsez&SpyderCompletionProvider.send_responses  ra project_path update_kindinstancecdS)a Handle project path updates on Spyder. Parameters ---------- project_path: str Path to the project folder being added or removed. update_kind: str Path update kind, one of :class:`spyder.plugins.completion.api.WorkspaceUpdateKind` instance: object Reference to :class:`spyder.plugins.projects.plugin.Projects` Nr`)rQr~rrs rbproject_path_updatez,SpyderCompletionProvider.project_path_updates  racdS)a Handle Python path updates on Spyder. Parameters ---------- previous_path: Dict Dictionary containing the previous Python path values. new_path: Dict Dictionary containing the current Python path values. Nr`)rQ previous_pathnew_paths rbpython_path_updatez+SpyderCompletionProvider.python_path_update&s  racdS)z8Handle changes on the main Python interpreter of Spyder.Nr`rgs rbmain_interpreter_changedz1SpyderCompletionProvider.main_interpreter_changed4s  racdS)ak Handle file modifications and file switching events, including when a new file is created. Parameters ---------- filename: str Path to the file that was changed/opened/updated. language: str Name of the programming language of the file that was changed/opened/updated. Nr`)rQrjris rbfile_opened_closed_or_updatedz6SpyderCompletionProvider.file_opened_closed_or_updated9s  racdS)a9 Start completions/introspection services for a given language. Parameters ---------- language: str Programming language to start analyzing. Returns ------- bool True if language provider could be started, otherwise False. Fr`rQris rb&start_completion_services_for_languagez?SpyderCompletionProvider.start_completion_services_for_languageHs uracdS)z Stop completions/introspection services for a given language. Parameters ---------- language: str Programming language to stop analyzing. Nr`rs rb%stop_completion_services_for_languagez>SpyderCompletionProvider.stop_completion_services_for_languageXs  rac td)a` Start completion provider. The completion provider startup logic must be invoked on this method. Note: Once the completion provider is ready, the signal `sig_provider_ready` must be emitted with the completion provider name, e.g., `self.sig_provider_ready.emit(self.COMPLETION_PROVIDER_NAME)` z,A completion provider must implement start())NotImplementedErrorrgs rbstartzSpyderCompletionProvider.startcs" :<< Add a SpyderAction or a QWidget to the menu. )rTbeforeN)raadd_item_to_menu)rQaction_or_menumenurTrs rbrz)SpyderCompletionProvider.add_item_to_menuXs; "" D'& # B B B B BracD|j|||||dS)a Add action or widget `item` to given application menu `section`. Parameters ---------- item: SpyderAction or SpyderMenu The item to add to the `menu`. menu: ApplicationMenu or None Instance of a Spyder application menu. menu_id: str or None The application menu unique string identifier. section: str or None The section id in which to insert the `item` on the `menu`. before: str or None Make the item appear before another given item. before_section: Section or None Make the item section (if provided) appear before another given section. Notes ----- Must provide a `menu` or a `menu_id`. )rrTrbefore_sectionN)raadd_item_to_application_menu)rQitemrrTrrs rbrz5SpyderCompletionProvider.add_item_to_application_menu`s94 .. '7. / : : : : :raitem_idrc>|j||dS)a Remove action or widget from given application menu by id. Parameters ---------- item_id: str The item identifier to remove from the given menu. menu_id: str or None The application menu unique string identifier. )rN)ra!remove_item_from_application_menu)rQrrs rbrz:SpyderCompletionProvider.remove_item_from_application_menu~s% 33GW3MMMMMra)NN)NT)T)NNNN)N)>r@rArBrCrstrrdictsig_response_readysig_provider_ready"sig_language_completions_availablesig_disable_providerrusig_show_widgetrZsig_call_statusbar sig_open_filesig_stop_completionssig_exception_occurredrL DEFAULT_ORDERSLOW CONF_DEFAULTS CONF_VERSION CONF_TABSSTATUS_BAR_CLASSESr`rhrmrsrwryr}rrr rrrboolrrrrrrrrrrrr WidgetWithChildrenShortcutrrrrrrrrrr`rarbr\r\s' S$//  *0c):):& "6#;;fVnnO S%66"F3KKM"6#;; $VD\\D $M DML I"*# c S    $  +. 59 CF    :  47 GK    , %( 8<    $ d S      # &)    " T&&      TVV   V   c  S     st  c      < < <   4   !%*.*;*;#CsCx$89*;*;#3-*;47*;*;*;*;^+/04 ,J,J#CsCx$89,J,J#3-,J*. ,J,J,J,J\.2RT"dT ;T(-/B/B/B/BbJJJJ: K K K K::::$15)-99 9!#9999 7 7 7>B $BBBB:>:>48::::>DH N N N3;C= N N N N N Nrar\)OrCtypingrrrr qtpy.QtCorerrr r spyder.api.config.mixinsr SUPPORTED_LANGUAGESr#rDrErFrGrHrIrJrKrLrMrNrOrPrQrRrSrTrUrVrWrXrYrZr[r\r]r^r_SYMBOL_KIND_ICONrrrrrrr__dict__rFWORKSPACE_CAPABILITIESTEXT_EDITOR_CAPABILITESCLIENT_CAPABILITESr SAVE_OPTIONSrTEXT_DOCUMENT_SYNC_OPTIONSCOMPLETION_OPTIONSSIGNATURE_HELP_OPTIONSCODE_LENS_OPTIONS#DOCUMENT_ON_TYPE_FORMATTING_OPTIONSDOCUMENT_LINK_OPTIONSEXECUTE_COMMAND_OPTIONSWORKSPACE_OPTIONSSERVER_CAPABILITESrrr r&r/r2r7r:COMPLETION_ENTRYPOINTr@r\r`rarbrs/...........211111111111A@@@@@FOVx+  g  x gMOV+x x!" #$gxNEOVMxg/nOV9F 6 6 6 6 6 6 6 6.  4;4;4;=/<   t t t $ 44J,?,F,F,H,H444  u;;H $ " !0 $#%0=   * $&  $ "K=!  " t t t t t t t t t t tw^^H(+4  #' !2 u" ''#u$;2 ;U;,;3; %!;&%';, -;2e3;8u9;>%?;D)E;J!%K;P&uQ;V'(KW;\e];b1c;h5i;n#u;;;|4747474747474747r        , -11111&A111hy Ny Ny Ny Ny Nw(Gy Ny Ny Ny Ny Nra