Updated to pants 2.20 and added small migration tool (#97)

Author: sureshjoshi

build-support/pants-plugins/lock.txt

@@ -2,8 +2,9 @@
 
 import logging
 from abc import ABCMeta
+from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import Any, Iterable
+from typing import Any
 
 from pants.core.goals.publish import (
     NoApplicableTargetsBehavior,

build-support/python/default_lock.txt

@@ -6,7 +6,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable
+from collections.abc import Iterable
 
 from experimental.ansible.lint.ansible_lint import rules as ansible_lint_rules
 from experimental.ansible.lint.ansible_lint import skip_field, subsystem

pants-plugins/experimental/ansible/deploy.py

@@ -4,8 +4,8 @@
 from __future__ import annotations
 
 import logging
+from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import Iterable
 
 from experimental.ansible.lint.ansible_lint.subsystem import AnsibleLint
 from experimental.ansible.target_types import AnsibleSourceField

pants-plugins/experimental/ansible/lint/ansible_lint/register.py

@@ -3,8 +3,8 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterable
 from textwrap import dedent
-from typing import Iterable
 
 import pytest
 from experimental.ansible.lint.ansible_lint import rules as ansible_lint_rules

pants-plugins/experimental/ansible/lint/ansible_lint/rules.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable
+from collections.abc import Iterable
 
 from experimental.ansible.target_types import (
     AnsibleSourcesGeneratorTarget,

pants-plugins/experimental/ansible/lint/ansible_lint/rules_integration_test.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import os
-from typing import Iterable
+from collections.abc import Iterable
 
 from pants.backend.python.goals.export import ExportPythonTool, ExportPythonToolSentinel
 from pants.backend.python.subsystems.python_tool_base import PythonToolBase

pants-plugins/experimental/ansible/lint/ansible_lint/skip_field.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Iterable
+from collections.abc import Iterable
 
 from experimental.ansible.deploy import rules as deploy_rules
 from experimental.ansible.goals import tailor

pants-plugins/experimental/ansible/lint/ansible_lint/subsystem.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
 import logging
+from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import Iterable
 
 from experimental.ansible.deploy import DeploymentFieldSet, DeployResult, DeployResults
 from experimental.ansible.subsystems.ansible import Ansible

pants-plugins/experimental/ansible/register.py

@@ -0,0 +1,4 @@
+# Copyright 2023 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+python_sources()

pants-plugins/experimental/ansible/rules.py

@@ -0,0 +1,14 @@
+# Copyright 2024 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+
+from experimental.migrate.rules import rules as migrate_rules
+from pants.engine.rules import Rule
+from pants.engine.unions import UnionRule
+
+
+def rules() -> Iterable[Rule | UnionRule]:
+    return (*migrate_rules(),)

pants-plugins/experimental/migrate/BUILD

@@ -0,0 +1,79 @@
+# Copyright 2024 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from pathlib import Path
+
+import libcst
+import libcst.matchers as m
+from experimental.migrate.subsystems import Migrate, MigrateSubsystem
+from libcst import RemovalSentinel, RemoveFromParent
+from pants.engine.console import Console
+from pants.engine.rules import Rule, collect_rules, goal_rule
+from pants.engine.target import UnexpandedTargets
+
+
+class RemoveRuleTransformer(m.MatcherDecoratableTransformer):
+    @m.leave(
+        m.ImportFrom(
+            module=m.DoNotCare(),
+            names=[
+                m.ZeroOrMore(),
+                m.ImportAlias(name=m.Name("rule_helper")),
+                m.ZeroOrMore(),
+            ],
+        )
+    )
+    def handle_imports(
+        self, original_node: libcst.ImportFrom, updated_node: libcst.ImportFrom
+    ) -> libcst.ImportFrom | RemovalSentinel:
+        assert not isinstance(original_node.names, libcst.ImportStar)
+
+        if len(original_node.names) == 1:
+            return RemoveFromParent()
+
+        return updated_node.with_changes(
+            names=[n for n in original_node.names if n.evaluated_name != "rule_helper"],
+            # This is a workaround for https://github.com/Instagram/LibCST/issues/532
+            # Formatters/isort will clean this up, but it doesn't compile without this
+            lpar=libcst.LeftParen(),
+            rpar=libcst.RightParen(),
+        )
+
+    @m.leave(m.Decorator(decorator=m.Name("rule_helper")))
+    def handle_decorator(
+        self, original_node: libcst.Decorator, updated_node: libcst.Decorator
+    ) -> libcst.Decorator | RemovalSentinel:
+        return RemoveFromParent()
+
+
+# TODO: This will need to become a BuiltinGoal, so just hacking around to get a list of Targets
+# Normally, will use the same code for "call-by-name-migration"
+@goal_rule
+async def migrate(
+    console: Console, subsystem: MigrateSubsystem, targets: UnexpandedTargets
+) -> Migrate:
+    filenames = [t.address.filename for t in targets if t.address.is_file_target]
+
+    for f in sorted(filenames):
+        file = Path(f)
+        if file.suffix != ".py":
+            continue
+        with open(file) as f:
+            source = f.read()
+            tree = libcst.parse_module(source)
+            new_tree = tree.visit(RemoveRuleTransformer())
+            new_source = new_tree.code
+
+            if source != new_source:
+                console.print_stderr(f"Rewriting {file}")
+                with open(file, "w") as f:
+                    f.write(new_source)
+
+    return Migrate(exit_code=0)
+
+
+def rules() -> Iterable[Rule]:
+    return collect_rules()

pants-plugins/experimental/migrate/__init__.py

@@ -0,0 +1,26 @@
+# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+
+from pants.engine.goal import Goal, GoalSubsystem
+from pants.engine.rules import Rule, collect_rules
+
+
+class MigrateSubsystem(GoalSubsystem):
+    name = "migrate"
+    help = "???"
+
+
+class Migrate(Goal):
+    subsystem_cls = MigrateSubsystem
+    environment_behavior = Goal.EnvironmentBehavior.LOCAL_ONLY
+
+
+def rules() -> Iterable[Rule]:
+    return (
+        *collect_rules(),
+        *MigrateSubsystem.rules(),  # type: ignore[call-arg]
+    )

pants-plugins/experimental/migrate/register.py

@@ -8,7 +8,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable
+from collections.abc import Iterable
 
 from experimental.scie.rules import rules as scie_rules
 from experimental.scie.target_types import ScieTarget

pants-plugins/experimental/migrate/rules.py

@@ -5,9 +5,10 @@
 
 import logging
 import os
-from dataclasses import asdict, dataclass, replace
+from collections.abc import Iterable, Mapping
+from dataclasses import asdict, dataclass
 from pathlib import PurePath
-from typing import Final, Iterable, Mapping
+from typing import Final
 
 import toml
 from experimental.scie.config import Command, Config, File, Interpreter, LiftConfig
@@ -39,7 +40,7 @@
 )
 from pants.engine.platform import Platform
 from pants.engine.process import Process, ProcessResult
-from pants.engine.rules import Get, MultiGet, Rule, collect_rules, rule, rule_helper
+from pants.engine.rules import Get, MultiGet, Rule, collect_rules, rule
 from pants.engine.target import (
     DependenciesRequest,
     DescriptionField,
@@ -70,7 +71,6 @@ class ScieFieldSet(PackageFieldSet, RunFieldSet):
     lift: ScieLiftSourceField
 
 
-@rule_helper
 async def _get_interpreter_config(targets: Targets) -> Interpreter:
     # Get the interpreter_constraints for the Pex to determine which version of the Python Standalone to use
     constraints = await Get(
@@ -112,7 +112,6 @@ def _contains_pex(built_package: BuiltPackage) -> bool:
     )
 
 
-@rule_helper
 async def _parse_lift_source(source: ScieLiftSourceField) -> Config:
     hydrated_source = await Get(HydratedSources, HydrateSourcesRequest(source))
     digest_contents = await Get(DigestContents, Digest, hydrated_source.snapshot.digest)

pants-plugins/experimental/migrate/subsystems.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable
+from collections.abc import Iterable
 
 from pants.core.util_rules.external_tool import TemplatedExternalTool
 from pants.engine.rules import Rule, collect_rules

pants-plugins/experimental/scie/register.py

@@ -9,8 +9,6 @@
 from pants.engine.target import (
     COMMON_TARGET_FIELDS,
     Dependencies,
-    DictStringToStringField,
-    NestedDictStringToStringField,
     OptionalSingleSourceField,
     StringSequenceField,
     Target,

pants-plugins/experimental/scie/rules.py

@@ -4,8 +4,8 @@
 from __future__ import annotations
 
 import logging
+from collections.abc import Iterable
 from itertools import groupby
-from typing import Iterable
 
 from experimental.swift.subsystems.toolchain import SwiftSubsystem
 from experimental.swift.target_types import SwiftFieldSet, SwiftSourceField

pants-plugins/experimental/scie/subsystems.py

@@ -3,8 +3,8 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterable
 from textwrap import dedent
-from typing import Iterable
 
 import pytest
 from experimental.swift.goals import check

pants-plugins/experimental/scie/target_types.py

@@ -3,8 +3,8 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import Iterable
 
 from experimental.swift.target_types import (
     SWIFT_FILE_EXTENSIONS,

pants-plugins/experimental/swift/goals/check.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable
+from collections.abc import Iterable
 
 from experimental.swift.goals import check, tailor
 from experimental.swift.subsystems import toolchain

pants-plugins/experimental/swift/goals/check_test.py

@@ -4,8 +4,8 @@
 from __future__ import annotations
 
 import os
+from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import Iterable
 
 from pants.core.util_rules.system_binaries import (
     BinaryNotFoundError,

pants-plugins/experimental/swift/goals/tailor.py

@@ -3,8 +3,8 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import Iterable
 
 from experimental.swift.subsystems.toolchain import SwiftToolchain
 from experimental.swift.target_types import SwiftFieldSet, SwiftSourceField

pants-plugins/experimental/swift/register.py

@@ -1,9 +1,10 @@
 [GLOBAL]
-pants_version = "2.16.0rc3"
+pants_version = "2.20.1"
 pantsd = true 
 build_patterns = ["BUILD.pants", "BUILD"]
 pythonpath = ["pants-plugins"]
 print_stacktrace = true
+plugins=["libcst==1.3.1"]
 
 backend_packages = [
     "pants.backend.plugin_development",
@@ -23,6 +24,7 @@ backend_packages = [
     "pants.backend.shell",
     "pants.backend.shell.lint.shellcheck",
     "pants.backend.shell.lint.shfmt",
+    "experimental.migrate",
     "experimental.scie",
     # "experimental.mypyc",
     #"experimental.ansible",
@@ -65,9 +67,9 @@ args = "--profile black"
 [pyupgrade]
 args = "--py39-plus"
 
-[setuptools]
-extra_requirements = ["wheel", "mypy"]
-lockfile = "build-support/setuptools.txt"
+#[setuptools]
+#extra_requirements = ["wheel", "mypy"]
+#lockfile = "build-support/setuptools.txt"
 
 [shfmt]
 # See https://github.com/mvdan/sh/blob/master/cmd/shfmt/shfmt.1.scd#printer-flags.