hutch-python 1.23.1__tar.gz → 1.24.0__tar.gz

{hutch_python-1.23.1 → hutch_python-1.24.0}/.github/PULL_REQUEST_TEMPLATE.md

@@ -25,5 +25,3 @@
 - [ ] New/changed functions and methods are covered in the test suite where possible
 - [ ] Test suite passes locally
 - [ ] Test suite passes on GitHub Actions
-- [ ] Ran ``docs/pre-release-notes.sh`` and created a pre-release documentation page
-- [ ] Pre-release docs include context, functional descriptions, and contributors as appropriate

hutch_python-1.24.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    cooldown:
+      default-days: 7
+      exclude:
+      - pcdshub/pcds-ci-helpers/*

{hutch_python-1.23.1 → hutch_python-1.24.0}/.github/workflows/standard.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   standard:
-    uses: pcdshub/pcds-ci-helpers/.github/workflows/python-standard.yml@master
+    uses: pcdshub/pcds-ci-helpers/.github/workflows/python-standard.yml@52a413e9d77c09f9e7617c3a75fc19a7d6cf4e11
     secrets: inherit
     with:
       # The workflow needs to know the package name.  This can be determined

{hutch_python-1.23.1 → hutch_python-1.24.0}/.gitignore

@@ -121,3 +121,6 @@ hutch_python/tests/tst/db.txt
 
 # unit test artifacts
 *.sqlite
+
+# setuptools-scm
+_version.py

{hutch_python-1.23.1 → hutch_python-1.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hutch-python
-Version: 1.23.1
+Version: 1.24.0
 Summary: Launcher and Config Reader for LCLS Interactive IPython Sessions
 Author: SLAC National Accelerator Laboratory
 License: Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior
@@ -55,7 +55,7 @@ Requires-Dist: bluesky>=1.8.0
 Requires-Dist: coloredlogs>=15.0.0
 Requires-Dist: cookiecutter>=1.7.0
 Requires-Dist: happi>=1.9.0
-Requires-Dist: ipython<9.0.0
+Requires-Dist: ipython>=9.0.0
 Requires-Dist: jinja2>=2.11.0
 Requires-Dist: lightpath>=1.0.1
 Requires-Dist: matplotlib>=3.4.0

hutch_python-1.24.0/docs/source/releases.rst

@@ -0,0 +1,4 @@
+Release History
+###############
+
+See the `releases page on GitHub <https://github.com/pcdshub/hutch-python/releases>`_

hutch_python-1.24.0/hutch_python/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.24.0'
+__version_tuple__ = version_tuple = (1, 24, 0)
+
+__commit_id__ = commit_id = 'g39d8f6346'

{hutch_python-1.23.1 → hutch_python-1.24.0}/hutch_python/cam_load.py

@@ -123,7 +123,11 @@ def load_cams(info):
     """
     # Any cam that needs the event loop has to have one set in the thread
     global main_thread_loop
-    main_thread_loop = asyncio.get_event_loop()
+    try:
+        main_thread_loop = asyncio.get_event_loop()
+    except RuntimeError:
+        # No loop, no worries
+        main_thread_loop = None
 
     objs = {}
     logger.debug(info)
@@ -150,7 +154,8 @@ def build_and_log(info_part):
         The loaded detector, or None.
     """
     # We sync with the main thread's loop so that they work as expected later
-    asyncio.set_event_loop(main_thread_loop)
+    if main_thread_loop is not None:
+        asyncio.set_event_loop(main_thread_loop)
     try:
         obj = build_cam(*info_part)
         logger.success('Loaded %s', obj.name)

{hutch_python-1.23.1 → hutch_python-1.24.0}/hutch_python/cli.py

@@ -85,6 +85,14 @@ def configure_tab_completion(ipy_config):
     """
     Disable Jedi and tweak IPython tab completion.
 
+    At some IPython version this became no longer needed due to fixed performance issues
+    stemming from no longer by default executing properties.
+
+    At some IPython version this became counterproductive because the non-jedi
+    completer no longer works properly for us.
+
+    This change happend somewhere between 8.4.0 and 8.36.0
+
     Parameters
     ----------
     ipy_config : traitlets.config.Config
@@ -135,8 +143,11 @@ def configure_ipython_session(args: HutchPythonArgs):
 
     # Disable reformatting input with black
     ipy_config.TerminalInteractiveShell.autoformatter = None
-    # Set up tab completion modifications
-    configure_tab_completion(ipy_config)
+
+    if IPython.version_info[:3] <= (8, 4, 0):
+        # Set up tab completion modifications
+        # The last IPython version we deployed that needed this is 8.4.0
+        configure_tab_completion(ipy_config)
 
     # disable default banner
     ipy_config.TerminalIPythonApp.display_banner = False

{hutch_python-1.23.1 → hutch_python-1.24.0}/hutch_python/env_version.py

@@ -3,13 +3,12 @@ Utilities for getting relevant environment information.
 """
 from __future__ import annotations
 
+import importlib.metadata
 import logging
 import os
 import os.path
 import pkgutil
 
-import pkg_resources
-
 logger = logging.getLogger(__name__)
 
 _dev_ignore_list = ['ami', 'pdsapp']
@@ -42,10 +41,10 @@ def log_env() -> None:
 def dump_env() -> list[str]:
     """
     Get all packages and versions from the current environment.
-    conda list is slow, use pkg_resources instead
+    conda list is slow, use importlib.metadata.distributions instead
     this might miss dev overrides
     """
-    return sorted(str(pkg) for pkg in pkg_resources.working_set)
+    return sorted(str(dist.name) for dist in importlib.metadata.distributions())
 
 
 def get_conda_env_name() -> str:

{hutch_python-1.23.1 → hutch_python-1.24.0}/hutch_python/tests/test_cli.py

@@ -116,7 +116,7 @@ def test_hist_file_arg():
 
 
 @pytest.mark.timeout(30)
-@pytest.mark.parametrize("filepath,", (
+@pytest.mark.parametrize("filepath", (
     (CFG_PATH.parent / "aesefiudh" / "history.sqlite").resolve(),
     ":memory:",
 ))
@@ -156,6 +156,7 @@ def test_run_script():
             main()
 
 
+@pytest.mark.skipif(IPython.version_info[:3] > (8, 4, 0), reason="IPython completer API too unstable to test against")
 def test_ipython_tab_completion():
     class MyTest:
         THIS_SHOULD_NOT_BE_THERE = None

{hutch_python-1.23.1 → hutch_python-1.24.0}/hutch_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hutch-python
-Version: 1.23.1
+Version: 1.24.0
 Summary: Launcher and Config Reader for LCLS Interactive IPython Sessions
 Author: SLAC National Accelerator Laboratory
 License: Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior
@@ -55,7 +55,7 @@ Requires-Dist: bluesky>=1.8.0
 Requires-Dist: coloredlogs>=15.0.0
 Requires-Dist: cookiecutter>=1.7.0
 Requires-Dist: happi>=1.9.0
-Requires-Dist: ipython<9.0.0
+Requires-Dist: ipython>=9.0.0
 Requires-Dist: jinja2>=2.11.0
 Requires-Dist: lightpath>=1.0.1
 Requires-Dist: matplotlib>=3.4.0

{hutch_python-1.23.1 → hutch_python-1.24.0}/hutch_python.egg-info/SOURCES.txt

@@ -15,15 +15,13 @@ docs-requirements.txt
 pyproject.toml
 requirements.txt
 .github/CODEOWNERS
-.github/ISSUE_TEMPLATE.md
 .github/PULL_REQUEST_TEMPLATE.md
+.github/dependabot.yml
 .github/workflows/standard.yml
 bin/hutch-python
 conda-recipe/meta.yaml
 docs/Makefile
 docs/hutch_python.ipynb
-docs/pre-release-notes.sh
-docs/release_notes.py
 docs/source/beamline.rst
 docs/source/bug.rst
 docs/source/cache.rst
@@ -53,8 +51,6 @@ docs/source/tutorial.ipynb
 docs/source/user_utils.rst
 docs/source/utils.rst
 docs/source/yaml_files.rst
-docs/source/upcoming_release_notes/template-full.rst
-docs/source/upcoming_release_notes/template-short.rst
 hutch_python/__init__.py
 hutch_python/__main__.py
 hutch_python/_version.py
@@ -95,6 +91,8 @@ hutch_python.egg-info/SOURCES.txt
 hutch_python.egg-info/dependency_links.txt
 hutch_python.egg-info/entry_points.txt
 hutch_python.egg-info/requires.txt
+hutch_python.egg-info/scm_file_list.json
+hutch_python.egg-info/scm_version.json
 hutch_python.egg-info/top_level.txt
 hutch_python/cookiecutter/cookiecutter.json
 hutch_python/cookiecutter/{{ cookiecutter.hutch }}/.gitignore

{hutch_python-1.23.1 → hutch_python-1.24.0}/hutch_python.egg-info/requires.txt

@@ -3,7 +3,7 @@ bluesky>=1.8.0
 coloredlogs>=15.0.0
 cookiecutter>=1.7.0
 happi>=1.9.0
-ipython<9.0.0
+ipython>=9.0.0
 jinja2>=2.11.0
 lightpath>=1.0.1
 matplotlib>=3.4.0

hutch_python-1.24.0/hutch_python.egg-info/scm_file_list.json

@@ -0,0 +1,138 @@
+{
+  "files": [
+    ".coveragerc",
+    ".flake8",
+    ".git_archival.txt",
+    ".gitattributes",
+    ".github/CODEOWNERS",
+    ".github/PULL_REQUEST_TEMPLATE.md",
+    ".github/dependabot.yml",
+    ".github/workflows/standard.yml",
+    ".gitignore",
+    ".landscape.yml",
+    ".pre-commit-config.yaml",
+    "AUTHORS.rst",
+    "CONTRIBUTING.rst",
+    "LICENSE",
+    "MANIFEST.in",
+    "README.rst",
+    "bin/hutch-python",
+    "conda-recipe/meta.yaml",
+    "dev-requirements.txt",
+    "docs-requirements.txt",
+    "docs/Makefile",
+    "docs/hutch_python.ipynb",
+    "docs/source/beamline.rst",
+    "docs/source/bug.rst",
+    "docs/source/cache.rst",
+    "docs/source/cli.rst",
+    "docs/source/conf.py",
+    "docs/source/daq.rst",
+    "docs/source/database.rst",
+    "docs/source/debug.rst",
+    "docs/source/environment.rst",
+    "docs/source/experiment.rst",
+    "docs/source/hutch_setup.rst",
+    "docs/source/index.rst",
+    "docs/source/ipython_log.rst",
+    "docs/source/load_conf.rst",
+    "docs/source/load_parts.rst",
+    "docs/source/log_setup.rst",
+    "docs/source/namespace.rst",
+    "docs/source/object_configuration.rst",
+    "docs/source/other_modules.rst",
+    "docs/source/presets.rst",
+    "docs/source/releases.rst",
+    "docs/source/report.rst",
+    "docs/source/start.rst",
+    "docs/source/startup.rst",
+    "docs/source/tips.rst",
+    "docs/source/tutorial.ipynb",
+    "docs/source/user_utils.rst",
+    "docs/source/utils.rst",
+    "docs/source/yaml_files.rst",
+    "hutch_python/__init__.py",
+    "hutch_python/__main__.py",
+    "hutch_python/bug.py",
+    "hutch_python/cache.py",
+    "hutch_python/calc_defaults.py",
+    "hutch_python/cam_load.py",
+    "hutch_python/cli.py",
+    "hutch_python/constants.py",
+    "hutch_python/cookiecutter/cookiecutter.json",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/.gitignore",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/README.md",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/conf.yml",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/experiments/__init__.py",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/set-dev",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/{{ cookiecutter.hutch }}/__init__.py",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/{{ cookiecutter.hutch }}/beamline.py",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/{{ cookiecutter.hutch }}env",
+    "hutch_python/cookiecutter/{{ cookiecutter.hutch }}/{{ cookiecutter.hutch }}python",
+    "hutch_python/debug.py",
+    "hutch_python/env_version.py",
+    "hutch_python/epics_arch.py",
+    "hutch_python/exp_load.py",
+    "hutch_python/happi.py",
+    "hutch_python/ipython_log.py",
+    "hutch_python/ipython_session_timer.py",
+    "hutch_python/lcls.py",
+    "hutch_python/load_conf.py",
+    "hutch_python/log_setup.py",
+    "hutch_python/logging.yml",
+    "hutch_python/mpl_config.py",
+    "hutch_python/namespace.py",
+    "hutch_python/obj_config.py",
+    "hutch_python/ophyd_settings.py",
+    "hutch_python/options.py",
+    "hutch_python/plan_defaults.py",
+    "hutch_python/plan_wrappers.py",
+    "hutch_python/print_hint_banner.py",
+    "hutch_python/pt_app_config.py",
+    "hutch_python/qs_load.py",
+    "hutch_python/sim.py",
+    "hutch_python/startup_script.py",
+    "hutch_python/templates/issue.template",
+    "hutch_python/tests/__init__.py",
+    "hutch_python/tests/bad_script.py",
+    "hutch_python/tests/camviewer.cfg",
+    "hutch_python/tests/conf.yaml",
+    "hutch_python/tests/conftest.py",
+    "hutch_python/tests/envs/pcds-1.0.0",
+    "hutch_python/tests/envs/pcds-2.0.0",
+    "hutch_python/tests/envs/z-env",
+    "hutch_python/tests/experiments/sample_expname.py",
+    "hutch_python/tests/experiments/x010.py",
+    "hutch_python/tests/experiments/x011.py",
+    "hutch_python/tests/happi_db.json",
+    "hutch_python/tests/sample_module_1.py",
+    "hutch_python/tests/sample_module_2.py",
+    "hutch_python/tests/script.py",
+    "hutch_python/tests/test_bug.py",
+    "hutch_python/tests/test_cache.py",
+    "hutch_python/tests/test_cam_load.py",
+    "hutch_python/tests/test_cli.py",
+    "hutch_python/tests/test_epics_arch.py",
+    "hutch_python/tests/test_experiment.py",
+    "hutch_python/tests/test_happi.py",
+    "hutch_python/tests/test_ipython_log.py",
+    "hutch_python/tests/test_ipython_session_timer.py",
+    "hutch_python/tests/test_load_conf.py",
+    "hutch_python/tests/test_log_setup.py",
+    "hutch_python/tests/test_namespace.py",
+    "hutch_python/tests/test_obj_config.py",
+    "hutch_python/tests/test_plan_wrappers.py",
+    "hutch_python/tests/test_questionnaire.py",
+    "hutch_python/tests/test_tstpython.py",
+    "hutch_python/tests/test_user_load.py",
+    "hutch_python/tests/test_utils.py",
+    "hutch_python/tests/tst/__init__.py",
+    "hutch_python/tests/tst/beamline.py",
+    "hutch_python/tests/tstpython",
+    "hutch_python/user_load.py",
+    "hutch_python/utils.py",
+    "hutch_python/version.py",
+    "pyproject.toml",
+    "requirements.txt"
+  ]
+}

hutch_python-1.24.0/hutch_python.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.24.0",
+  "distance": 0,
+  "node": "g39d8f63469fd9c32ec6aba2e672a41d2061333ff",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-09-22"
+}

{hutch_python-1.23.1 → hutch_python-1.24.0}/requirements.txt

@@ -3,7 +3,7 @@ bluesky>=1.8.0
 coloredlogs>=15.0.0
 cookiecutter>=1.7.0
 happi>=1.9.0
-ipython<9.0.0
+ipython>=9.0.0
 jinja2>=2.11.0
 lightpath>=1.0.1
 matplotlib>=3.4.0

hutch_python-1.23.1/.github/ISSUE_TEMPLATE.md

@@ -1,26 +0,0 @@
-<!--- Provide a general summary of the issue in the Title above -->
-## Expected Behavior
-<!--- If you're describing a bug, tell us what should happen -->
-<!--- If you're suggesting a change/improvement, tell us how it should work -->
-
-## Current Behavior
-<!--- If describing a bug, tell us what happens instead of the expected behavior -->
-<!--- If suggesting a change/improvement, explain the difference from current behavior -->
-
-## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
-
-## Steps to Reproduce (for bugs)
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-1.
-2.
-3.
-
-## Context
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Your Environment
-<!--- Include as many relevant details about the environment you experienced the bug in -->

hutch_python-1.23.1/docs/pre-release-notes.sh

@@ -1,37 +0,0 @@
-#!/bin/bash
-
-ISSUE=$1
-shift
-DESCRIPTION=$*
-
-if [[ -z "$ISSUE" || -z "$DESCRIPTION" ]]; then
-    echo "Usage: $0 (ISSUE NUMBER) (DESCRIPTION)"
-    exit 1
-fi
-
-re_issue_number='^[1-9][0-9]*$'
-
-if ! [[ "$ISSUE" =~ $re_issue_number ]]; then
-    echo "Error: Issue number is not a number: $ISSUE"
-    echo
-    echo "This should preferably be the issue number that this pull request solves."
-    echo "We may also accept the Pull Request number in place of the issue."
-    exit 1
-fi
-
-echo "Issue: $ISSUE"
-echo "Description: $DESCRIPTION"
-
-FILENAME=source/upcoming_release_notes/${ISSUE}-${DESCRIPTION// /_}.rst
-
-pushd "$(dirname "$0")" || exit 1
-
-sed -e "s/IssueNumber Title/${ISSUE} ${DESCRIPTION}/" \
-    "source/upcoming_release_notes/template-short.rst" > "${FILENAME}"
-
-if ${EDITOR} "${FILENAME}"; then
-    echo "Adding ${FILENAME} to the git repository..."
-    git add "${FILENAME}"
-fi
-
-popd || exit 0

hutch_python-1.23.1/docs/release_notes.py

@@ -1,114 +0,0 @@
-import sys
-import time
-from collections import defaultdict
-from pathlib import Path
-
-# find the pre-release directory and release notes file
-THIS_DIR = Path(__file__).resolve().parent
-PRE_RELEASE = THIS_DIR / 'source' / 'upcoming_release_notes'
-TEMPLATE = PRE_RELEASE / 'template-short.rst'
-RELEASE_NOTES = THIS_DIR / 'source' / 'releases.rst'
-
-# Set up underline constants
-TITLE_UNDER = '#'
-RELEASE_UNDER = '='
-SECTION_UNDER = '-'
-
-
-def parse_pre_release_file(path):
-    """
-    Return dict mapping of release notes section to lines.
-
-    Uses empty list when no info was entered for the section.
-    """
-    print(f'Checking {path} for release notes.')
-    with path.open('r') as fd:
-        lines = fd.readlines()
-
-    section_dict = defaultdict(list)
-    prev = None
-    section = None
-
-    for line in lines:
-        if prev is not None:
-            if line.startswith(SECTION_UNDER * 2):
-                section = prev.strip()
-                continue
-            if section is not None and line[0] in ' -':
-                notes = section_dict[section]
-                if len(line) > 6:
-                    notes.append(line)
-                section_dict[section] = notes
-        prev = line
-
-    return section_dict
-
-
-def extend_release_notes(path, version, release_notes):
-    """
-    Given dict mapping of section to lines, extend the release notes file.
-    """
-    with path.open('r') as fd:
-        lines = fd.readlines()
-
-    new_lines = ['\n', '\n']
-    date = time.strftime('%Y-%m-%d')
-    release_title = f'{version} ({date})'
-    new_lines.append(release_title + '\n')
-    new_lines.append(len(release_title) * RELEASE_UNDER + '\n')
-    new_lines.append('\n')
-    for section, section_lines in release_notes.items():
-        if section == 'Contributors':
-            section_lines = sorted(list(set(section_lines)))
-        if len(section_lines) > 0:
-            new_lines.append(section + '\n')
-            new_lines.append(SECTION_UNDER * len(section) + '\n')
-            new_lines.extend(section_lines)
-            new_lines.append('\n')
-
-    output_lines = lines[:2] + new_lines + lines[2:]
-
-    print('Writing out release notes file')
-    for line in new_lines:
-        print(line.strip('\n'))
-    with path.open('w') as fd:
-        fd.writelines(output_lines)
-
-
-def main(version_number: str):
-    section_notes = parse_pre_release_file(TEMPLATE)
-    to_delete = []
-    for path in PRE_RELEASE.iterdir():
-        if path.name[0] in '1234567890':
-            to_delete.append(path)
-            extra_notes = parse_pre_release_file(path)
-            for section, notes in section_notes.items():
-                notes.extend(extra_notes[section])
-                section_notes[section] = notes
-
-    extend_release_notes(RELEASE_NOTES, version_number, section_notes)
-
-    print(
-        "* Wrote release notes.  Please perform the following manually:",
-        file=sys.stderr,
-    )
-    for path in to_delete:
-        print(f" git rm {path}", file=sys.stderr)
-    print(f" git add {RELEASE_NOTES}", file=sys.stderr)
-
-
-if __name__ == '__main__':
-    if len(sys.argv) != 2:
-        print(f"Usage: {sys.argv[0]} VERSION_NUMBER", file=sys.stderr)
-        sys.exit(1)
-
-    version_number = sys.argv[1]
-
-    if not version_number.startswith("v"):
-        print(
-            f"Version number should start with 'v': {version_number}",
-            file=sys.stderr
-        )
-        sys.exit(1)
-
-    main(version_number)