Plugins - what to use in tox 4 instead of tox_cleanup hook?

[f3flight]

tox_cleanup is gone and I don't see an appropriate alternative. I need a hook which runs after all environments were run (i.e. right before tox shutdown).

More specifically, here's some of the code I used in tox_cleanup:

    sdist = tarfile.open(session.package)
    pkg_info = sdist.getmember([name for name in sdist.getnames() if Path(name).name == 'PKG-INFO'][0])
    pkg_info_content = sdist.extractfile(pkg_info).readlines()
    package_name = [line.split(b' ')[1] for line in pkg_info_content if line.startswith(b'Name:')][0].strip().decode()
    package_version = [line.split(b' ')[1] for line in pkg_info_content if line.startswith(b'Version:')][0].strip().decode()

Basically I need to figure out the main package true name and version, and then I do some stuff with this after this code, and this runs once per run at the very end. Can I do the same in tox 4?

[gaborbernat]

Can you please clarify what exactly you need to do? Beyond just something.

[gaborbernat]

For the packaging environment, you likely want to subclass the current existing packaging environment and add into the tear down method your custom logic. In the configuration setup hook, you can set your custom packaging class at the tox packaging environment.

[f3flight]

Hm good question. My CI custom run env dumps dependency tree (using pipdeptree) into a file and then I collect and process this data via a tox plugin which runs on cleanup. So I need some env where the package is installed and where I can have pipdeptree also installed, to dump dependency tree and export it to our ci/cd.vRight now I have a separate section in tox.ini with an env which installs and runs pipdeptree, and then the plugin collects that (as I could not figure out how to inject a run env programmatically in tox v3, so I did it via tox.ini).

• Does packaging environment install the package?
• can I instruct packaging environment to install an extra package inside itself (pipdeptree) so I could run it on teardown?

[gaborbernat]

Sounds like a separate running environment for me that depends on all other running environments. See the depends keyword in configuration. This environment would have pipdeptree installed. That tool can dump the dependency tree for other python environments, not just the one it is installed into, check the --python arg.

[f3flight]

Thanks @gaborbernat. I managed to achieve the desired result by using tox_env_teardown hook by checking for tox_env.name inside (to only run when env is called "ci") and accessing tox_env._packages[0].path to get to the sdist. Didn't need the depends option as this "ci" env doesn't really depend on others but good to know it exists, I may use it for other needs in future.