diff --git a/src/reference/changes.rst b/src/reference/changes.rst index 120410422d..84d011ae0c 100644 --- a/src/reference/changes.rst +++ b/src/reference/changes.rst @@ -38,6 +38,14 @@ Cylc 8.3.0 :cylc-uiserver: `1.4 `__ :cylc-rose: `1.4 `__ +Cylc ignores ``$PYTHONPATH`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Cylc now ignores ``$PYTHONPATH`` to make it more robust to task +environments which set this value. If you want to add to the Cylc +environment itself, e.g. to install a Cylc extension, +use a custom xtrigger, or event handler use ``$CYLC_PYTHONPATH``. + Upgrade To The Latest Jupyter Releases ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -156,11 +164,11 @@ Combined Commands Two new commands have been added as short-cuts for common working patterns: -``cylc vip`` +``cylc vip`` Validate, install and plays a workflow, equivalent to: .. code-block:: bash - + cylc validate cylc install cylc play diff --git a/src/user-guide/writing-workflows/external-triggers.rst b/src/user-guide/writing-workflows/external-triggers.rst index 167e497057..0c53feaff3 100644 --- a/src/user-guide/writing-workflows/external-triggers.rst +++ b/src/user-guide/writing-workflows/external-triggers.rst @@ -237,7 +237,7 @@ properties: - they can be located either: - in ``/lib/python/``; - - or anywhere in your Python library path. + - or anywhere in your ``$CYLC_PYTHONPATH``. - they can take arbitrary positional and keyword arguments - workflow and task identity, and cycle point, can be passed to trigger diff --git a/src/user-guide/writing-workflows/runtime.rst b/src/user-guide/writing-workflows/runtime.rst index d7f4bbb79f..81b9c46a21 100644 --- a/src/user-guide/writing-workflows/runtime.rst +++ b/src/user-guide/writing-workflows/runtime.rst @@ -325,7 +325,7 @@ as it is running, these can be placed in: * ``share/bin/`` - for executables. This location is automatically added to ``PATH`` (before the top-level ``bin/`` in the run dir). * ``share/lib/python/`` - for Python modules. This location is automatically added - to ``PYTHONPATH`` (before the top-level ``lib/python/`` in the run dir). + to ``$PYTHONPATH`` (before the top-level ``lib/python/`` in the run dir). .. note:: diff --git a/src/user-guide/writing-workflows/scheduler.rst b/src/user-guide/writing-workflows/scheduler.rst index bf6e2f31c2..5d941f5c79 100644 --- a/src/user-guide/writing-workflows/scheduler.rst +++ b/src/user-guide/writing-workflows/scheduler.rst @@ -120,6 +120,12 @@ when a workflow is started: [[events]] startup handlers = my-handler %(workflow)s %(host) %(port) + +.. note:: + + If you wish to use custom Python Libraries in an event handler you + need to add these to ``CYLC_PYTHONPATH`` rather than ``PYTHONPATH``. + .. _workflow_event_template_variables: Workflow Event Template Variables