TSP environment cleanup (#328)

* fix: perform garbage collection of TSP environment on cleanup. * Update CHANGELOG.md Co-authored-by: Nicholas Felt <nicholas.felt@tektronix.com> Signed-off-by: Luke <111022789+ldantek@users.noreply.github.com> --------- Signed-off-by: Luke <111022789+ldantek@users.noreply.github.com> Co-authored-by: Nicholas Felt <nicholas.felt@tektronix.com>
tektronix · Oct 22, 2024 · a1477c3 · a1477c3
1 parent fb29ac3
commit a1477c3
Show file tree

Hide file tree

Showing 37 changed files with 49 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,10 @@ Valid subsections within a version are:
 
 Things to be included in the next release go here.
 
+### Added
+
+- `collectgarbage()` is now called during cleanup of `TSPDevice` children.
+
 ---
 
 ### Added

diff --git a/src/tm_devices/drivers/pi/source_measure_units/smu24xx/smu24xx_standard.py b/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
diff --git a/src/tm_devices/drivers/pi/tsp_device.py b/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()")
diff --git a/tests/sim_devices/daq/daq6510.yaml b/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)

diff --git a/tests/sim_devices/dmm/dmm6500.yaml b/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)

diff --git a/tests/sim_devices/dmm/dmm7510.yaml b/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)

diff --git a/tests/sim_devices/dmm/dmm7512.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2450.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2460.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2461.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2470.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2601a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2601b.yaml b/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

diff --git a/tests/sim_devices/smu/smu2601b_pulse.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2602a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2602b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2604a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2604b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2606b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2611a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2611b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2612a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2612b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2614a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2614b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2634a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2634b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2635a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2635b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2636a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2636b.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2651a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu2657a.yaml b/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)

diff --git a/tests/sim_devices/smu/smu6430.yaml b/tests/sim_devices/smu/smu6430.yaml
@@ -19,6 +19,7 @@ devices:
         r: '1'
       - q: '*RST'
       - q: '*CLS'
+      - q: collectgarbage()
     error:
       status_register:
         - q: '*ESR?'

diff --git a/tests/sim_devices/smu/smu6514.yaml b/tests/sim_devices/smu/smu6514.yaml
@@ -19,6 +19,7 @@ devices:
         r: '1'
       - q: '*RST'
       - q: '*CLS'
+      - q: collectgarbage()
     error:
       status_register:
         - q: '*ESR?'

diff --git a/tests/sim_devices/smu/smu6517b.yaml b/tests/sim_devices/smu/smu6517b.yaml
@@ -19,6 +19,7 @@ devices:
         r: '1'
       - q: '*RST'
       - q: '*CLS'
+      - q: collectgarbage()
     error:
       status_register:
         - q: '*ESR?'

diff --git a/tests/sim_devices/ss/ss3706a.yaml b/tests/sim_devices/ss/ss3706a.yaml
@@ -32,6 +32,7 @@ devices:
       - q: print([[0]])
         r: 0
       - q: waitcomplete()
+      - q: collectgarbage()
     error:
       status_register:
         - q: print(status.standard.event)