Is there a straightforward way to package and append a dev release specifier to the version of a package? I want to package a

python_distribution

and modify its

provides.python_artifact.version

to include a dev release:

wheel-1.2.3.whl

->

wheel-1.2.3.dev1.whl

but can’t see a way to do this with

__defaults__

and

vcs_version

plugin isn’t exactly what I want.

Depending on the complexity: https://www.pantsbuild.org/2.21/docs/writing-plugins/common-plugin-tasks/custom-python-artifact-kwargs

There's also

env()

and

.pants.bootstrap

to manage it: https://www.pantsbuild.org/2.21/docs/using-pants/key-concepts/targets-and-build-files#environment-variables https://www.pantsbuild.org/2.21/docs/using-pants/key-concepts/options#pantsbootstrap-file

That looks like what I need. Is there a way I could make sure .pants.bootstrap is only applied conditionally? In the same way that I’ve done with my CI pants config file:

PANTS_CONFIG_FILES=pants.ci.toml

Maybe there is a CI variable or something to put it behind. It’s a shell script so regular if-expressions etc are available.

I can see ‘dev.pants.bootstrap’ and ‘ci.pants.bootstrap’ variations being useful the same way ‘dev.env’ and ‘prod.env’ are a common pattern

You can pull those in as needed from your .pants.bootstrap, but only you know what to look for to identify a CI run..

This is what I have currently in

macros.py

, I’m decided to pass through the version from provides instead but I’m getting an error when trying to unpack and pass provides as kwargs using your example:

# macros.py
def python_distribution2(provides=None, **kwargs):
    python_distribution(
        provides=python_artifact(
            name=build_file_dir().name,
            version=dev_version(provides.kwargs["version"]),
            **(provides or {}),
        ),
        **kwargs,
    )

MappingError: Failed to parse ./oxlibs/oxlibs/BUILD:
TypeError: pants.backend.python.macros.python_artifact.PythonArtifact() argument after ** must be a mapping, not PythonArtifact

Using

provides.kwargs

instead duplicates the name/version fields, is there a way to only provide the kwargs that aren’t overwritten?

I think it is better to stick with using

python_distribution_custom

rather than replacing the original target with the custom one, as that could be surprising to folks looking up docs etc for the target if not realizing it has been customized.

Hey @curved-television-6568 I could do with some assistance on this, I have the below macro set up that enables adding a version suffix with an env var. The problem I’m having is that this also applies to all other python_distribution targets that are built at that time such as dependencies of the python_distribution(s) that I’m specifying to be built.

def python_distribution_custom(provides=None, **kwargs):
    python_distribution(
        provides=python_artifact(
            **dict(provides.kwargs,
                name=build_file_dir().name,
                version=modify_version(provides.kwargs["version"])
            ) or {},
        ),
        **kwargs,
    )

Is there a nice way for me to only apply this modification on the targets that are being passed to

pants package <targets>

and not the first-party dependents of those targets?

Ah.. that's tricky to do from BUILD files alone. Maybe if you have dedicated env vars per target, if feasible?

AFAIU it’s not actually building the first-party dependency, but “building” the target to resolve all dependency requirements of the package <target>. Could this work internally if targets had context for why they were being initialised? Packaged for distribution vs. target compilation(?) for resolves? Alternatively, is there a more complex route I could go with this macro that would allow for processing the targets being explicitly passed properly? A plugin or something?

Well yes, a plugin would be able to know what targets are being requested and what the current goal is.

Is there a close example you know of that you could share as a jumping off point?