Merge branch 'main' into main

Signed-off-by: Joe <[email protected]>

.github/workflows/check-api-for-breaking-changes.yml

@@ -5,6 +5,6 @@ on:
     branches: [main]
 jobs:
   check-api-for-breaking-changes:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-check-api-for-breaking-changes.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-check-api-for-breaking-changes.yml@v1.5.0
     with:
       package-name: tm_devices

.github/workflows/codeql-analysis.yml

@@ -9,7 +9,7 @@ on:
     - cron: 17 16 * * 4
 jobs:
   analyze:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-codeql-analysis.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-codeql-analysis.yml@v1.5.0
     with:
       languages-array: '["python", "javascript"]'
       codeql-queries: security-extended,security-and-quality

.github/workflows/enforce-community-standards.yml

@@ -7,4 +7,4 @@ on:
     branches: [main]
 jobs:
   enforce-community-standards:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-enforce-community-standards.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-enforce-community-standards.yml@v1.5.0

.github/workflows/package-build.yml

@@ -12,7 +12,7 @@ concurrency:
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 jobs:
   package-build:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-build.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-build.yml@v1.5.0
     with:
       package-name: tm_devices
       python-versions-array: '["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]'  # when updating this, make sure to update all workflows that use this strategy

.github/workflows/package-release.yml

@@ -16,7 +16,7 @@ concurrency:
   group: pypi
 jobs:
   package-release:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-release.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-release.yml@v1.5.0
     with:
       package-name: tm_devices
       repo-name: tektronix/tm_devices

.github/workflows/package-testpypi.yml

@@ -7,7 +7,7 @@ concurrency:
   group: pypi
 jobs:
   package-testpypi:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-testpypi.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-package-testpypi.yml@v1.5.0
     with:
       package-name: tm_devices
       repo-name: tektronix/tm_devices

.github/workflows/publish-api-comparison.yml

@@ -6,7 +6,7 @@ on:
     types: [completed]
 jobs:
   publish-api-comparison:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-api-comparison.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-api-comparison.yml@v1.5.0
     permissions:
       checks: write
       pull-requests: write

.github/workflows/publish-test-results.yml

@@ -6,7 +6,7 @@ on:
     types: [completed]
 jobs:
   publish-test-results:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-test-results.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-publish-test-results.yml@v1.5.0
     with:
       operating-systems-array: '["ubuntu", "windows", "macos"]'
     permissions:

.github/workflows/sbom-scan.yml

@@ -9,7 +9,7 @@ on:
     types: [published]
 jobs:
   sbom-scan:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-sbom-scan.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-sbom-scan.yml@v1.5.0
     permissions:
       security-events: write
       contents: write

.github/workflows/test-code.yml

@@ -10,7 +10,7 @@ concurrency:
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 jobs:
   test-code:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-code.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-code.yml@v1.5.0
     with:
       repo-name: tektronix/tm_devices
       operating-systems-array: '["ubuntu", "windows", "macos"]'

.github/workflows/test-docs.yml

@@ -10,7 +10,7 @@ concurrency:
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 jobs:
   test-docs:
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-docs.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-test-docs.yml@v1.5.0
     with:
       node-version: 20  # The node version needs to stay in sync with .readthedocs.yml
       python-version: '3.11'  # This needs to stay in sync with .readthedocs.yml and the tox config in pyproject.toml

.github/workflows/update-python-and-pre-commit-dependencies.yml

@@ -6,14 +6,15 @@ on:
 jobs:
   update-python-and-pre-commit-dependencies:
     if: ${{ github.actor == 'dependabot[bot]' && contains(github.head_ref, '/pip/') }}
-    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml@v1.4.1
+    uses: tektronix/python-package-ci-cd/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml@v1.5.0
     with:
       commit-user-name: ${{ vars.TEK_OPENSOURCE_NAME }}
       commit-user-email: ${{ vars.TEK_OPENSOURCE_EMAIL }}
       dependency-dict: '{"tests": ["ruff"]}'
       update-pre-commit: true
       run-pre-commit: true
       pre-commit-hook-skip-list: pylint,pyright,pyright-verifytypes,pyroma,poetry-audit
+      pre-commit-repo-update-skip-list: https://github.com/executablebooks/mdformat
       export-dependency-groups: docs,tests
     permissions:
       contents: write

CHANGELOG.md

@@ -22,12 +22,13 @@ Things to be included in the next release go here.
 
 - fix: TekScope2K active channel query needs VERBOSE and HEADER options enabled to function properly
 
----
-
 ### Added
 
+- `collectgarbage()` is now called during cleanup of `TSPDevice` children.
 - Added USB Support for AFG31K and MDO3 models.
 
+---
+
 ## v2.4.0 (2024-09-19)
 
 ### Merged Pull Requests

src/tm_devices/drivers/pi/source_measure_units/smu24xx/smu24xx_standard.py

@@ -136,3 +136,7 @@ def load_script(
     ################################################################################################
     # Private Methods
     ################################################################################################
+
+    def _cleanup(self) -> None:
+        """Perform the cleanup defined for the device."""
+        PIDevice._cleanup(self)  # noqa: SLF001

src/tm_devices/drivers/pi/tsp_device.py

@@ -277,7 +277,10 @@ def write_buffers(self, filepath: str, *args: str, sep: str = ",") -> None:
         )
         self.export_buffers(filepath, *args, sep=sep)
 
-
-################################################################################################
-# Private Methods
-################################################################################################
+    ################################################################################################
+    # Private Methods
+    ################################################################################################
+    def _cleanup(self) -> None:
+        """Perform the cleanup defined for the device."""
+        super()._cleanup()
+        self.write("collectgarbage()")

tests/sim_devices/daq/daq6510.yaml

@@ -12,6 +12,7 @@ devices:
       - q: eventlog.clear()
       - q: status.clear()
       - q: reset()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/dmm/dmm6500.yaml

@@ -12,6 +12,7 @@ devices:
       - q: eventlog.clear()
       - q: status.clear()
       - q: reset()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/dmm/dmm7510.yaml

@@ -12,6 +12,7 @@ devices:
       - q: eventlog.clear()
       - q: status.clear()
       - q: reset()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/dmm/dmm7512.yaml

@@ -12,6 +12,7 @@ devices:
       - q: eventlog.clear()
       - q: status.clear()
       - q: reset()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2450.yaml

@@ -12,6 +12,7 @@ devices:
       - q: eventlog.clear()
       - q: status.clear()
       - q: reset()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2460.yaml

@@ -13,6 +13,7 @@ devices:
       - q: status.clear()
       - q: reset()
       - q: smu.source.sweeplinear("SolarCell", 0, 0.53, 56, 0.1)
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2461.yaml

@@ -12,6 +12,7 @@ devices:
       - q: eventlog.clear()
       - q: status.clear()
       - q: reset()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2470.yaml

@@ -12,6 +12,7 @@ devices:
       - q: eventlog.clear()
       - q: status.clear()
       - q: reset()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2601a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2601b.yaml

@@ -29,6 +29,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
       - q: status.node_enable = 1
       - q: print(status.node_enable)
         r: 1

tests/sim_devices/smu/smu2601b_pulse.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2602a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2602b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2604a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2604b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2606b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2611a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2611b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2612a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2612b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2614a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2614b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2634a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2634b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2635a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2635b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2636a.yaml

@@ -22,6 +22,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2636b.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2651a.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu2657a.yaml

@@ -31,6 +31,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)

tests/sim_devices/smu/smu6430.yaml

@@ -19,6 +19,7 @@ devices:
         r: '1'
       - q: '*RST'
       - q: '*CLS'
+      - q: collectgarbage()
     error:
       status_register:
         - q: '*ESR?'