spinetoolbox.widgets.kernel_editor

Dialog for selecting a kernel or creating a new Julia or Python kernel.

author

16. Savolainen (VTT)

date

7.10.2020

Module Contents

Classes

KernelEditorBase
KernelEditor	Class for a Python and Julia kernel editor.
MiniKernelEditorBase
MiniPythonKernelEditor	A reduced version of KernelEditor that basically just takes care of installing one Python kernel.
MiniJuliaKernelEditor	A reduced version of KernelEditor that basically just takes care of installing one Julia kernel.

Functions

find_kernels()	Returns a dictionary mapping kernel names to kernel paths.
find_python_kernels()	Returns a dictionary of Python kernels. Keys are kernel_names, values are kernel paths.
find_julia_kernels()	Returns a dictionary of Julia kernels. Keys are kernel_names, values are kernel paths.
find_unknown_kernels()	Returns a dictionary of kernels that are neither Python nor Julia kernels.
format_event_message(msg_type, message, show_datetime=True)	Formats message for the kernel editor text browser.
format_process_message(msg_type, message)	Formats process message for the kernel editor text browser.

class spinetoolbox.widgets.kernel_editor.KernelEditorBase(parent, python, julia, python_or_julia, current_kernel)

Bases: PySide2.QtWidgets.QDialog

setup_dialog_style(self)

Sets windows icon and stylesheet. This can be removed when SettingsWidget inherits stylesheet from ToolboxUI.

connect_signals(self)

Connects signals to slots.

check_options(self, prgm, kernel_name, display_name, python_or_julia)

Checks that user options are valid before advancing with kernel making.

Parameters

• prgm (str) – Full path to Python or Julia program

• kernel_name (str) – Kernel name

• display_name (str) – Kernel display name

• python_or_julia (str) – Either ‘python’ or ‘julia’

Returns

True if all user input is valid for making a new kernel, False otherwise

Return type

bool

_python_kernel_name(self)

_python_kernel_display_name(self)

make_python_kernel(self, checked=False)

Makes a new Python kernel. Offers to install ipykernel package if it is missing from the selected Python environment. Overwrites existing kernel with the same name if this is ok by user.

static is_package_installed(python_path, package_name)

Checks if given package is installed to given Python environment.

Parameters

• python_path (str) – Full path to selected Python interpreter

• package_name (str) – Package name

Returns

True if installed, False if not

Return type

(bool)

start_package_install_process(self, python_path, package_name)

Starts installing the given package using pip.

Parameters

• python_path (str) – Full path to selected Python interpreter

• package_name (str) – Package name to install using pip

handle_package_install_process_finished(self, retval)

Handles installing package finished.

Parameters

retval (int) – Process return value. 0: success, !0: failure

start_kernelspec_install_process(self, prgm, k_name, d_name)

Installs kernel specifications for the given Python environment. Runs e.g. this command in QProcess

python -m ipykernel install –user –name python-X.Y –display-name PythonX.Y

Creates new kernel specs into %APPDATA%jupyterkernels. Existing directory will be overwritten.

Note: We cannot use –sys.prefix here because if we have selected to create a kernel for some other python that was used in launching the app, the kernel will be created into a location that is not discoverable by jupyter and hence not by Spine Toolbox. E.g. when sys.executable is C:Python36python.exe, and we have selected that as the python for Spine Toolbox (Settings->Tools->Python interpreter is empty), creating a kernel with –sys-prefix creates kernel specs into C:Python36sharejupyterkernelspython-3.6. This is ok and the kernel spec is discoverable by jupyter and Spine Toolbox.

BUT when sys.executable is C:Python36python.exe, and we have selected another python for Spine Toolbox (Settings->Tools->Python interpreter is C:Python38python.exe), creating a kernel with –sys-prefix creates a kernel into C:Python38sharejupyterkernelspython-3.8-sys-prefix. This is not discoverable by jupyter nor Spine Toolbox. You would need to start the app using C:Python38python.exe to see and use that kernel spec.

Using –user option instead, creates kernel specs that are discoverable by any python that was used in starting Spine Toolbox.

Parameters

• prgm (str) – Full path to Python interpreter for which the kernel is created

• k_name (str) – Kernel name

• d_name (str) – Kernel display name

handle_kernelspec_install_process_finished(self, retval)

Handles case when the process for installing the kernel has finished.

Parameters

retval (int) – Process return value. 0: success, !0: failure

_julia_kernel_name(self)

make_julia_kernel(self, checked=False)

Makes a new Julia kernel. Offers to install IJulia package if it is missing from the selected Julia project. Overwrites existing kernel with the same name if this is ok by user.

_is_rebuild_ijulia_needed(self)

is_ijulia_installed(self, program, project)

Checks if IJulia is installed for the given project. Note: Trying command ‘using IJulia’ does not work since it automatically tries loading it from the LOAD_PATH if not it’s not found in the active project.

Returns

0 when process failed to start, 1 when IJulia is installed, 2 when IJulia is not installed.

Return type

(int)

start_ijulia_install_process(self, julia, project)

Starts installing IJulia package to given Julia project.

Parameters

• julia (str) – Full path to selected Julia executable

• project (str) – Julia project (e.g. dir path or ‘@.’, or ‘.’)

handle_ijulia_install_finished(self, ret)

Runs when IJulia install process finishes.

Parameters

ret (int) – Process return value. 0: success, !0: failure

start_ijulia_rebuild_process(self, program, project)

Starts rebuilding IJulia.

handle_ijulia_rebuild_finished(self, ret)

Runs when IJulia rebuild process finishes.

Parameters

ret (int) – Process return value. 0: success, !0: failure

start_ijulia_installkernel_process(self, program, project, kernel_name)

Installs the kernel using IJulia.installkernel function. Given kernel_name is actually the new kernel DISPLAY name. IJulia strips the whitespace and uncapitalizes this to make the kernel name automatically. Julia version is concatenated to both names automatically (This cannot be changed).

handle_installkernel_process_finished(self, retval)

Checks whether or not the IJulia.installkernel process finished successfully.

Parameters

retval (int) – Process return value. 0: success, !0: failure

restore_dialog_dimensions(self)

Restore widget location, dimensions, and state from previous session.

add_message(self, msg)

Append regular message to kernel editor text browser.

Parameters

msg (str) – String written to QTextBrowser

add_success_message(self, msg)

Append message with green text color to kernel editor text browser.

Parameters

msg (str) – String written to QTextBrowser

add_error_message(self, msg)

Append message with red color to kernel editor text browser.

Parameters

msg (str) – String written to QTextBrowser

add_warning_message(self, msg)

Append message with yellow (golden) color to kernel editor text browser.

Parameters

msg (str) – String written to QTextBrowser

add_process_message(self, msg)

Writes message from stdout to kernel editor text browser.

Parameters

msg (str) – String written to QTextBrowser

add_process_error_message(self, msg)

Writes message from stderr to kernel editor text browser.

Parameters

msg (str) – String written to QTextBrowser

_save_ui(self)

class spinetoolbox.widgets.kernel_editor.KernelEditor(parent, python, julia, python_or_julia, current_kernel)

Bases: KernelEditorBase

Class for a Python and Julia kernel editor.

Parameters

• parent (QWidget) – Parent widget (Settings widget)

• python (str) – Python interpreter, may be empty string

• julia (str) – Julia executable, may be empty string

• python_or_julia (str) – Setup KernelEditor according to selected mode

• current_kernel (str) – Current selected Python or Julia kernel name

connect_signals(self)

Connects signals to slots.

_handle_kernel_selection_changed(self, _selected, _deselected)

_update_ok_button_enabled(self)

python_kernel_name_edited(self, txt)

Updates the display name place holder text and the command QCustomLabel tool tip.

select_julia_clicked(self, checked=False)

Opens file browser where user can select a Julia executable for the new kernel.

select_julia_project_clicked(self, checked=False)

Opens file browser where user can select a Julia project path for the new kernel.

select_python_clicked(self, checked=False)

Opens file browser where user can select the python interpreter for the new kernel.

update_python_cmd_tooltip(self)

Updates Python command (CustomQLabel) tooltip according to selections.

update_julia_cmd_tooltip(self)

Updates Julia command (CustomQLabel) tooltip according to selections.

set_kernel_selected(self, k_name)

Finds row index of given kernel name from the model, sets it selected and scrolls the view so that it’s visible.

Parameters

k_name (str) – Kernel name to find and select

_check_kernel_is_ok(self, current, previous)

Shows a notification if there are any known problems with selected kernel.

Parameters

• current (QModelIndex) – Currently selected index

• previous (QModelIndex) – Previously selected index

find_column(self, label)

Returns the column number from the kernel model with the given label.

Parameters

label (str) – Header column label

Returns

Column number or -1 if label not found

Return type

int

check_options(self, prgm, kernel_name, display_name, python_or_julia)

Checks that user options are valid before advancing with kernel making.

Parameters

• prgm (str) – Full path to Python or Julia program

• kernel_name (str) – Kernel name

• display_name (str) – Kernel display name

• python_or_julia (str) – Either ‘python’ or ‘julia’

Returns

True if all user input is valid for making a new kernel, False otherwise

Return type

bool

_is_rebuild_ijulia_needed(self)

handle_kernelspec_install_process_finished(self, retval)

Handles case when the process for installing the kernel has finished.

Parameters

retval (int) – Process return value. 0: success, !0: failure

handle_installkernel_process_finished(self, retval)

Checks whether or not the IJulia.installkernel process finished successfully.

Parameters

retval (int) – Process return value. 0: success, !0: failure

populate_kernel_model(self)

Populates the kernel model with kernels found in user’s system either with Python or Julia kernels. Unknows, invalid, and unsupported kernels are appended to the end.

static get_kernel_deats(kernel_path)

Reads kernel.json from given kernel path and returns the details in a dictionary.

Parameters

kernel_path (str) – Full path to kernel directory

Returns

language (str), path to interpreter (str), display name (str), project (str) (NA for Python kernels)

Return type

dict

show_kernel_list_context_menu(self, pos)

Shows the context-menu in the kernel list table view.

_open_kernel_json(self, checked=False)

Opens kernel.json file using the default application for .json files.

_open_kernel_dir(self, checked=False)

Opens kernel directory in OS file browser.

_remove_kernel(self, checked=False)

Removes selected kernel by deleting the kernel directory.

mousePressEvent(self, e)

Saves mouse position at the start of dragging.

Parameters

e (QMouseEvent) – Mouse event

mouseReleaseEvent(self, e)

Saves mouse position at the end of dragging.

Parameters

e (QMouseEvent) – Mouse event

mouseMoveEvent(self, e)

Moves the window when mouse button is pressed and mouse cursor is moved.

Parameters

e (QMouseEvent) – Mouse event

done(self, r)

Overridden QDialog method. Sets the selected kernel instance attribute so that it can be read by the SettingsForm after this dialog has been closed.

Parameters

r (int) –

closeEvent(self, event=None)

Handles dialog closing.

Parameters

event (QCloseEvent) – Close event

class spinetoolbox.widgets.kernel_editor.MiniKernelEditorBase(parent, python_exe, julia_exe, python_or_julia)

Bases: KernelEditorBase

_show_close_button(self, failed=False)

make_kernel(self)

class spinetoolbox.widgets.kernel_editor.MiniPythonKernelEditor(parent, python_exe)

Bases: MiniKernelEditorBase

A reduced version of KernelEditor that basically just takes care of installing one Python kernel. The python exe is passed in the constructor, then calling make_kernel starts the process.

_python_kernel_name(self)

_python_kernel_display_name(self)

_do_make_kernel(self)

handle_kernelspec_install_process_finished(self, retval)

Handles case when the process for installing the kernel has finished.

Parameters

retval (int) – Process return value. 0: success, !0: failure

class spinetoolbox.widgets.kernel_editor.MiniJuliaKernelEditor(parent, julia_exe, julia_project)

Bases: MiniKernelEditorBase

A reduced version of KernelEditor that basically just takes care of installing one Julia kernel. The julia exe and project are passed in the constructor, then calling make_kernel starts the process.

_julia_kernel_name(self)

_do_make_kernel(self)

handle_installkernel_process_finished(self, retval)

Checks whether or not the IJulia.installkernel process finished successfully.

Parameters

retval (int) – Process return value. 0: success, !0: failure

spinetoolbox.widgets.kernel_editor.find_kernels()

Returns a dictionary mapping kernel names to kernel paths.

spinetoolbox.widgets.kernel_editor.find_python_kernels()

Returns a dictionary of Python kernels. Keys are kernel_names, values are kernel paths.

spinetoolbox.widgets.kernel_editor.find_julia_kernels()

Returns a dictionary of Julia kernels. Keys are kernel_names, values are kernel paths.

spinetoolbox.widgets.kernel_editor.find_unknown_kernels()

Returns a dictionary of kernels that are neither Python nor Julia kernels.

spinetoolbox.widgets.kernel_editor.format_event_message(msg_type, message, show_datetime=True)

Formats message for the kernel editor text browser. This is a copy of helpers.format_event_message() but the colors have been edited for a text browser with a white background.

spinetoolbox.widgets.kernel_editor.format_process_message(msg_type, message)

Formats process message for the kernel editor text browser.