Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore several removed targets and fields to help with upgrading #10970

Merged
merged 2 commits into from
Oct 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion src/python/pants/backend/python/target_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,16 @@ def calculate_from_global_options(self, pytest: PyTest) -> Optional[int]:
return result


class DeprecatedCoverageField(StringOrStringSequenceField):
alias = "coverage"
deprecated_removal_version = "2.1.0.dev0"
deprecated_removal_hint = (
"The `coverage` field no longer does anything, as Pants now gets coverage data for all "
"files encountered. Use the option `--coverage-py-filter` if you want more precise "
"results. See https://www.pantsbuild.org/docs/python-test-goal#coverage."
)


class PythonTests(Target):
"""Python tests.

Expand All @@ -386,6 +396,7 @@ class PythonTests(Target):
PythonRuntimePackageDependencies,
PythonRuntimeBinaryDependencies,
PythonTestsTimeout,
DeprecatedCoverageField,
)


Expand All @@ -398,11 +409,35 @@ class PythonLibrarySources(PythonSources):
default = ("*.py", "*.pyi") + tuple(f"!{pat}" for pat in PythonTestsSources.default)


class DeprecatedProvidesField(ScalarField, ProvidesField):
expected_type = PythonArtifact
expected_type_description = "setup_py(name='my-dist', **kwargs)"
value: PythonArtifact
deprecated_removal_version = "2.1.0.dev0"
deprecated_removal_hint = (
"Rather than using the `provides` field on a `python_library` target, create a dedicated "
"`python_distribution` target. See "
"https://www.pantsbuild.org/docs/how-to-upgrade-pants-2-0#use--python_distribution-"
"target-type-for-providessetup_py-130-vs-20 for instructions."
)

@classmethod
def compute_value(
cls, raw_value: Optional[PythonArtifact], *, address: Address
) -> PythonArtifact:
return cast(PythonArtifact, super().compute_value(raw_value, address=address))


class PythonLibrary(Target):
"""A Python library that may be imported by other targets."""

alias = "python_library"
core_fields = (*COMMON_PYTHON_FIELDS, Dependencies, PythonLibrarySources)
core_fields = (
*COMMON_PYTHON_FIELDS,
Dependencies,
PythonLibrarySources,
DeprecatedProvidesField,
)


# -----------------------------------------------------------------------------------------------
Expand Down
196 changes: 196 additions & 0 deletions src/python/pants/core/deprecated_v1_target_types.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
# Copyright 2020 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from typing import Iterable, Optional

from pants.backend.python.target_types import COMMON_PYTHON_FIELDS, PythonInterpreterCompatibility
from pants.engine.addresses import Address
from pants.engine.target import (
COMMON_TARGET_FIELDS,
BoolField,
Dependencies,
InvalidFieldException,
SequenceField,
Sources,
StringField,
StringSequenceField,
Target,
)

# -----------------------------------------------------------------------------------------------
# `alias` target
# -----------------------------------------------------------------------------------------------


class AliasTargetRequestedAddress(StringField):
alias = "target"


class AliasTarget(Target):
alias = "alias"
core_fields = (*COMMON_TARGET_FIELDS, Dependencies, AliasTargetRequestedAddress)
deprecated_removal_version = "2.1.0.dev0"
deprecated_removal_hint = (
"The `alias` target was removed. If you found this feature useful, we'd be happy to add it"
"back in a more powerful way. Please message us on Slack or open a GitHub issue "
"(https://www.pantsbuild.org/docs/community)."
)


# -----------------------------------------------------------------------------------------------
# `prep_command` target
# -----------------------------------------------------------------------------------------------


class PrepCommandExecutable(StringField):
alias = "prep_executable"
required = True


class PrepCommandArgs(StringSequenceField):
alias = "prep_args"


class PrepCommandEnviron(BoolField):
alias = "prep_environ"
default = False


class PrepCommandGoals(StringSequenceField):
alias = "goals"
default = ("test",)


class PrepCommand(Target):
alias = "prep_command"
core_fields = (
*COMMON_TARGET_FIELDS,
PrepCommandExecutable,
PrepCommandArgs,
PrepCommandEnviron,
PrepCommandGoals,
)
deprecated_removal_version = "2.1.0.dev0"
deprecated_removal_hint = (
"The `prep_command` target was removed, as it does not fit well with the v2 engine's "
"execution model. If you needed this functionality, please message us on Slack "
"(https://www.pantsbuild.org/docs/community) and we will help to recreate your setup."
)


# -----------------------------------------------------------------------------------------------
# `python_app` target
# -----------------------------------------------------------------------------------------------


class PythonAppBinaryField(StringField):
alias = "binary"


class PythonAppBasename(StringField):
alias = "basename"


class PythonAppArchiveFormat(StringField):
alias = "archive"


class Bundle:
def __init__(self, parse_context):
self._parse_context = parse_context

def __call__(self, rel_path=None, mapper=None, relative_to=None, fileset=None):
pass


class BundlesField(SequenceField):
alias = "bundles"
expected_element_type = Bundle
expected_type_description = "an iterable of `bundle` objects"

@classmethod
def compute_value(cls, raw_value: Optional[Iterable[Bundle]], *, address: Address) -> None:
try:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use contextlib.suppress

Copy link
Contributor Author

@Eric-Arellano Eric-Arellano Oct 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, good point. This code is only being added to 2.0.0, though, in a hackily named deprecated_v1_target_types.py file, so I'm not gonna worry about it.

Good to know for the future, though.

super().compute_value(raw_value, address=address)
except InvalidFieldException:
pass
return None


class PythonApp(Target):
alias = "python_app"
core_fields = (
*COMMON_TARGET_FIELDS,
Dependencies,
BundlesField,
PythonAppBinaryField,
PythonAppBasename,
PythonAppArchiveFormat,
)
deprecated_removal_version = "2.1.0.dev0"
deprecated_removal_hint = (
"Instead of `python_app`, use the simpler `archive` target. If you still need to relocate "
"files, use the new `relocated_files` target. See "
"https://www.pantsbuild.org/docs/resources."
)


# -----------------------------------------------------------------------------------------------
# `unpacked_wheels` target
# -----------------------------------------------------------------------------------------------


class UnpackedWheelsModuleName(StringField):
alias = "module_name"
required = True


class UnpackedWheelsRequestedLibraries(StringSequenceField):
alias = "libraries"
required = True


class UnpackedWheelsIncludePatterns(StringSequenceField):
alias = "include_patterns"


class UnpackedWheelsExcludePatterns(StringSequenceField):
alias = "exclude_patterns"


class UnpackedWheelsWithinDataSubdir(BoolField):
alias = "within_data_subdir"
default = False


class UnpackedWheels(Target):
alias = "unpacked_whls"
core_fields = (
*COMMON_TARGET_FIELDS,
PythonInterpreterCompatibility,
UnpackedWheelsModuleName,
UnpackedWheelsRequestedLibraries,
UnpackedWheelsIncludePatterns,
UnpackedWheelsExcludePatterns,
UnpackedWheelsWithinDataSubdir,
)
deprecated_removal_version = "2.1.0.dev0"
deprecated_removal_hint = (
"The `unpacked_wheels` target type was removed. Please reach out if you'd still like this "
"functionality (https://www.pantsbuild.org/docs/community)."
)


# -----------------------------------------------------------------------------------------------
# `python_grpcio_library` target
# -----------------------------------------------------------------------------------------------


class PythonGrpcioLibrary(Target):
alias = "python_grpcio_library"
core_fields = (*COMMON_PYTHON_FIELDS, Dependencies, Sources)
deprecated_removal_version = "2.1.0.dev0"
deprecated_removal_hint = (
"Instead of `python_grpcio_library`, use `protobuf_library(grpc=True)`. See "
"https://www.pantsbuild.org/docs/protobuf."
)
27 changes: 26 additions & 1 deletion src/python/pants/core/register.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@
These are always activated and cannot be disabled.
"""

from pants.build_graph.build_file_aliases import BuildFileAliases
from pants.core.deprecated_v1_target_types import (
AliasTarget,
Bundle,
PrepCommand,
PythonApp,
PythonGrpcioLibrary,
UnpackedWheels,
)
from pants.core.goals import binary, fmt, lint, package, repl, run, test, typecheck
from pants.core.target_types import ArchiveTarget, Files, GenericTarget, RelocatedFiles, Resources
from pants.core.target_types import rules as target_type_rules
Expand All @@ -23,6 +32,10 @@
from pants.source import source_root


def build_file_aliases():
return BuildFileAliases(context_aware_object_factories={"bundle": Bundle})


def rules():
return [
# goals
Expand Down Expand Up @@ -50,4 +63,16 @@ def rules():


def target_types():
return [ArchiveTarget, Files, GenericTarget, Resources, RelocatedFiles]
return [
ArchiveTarget,
Files,
GenericTarget,
Resources,
RelocatedFiles,
# Deprecated targets.
AliasTarget,
PrepCommand,
PythonApp,
UnpackedWheels,
PythonGrpcioLibrary,
]