Referencing metadata in a pants test (pytest)

[kdowney-talos]

Running this code in a unit test with load_metadata("serenity-base"):

import importlib.metadata as meta


def load_metadata(package_name: str):
    return meta.metadata(package_name)

fails with:

E           importlib.metadata.PackageNotFoundError: No package metadata was found for serenity-base

but only when I run via pants test; it passes when I just run pytest standalone. I believe this is because pytest is picking up the egg-info directory in the main source folder, which has the relevant metadata from the pyproject.toml: in this case, that the package name is serenity-base for distribution purposes.

Is there any way to get pants test to do the same?

[cognifloyd]

Try adding entry_point_dependencies to your python_test or python_tests target.
https://www.pantsbuild.org/stable/reference/targets/python_test#entry_point_dependencies

[kdowney-talos]

Thanks. I tried that, to no avail. In the project I have this in the top-level BUILD:

python_requirements(name="deps", source="pyproject.toml", resolve="serenity_base-deps")

resource(name="pyproject", source="pyproject.toml")
resource(name="version", source="VERSION.txt")

python_distribution(
    name="dist",
    dependencies=["//serenity.base/src/python:lib", ":pyproject", ":version"],
    provides=python_artifact(name="serenity-base"),
    generate_setup=False,
)

and then in tests:

resources(name="testfixtures", sources=["**/*.cfg"])

python_tests(
    name="unit",
    sources=["**/test_*.py"],
    dependencies=[":testfixtures"],
    resolve="serenity_base-deps",
    entry_point_dependencies={"//serenity.base:dist": ["*"]},
)

Given this is a library, there is no entry point, so I am not sure this will work. Regardless, I get the same error:

        except StopIteration:
>           raise PackageNotFoundError(name)
E           importlib.metadata.PackageNotFoundError: No package metadata was found for serenity-base

/usr/lib/python3.12/importlib/metadata/__init__.py:399: PackageNotFoundError
- generated xml file: serenity.base.tests.serenity_base.utils.test_metadata.py@@unit.xml -