ccpn.ui.gui.modules.macroEditorUtil package

Module Documentation here

Subpackages

Submodules

ccpn.ui.gui.modules.macroEditorUtil.CompletionProviders module

Module Documentation here

class ccpn.ui.gui.modules.macroEditorUtil.CompletionProviders.CcpnCodeCompletionWorker[source]

Bases: object

This is the worker associated with the code completion mode.

The worker does not actually do anything smart, the real work of collecting code completions is accomplished by the completion providers (see the pyqode.core.backend.workers.CodeCompletionWorker.Provider interface) listed in pyqode.core.backend.workers.CompletionWorker.providers.

Completion providers must be installed on the CodeCompletionWorker at the beginning of the main server script, e.g.:

from pyqode.core.backend import CodeCompletionWorker
CodeCompletionWorker.providers.insert(0, MyProvider())
providers = [<ccpn.ui.gui.modules.macroEditorUtil.CompletionProviders.CcpnNameSpacesProvider object>, <pyqode.core.backend.workers.DocumentWordsProvider object>]

The list of code completion provider to run on each completion request.

registerProvider(provider)[source]
class ccpn.ui.gui.modules.macroEditorUtil.CompletionProviders.CcpnJediCompletionProvider[source]

Bases: object

Provides code completion using the original Jedi library. https://github.com/davidhalter/jedi

static complete(code, line, column, path, encoding, prefix)[source]

Completes python code using `jedi`_.

Returns

a list of completion.

class ccpn.ui.gui.modules.macroEditorUtil.CompletionProviders.CcpnNameSpacesProvider[source]

Bases: object

Provides code completion for the Ccpn Namespace…

complete(code, line, column, path, encoding, prefix, *args)[source]

Completes python code using `jedi`_. :returns: a list of completion.

ccpn.ui.gui.modules.macroEditorUtil.CompletionProviders.getJediInterpreter(text, namespaces=None, useImports=False, **kwds)[source]

Other optional arguments are same as the ones for :class:”Script”. If “line” and “column” are None, they are assumed be at the end of “text”.

ccpn.ui.gui.modules.macroEditorUtil.IconDefinitions module

Module Documentation here

ccpn.ui.gui.modules.macroEditorUtil.IconDefinitions.iconFromTypename(name, iconType, ccpnTag=False)[source]

Returns the icon resource filename that corresponds to the given typename.

Parameters

name – name of the completion. Use to make the distinction between public and private completions (using the count of starting ‘_’)

Pram typename

the typename reported by jedi

Returns

The associate icon resource filename or None.

ccpn.ui.gui.modules.macroEditorUtil.MacroEditorNativeServer module

Module Documentation here

ccpn.ui.gui.modules.macroEditorUtil.MacroEditorServer module

Module Documentation here

ccpn.ui.gui.modules.macroEditorUtil.QPythonEditor module

class ccpn.ui.gui.modules.macroEditorUtil.QPythonEditor.PyCodeEditor(parent=None, application=None, **kwds)[source]

Bases: pyqode.python.widgets.code_edit.PyCodeEdit, ccpn.ui.gui.widgets.Base.Base

close(clear=False)[source]

Closes the editor, stops the backend and removes any installed mode/panel.

This is also where we cache the cursor position.

Parameters

clear – True to clear the editor content before closing.

enterEvent(self, QEvent)[source]
get()[source]
saveToPDF(fileName=None)[source]
set(value)[source]
useNativeCompletion = False

ccpn.ui.gui.modules.macroEditorUtil.workers module

Module Documentation here

class ccpn.ui.gui.modules.macroEditorUtil.workers.CcpnCalltipsMode[source]

Bases: pyqode.python.modes.calltips.CalltipsMode

Shows function calltips.

This mode shows function/method call tips in a QToolTip using jedi.Script.call_signatures().

class ccpn.ui.gui.modules.macroEditorUtil.workers.CcpnQuickDocPanel[source]

Bases: pyqode.python.panels.quick_doc.QuickDocPanel

Shows the python documentation for the word under the text cursor.

This panel quickly shows the documentation of the symbol under cursor. Bug: Documentation doesn’t appear for decorated methods.