Manual cleanup of workspace during garbage collection

[erick-xanadu]

Context: There is a ResourceWarning message with contents similar to the following:

Implicitly cleaning up <TemporaryDirectory '/private/var/folders/91/0sd1rhg56rs8y299zcsyg1hh0000zc/T/f1h7aj47n_'>

This is expected from the TemporaryDirectory, which implicitly cleans up after itself.

It will be destroyed as soon as it is closed (including an implicit close when the object is garbage collected)

When this warning is paired with tests that will treat all warnings as errors, such as when using the decorator:

    @pytest.mark.filterwarnings("error")

All warnings will instead raise an exception:

One can also cause all warnings to be exceptions by using error instead of always.

Which will then make pytest raise another warning

frontend/test/pytest/test_autograph.py::TestForLoops::test_ignore_warnings - pytest.PytestUnraisableExceptionWarning:

which since it is treated as an error, may make a test fail.

Description of the Change: In order to avoid this warning, explicitly clean up. This will remove the initial warning that triggers these events.

Benefits: Avoid a warning / tests to fail.

Drawbacks: It is a bit redundant to cleanup explicitly during garbage collection of the parent object.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.41%. Comparing base (2b1fde5) to head (0717750).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #656   +/-   ##
=======================================
  Coverage   99.41%   99.41%           
=======================================
  Files          55       55           
  Lines        9121     9124    +3     
  Branches      701      702    +1     
=======================================
+ Hits         9068     9071    +3     
  Misses         28       28           
  Partials       25       25           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[erick-xanadu]

I'm not sure when -p no:warnings was added to the frontend tests, but one can see in the kokkos that that warning is no longer. https://github.com/PennyLaneAI/catalyst/actions/runs/8631468232/job/23660666861?pr=656

One can compare it with the main branch, which does have that warning: https://github.com/PennyLaneAI/catalyst/actions/runs/8619522185/job/23624994862

[dime10]

Thank you for figuring this out 💯