genie-python 15.1.0rc1__tar.gz

genie_python-15.1.0rc1/.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+75bb795dad342ba7ecdca101653326459597922a
+64f120eddbf62214f7bb34d1492b856aa7df0c3b
+7b4ca34f7e26bce2d2c33953a82142214e590e51
+2082444b40dbc11f764e033998527791ce1d0e85
+26b8eb3ff334eab700ae75ac4393796d5a5df95d
+d771c7ff205a3e4f23dd55418cfebce95de1e935

genie_python-15.1.0rc1/.gitattributes

@@ -0,0 +1,33 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.c text
+*.cpp text
+*.h text
+*.hpp text
+*.java text
+*.cmd text
+*.db text
+*.dbd text
+*.template text
+*.substitutions text
+*.acf text
+*.py text
+*.md text
+*.rst text
+
+# Declare files that will always have LF line endings on checkout.
+*.sh text eol=lf
+
+# Declare files that will always have CRLF line endings on checkout.
+*.sln text eol=crlf
+*.bat text eol=crlf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.class binary
+*.vi binary
+*.ico binary

genie_python-15.1.0rc1/.github/workflows/documentation.yml

@@ -0,0 +1,8 @@
+name: sphinx
+
+on: [push, pull_request, workflow_call]
+
+jobs:
+  call_sphinx_builder:
+    uses: ISISComputingGroup/reusable-workflows/.github/workflows/sphinx.yml@main
+    secrets: inherit

genie_python-15.1.0rc1/.github/workflows/lint_and_test.yml

@@ -0,0 +1,45 @@
+env:
+  PYTHONUNBUFFERED: "TRUE"
+name: test
+on: [pull_request, workflow_call]
+jobs:
+  lint:
+    uses: ISISComputingGroup/reusable-workflows/.github/workflows/linters.yml@main
+    with:
+      compare-branch: origin/main
+      python-ver: '3.11'
+  unit-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "windows-latest"]
+        version: ['3.11']
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.version }}
+      - name: Install base requirements
+        run: pip install -e .
+      - name: Verify package is importable
+        run: |
+          python -c "from genie_python.genie_startup import *"
+          python -c "from genie_python import genie as g"
+      - name: Install dev requirements
+        run: pip install -e .[dev]
+      - name: Run unit tests
+        run: python -m pytest
+  results:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: Final Results
+    needs: [lint, unit-tests]
+    steps:
+    - run: exit 1
+      # see https://stackoverflow.com/a/67532120/4907315
+      if: >-
+          ${{
+               contains(needs.*.result, 'failure')
+            || contains(needs.*.result, 'cancelled')
+          }}

genie_python-15.1.0rc1/.github/workflows/release.yml

@@ -0,0 +1,92 @@
+name: Publish Python distribution to PyPI
+on: push
+jobs:
+  lint-and-test:
+    if: github.ref_type == 'tag'
+    name: Run lint & tests
+    uses: ./.github/workflows/lint_and_test.yml
+  build:
+    needs: lint-and-test
+    if: github.ref_type == 'tag'
+    name: build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+  publish-to-pypi:
+    name: >-
+      Publish Python distribution to PyPI
+    if: github.ref_type == 'tag'
+    needs: [lint-and-test, build]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/p/genie_python
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+  github-release:
+    name: >-
+      Sign the Python distribution with Sigstore
+      and upload them to GitHub Release
+    needs: [lint-and-test, build, publish-to-pypi]
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v2.1.1
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'

genie_python-15.1.0rc1/.gitignore

@@ -0,0 +1,164 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+_build/

genie_python-15.1.0rc1/Jenkinsfile

@@ -0,0 +1,121 @@
+#!groovy
+
+pipeline {
+
+  // agent defines where the pipeline will run.
+  agent {  
+    label {
+      label "genie"
+    }
+  }
+  
+  environment {
+      NODE = "${env.NODE_NAME}"
+      PLOCK = "python_${NODE}"
+  }
+  
+  triggers {
+    pollSCM('H/2 * * * *')
+  }
+
+  // The options directive is for configuration that applies to the whole job.
+  options {
+    buildDiscarder(logRotator(numToKeepStr:'5', daysToKeepStr: '7'))
+    disableConcurrentBuilds()
+    timestamps()
+    office365ConnectorWebhooks([[
+                    name: "Office 365",
+                    notifyBackToNormal: true,
+                    startNotification: false,
+                    notifyFailure: true,
+                    notifySuccess: false,
+                    notifyNotBuilt: false,
+                    notifyAborted: false,
+                    notifyRepeatedFailure: true,
+                    notifyUnstable: true,
+                    url: "${env.MSTEAMS_URL}"
+            ]]
+    )
+  }
+
+  stages {  
+    stage("Checkout") {
+      steps {
+        timeout(time: 2, unit: 'HOURS') {
+          retry(5) {
+            echo "Branch: ${env.BRANCH_NAME}"
+            checkout scm
+          }
+        }
+      }
+   }
+    
+    stage("Build for Python 3") {
+      steps {
+        echo "Build Number: ${env.BUILD_NUMBER}"
+        lock(resource: PLOCK, inversePrecedence: false) {
+        timeout(time: 120, unit: 'MINUTES') {
+        script {
+            env.GIT_COMMIT = bat(returnStdout: true, script: '@git rev-parse HEAD').trim()
+            env.GIT_BRANCH = bat(returnStdout: true, script: '@git rev-parse --abbrev-ref HEAD').trim()
+            echo "git commit: ${env.GIT_COMMIT}"
+            echo "git branch: ${env.BRANCH_NAME} ${env.GIT_BRANCH}"
+            // env.BRANCH_NAME is only supplied to multi-branch pipeline jobs
+            if (env.BRANCH_NAME == null) {
+                env.BRANCH_NAME = "master"
+            }
+
+            if (env.BRANCH_NAME != null && env.BRANCH_NAME.startsWith("Release")) {
+                env.IS_RELEASE = "YES"
+                env.RELEASE_VERSION = "${env.BRANCH_NAME}".replace('Release_', '')
+                echo "release version: ${env.RELEASE_VERSION}"
+            }
+            else {
+                env.IS_RELEASE = "NO"
+                env.RELEASE_VERSION = ""
+            }
+        }
+        bat """
+            git clean -fqdx
+            set BUILD_NUMBER=${env.BUILD_NUMBER}
+            set BRANCH_NAME=${env.BRANCH_NAME}
+            set GIT_COMMIT=${env.GIT_COMMIT}
+            set RELEASE_BRANCH=${env.RELEASE_VERSION}
+            set RELEASE=${env.IS_RELEASE}
+            cd package_builder
+            jenkins_build_python.bat 3
+            """
+        }
+        }
+      }
+    }
+    stage("Report Unit Tests python 3") {
+      steps {
+        junit '**/test-reports/TEST-*.xml'
+      }
+   }
+    stage("Trigger Downstream") {
+      steps {
+        build job: 'ibex_gui_pipeline', wait: false
+      }
+    }
+  }
+  post {
+    cleanup {
+            echo "***"
+            echo "*** Any Office365connector Matched status FAILURE message below means"
+            echo "*** an earlier Jenkins step failed not the Office365connector itself"
+            echo "*** Search log file for  ERROR  to locate true cause"
+            echo "***"
+    }
+    always {
+        logParser ([
+                projectRulePath: 'parse_rules',
+                parsingRulesPath: '',
+                showGraphs: true,
+                unstableOnWarning: false,
+                useProjectRule: true,
+            ])
+    }
+  }
+}

genie_python-15.1.0rc1/Jenkinsfile_linux

@@ -0,0 +1,97 @@
+#!groovy
+
+pipeline {
+
+  // agent defines where the pipeline will run.
+  agent {  
+    label {
+      label "sl7cloud"
+    }
+  }
+  
+  triggers {
+    pollSCM('H/2 * * * *')
+  }
+
+  // The options directive is for configuration that applies to the whole job.
+  options {
+    buildDiscarder(logRotator(numToKeepStr:'5', daysToKeepStr: '7'))
+    timeout(time: 60, unit: 'MINUTES')
+    disableConcurrentBuilds()
+    timestamps()
+    office365ConnectorWebhooks([[
+                    name: "Office 365",
+                    notifyBackToNormal: true,
+                    startNotification: false,
+                    notifyFailure: true,
+                    notifySuccess: false,
+                    notifyNotBuilt: false,
+                    notifyAborted: false,
+                    notifyRepeatedFailure: true,
+                    notifyUnstable: true,
+                    url: "${env.MSTEAMS_URL}"
+            ]]
+    )
+  }
+
+  stages {  
+    stage("Checkout") {
+      steps {
+        echo "Branch: ${env.BRANCH_NAME}"
+        checkout scm
+      }
+    }
+    
+    stage("Build for Python 3") {
+      steps {
+        echo "Build Number: ${env.BUILD_NUMBER}"
+        script {
+            env.GIT_COMMIT = sh(returnStdout: true, script: 'git rev-parse HEAD').trim()
+            env.GIT_BRANCH = sh(returnStdout: true, script: 'git rev-parse --abbrev-ref HEAD').trim()
+            echo "git commit: ${env.GIT_COMMIT}"
+            echo "git branch: ${env.BRANCH_NAME} ${env.GIT_BRANCH}"
+            // env.BRANCH_NAME is only supplied to multi-branch pipeline jobs
+            if (env.BRANCH_NAME == null) {
+                env.BRANCH_NAME = "master"
+            }
+
+            if (env.BRANCH_NAME != null && env.BRANCH_NAME.startsWith("Release")) {
+                env.IS_RELEASE = "YES"
+                env.RELEASE_VERSION = "${env.BRANCH_NAME}".replace('Release_', '')
+                echo "release version: ${env.RELEASE_VERSION}"
+            }
+            else {
+                env.IS_RELEASE = "NO"
+                env.RELEASE_VERSION = ""
+            }
+        }
+        
+        sh """
+            git clean -fqdx
+            export BUILD_NUMBER=${env.BUILD_NUMBER}
+            export BRANCH_NAME=${env.BRANCH_NAME}
+            export GIT_COMMIT=${env.GIT_COMMIT}
+            export RELEASE_BRANCH=${env.RELEASE_VERSION}
+            export RELEASE=${env.IS_RELEASE}
+            cd package_builder
+            sh jenkins_build_python.sh
+            """
+      }
+    }
+    stage("Report Unit Tests python 3") {
+      steps {
+        junit '**/test-reports/TEST-*.xml'
+      }
+   }
+    stage("Trigger Downstream") {
+      steps {
+        build job: 'ibex_gui_linux_pipeline', wait: false
+      }
+    }
+  }
+  post {
+    always {
+       archiveArtifacts artifacts: 'docs/_build/html/**/*', caseSensitive: false
+    }
+  }
+}

genie_python-15.1.0rc1/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, ISIS Experiment Controls Computing
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

genie_python-15.1.0rc1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.1
+Name: genie_python
+Version: 15.1.0rc1
+Summary: Instrument control & scripting for the ISIS Neutron & Muon source
+Author-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
+Maintainer-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, ISIS Experiment Controls Computing
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/isiscomputinggroup/genie
+Project-URL: Bug Reports, https://github.com/isiscomputinggroup/genie/issues
+Project-URL: Source, https://github.com/isiscomputinggroup/genie
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: CaChannel
+Requires-Dist: caffi
+Requires-Dist: graypy
+Requires-Dist: ipython
+Requires-Dist: mysql-connector-python
+Requires-Dist: numpy
+Requires-Dist: p4p
+Requires-Dist: psutil
+Requires-Dist: pylint
+Requires-Dist: pyright
+Requires-Dist: pywin32; platform_system == "Windows"
+Provides-Extra: plot
+Requires-Dist: matplotlib==3.9.2; extra == "plot"
+Requires-Dist: py4j; extra == "plot"
+Requires-Dist: tornado; extra == "plot"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx_rtd_theme; extra == "doc"
+Requires-Dist: myst_parser; extra == "doc"
+Requires-Dist: sphinx-autobuild; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: genie_python[doc,plot]; extra == "dev"
+Requires-Dist: mock; extra == "dev"
+Requires-Dist: parameterized; extra == "dev"
+Requires-Dist: pyhamcrest; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+
+# genie_python
+
+The ISIS Python-based instrument control and scripting library.
+
+## Instrument initialisation
+
+By default when setting an instrument the init_default.py file is loaded. 
+This file checks for the existence of a folder called C:\Instrument\Settings\config\NDX%INSTNAME%\Python and adds this to the sys path if it does.
+If this path exists and contains a file called init_%INSTNAME%.py, it will load it too.
+
+On the NDX any files in C:\Instrument\Settings\config\NDX%INSTNAME%\Python can be added to SVN for safe keeping.
+
+Python modules can be imported directly from the C:\Instrument\Settings\config\NDX%INSTNAME%\Python directory. If running on a client it is necessary to have a copy of the Python directory for the instrument being connected to in the correct location.
+
+Folders inside the Python directory must have a `__init__.py` file for them to be available to be imported.
+
+## Start-up
+The line "from genie_python import *" in genie_startup is responsible for loading all the genie_python stuff!
+This file also contains code for disabling quickedit and for making genie_python guess the instrument name.
+
+As genie_python is running inside IPython we use c.TerminalIPythonApp.exec_files to run genie_start.py, so everything is imported correctly.