KNIME® Python

This repository is maintained by the KNIME Team Rakete.

The KNIME Python Integration closes the gap between KNIME Analytics Platform and Python. It provides nodes to write and execute Python scripts and functionality to make use of Python in other parts of KNIME Analytics Platform.

The legacy Python integrations can be found at knime-python-legacy.

Content

This repository contains the source code for the KNIME Python Integration. The code is organized as follows:

• org.knime.ext.py4j: OSGi Wrapper for py4j
• org.knime.python3.py4j.dependencies: Additional dependencies of the OSGi Wrapper for py4j to make classes visible to the classloader of the py4j wrapper plugin
• org.knime.python3: Core functionality for running Python code from KNIME AP
• org.knime.python3.arrow: Functionality for transferring Arrow tables between KNIME AP and Python
• org.knime.python3.arrow.types: Python implementation of special types
• org.knime.python3.nodes: Framework for writing KNIME AP nodes in Python
• org.knime.python3.scripting: Useful functionality for providing Python scripting in KNIME AP
• org.knime.python3.scripting.nodes: Implementation of Python scripting nodes for KNIME AP
• org.knime.python3.views: Library for creating node views in Python

Development Notes

Install the dev environment

$ pixi install

The environment will be installed in .pixi/envs/default. Visual Studio Code will notice that an environment was created and prompt you to use it.

Running tests

$ pixi run test  # lets you choose the environment to run the tests
$ pixi run test-all  # run tests in all test environments

Or run the tests in the development environment from Visual Studio Code via the "Testing" tab.

Coverage

Test the unit tests locally and see the coverage:

$ pixi run coverage

This command will write the coverage into an HTML report in htmlcov/index.html. Additionally, you can view the coverage in Visual Studio Code using the extension "Coverage Gutters".

Code Formatting

Use the Ruff Formatter for Python files.

$ pixi run format

You can find instructions on how to work with our code or develop extensions for KNIME Analytics Platform in the knime-sdk-setup repository on BitBucket or GitHub.

Join the Community

• KNIME Forum