pantsbuild / pants / 19015773527

import logging

from typing import cast

from pants.engine.addresses import Address, Addresses

from pants.engine.console import Console

from pants.engine.goal import Goal, GoalSubsystem, LineOriented

from pants.engine.internals.graph import resolve_unexpanded_targets

from pants.engine.rules import collect_rules, goal_rule

from pants.engine.target import DescriptionField

from pants.option.option_types import BoolOption

logger = logging.getLogger(__name__)

class ListSubsystem(LineOriented, GoalSubsystem):

    name = "list"

    help = "Lists all targets matching the file or target arguments."

    documented = BoolOption(

class List(Goal):

    subsystem_cls = ListSubsystem

    environment_behavior = Goal.EnvironmentBehavior.LOCAL_ONLY

@goal_rule

async def list_targets(

    if not addresses:

        logger.warning(f"No targets were matched in goal `{list_subsystem.name}`.")

        return List(exit_code=0)

    if list_subsystem.documented:

        targets = await resolve_unexpanded_targets(addresses)

        addresses_with_descriptions = cast(

        with list_subsystem.line_oriented(console) as print_stdout:

            for address, description in addresses_with_descriptions.items():

                formatted_description = "\n  ".join(description.strip().split("\n"))

                print_stdout(f"{address.spec}\n  {formatted_description}")

        return List(exit_code=0)

    with list_subsystem.line_oriented(console) as print_stdout:

        for address in sorted(addresses):

            print_stdout(address.spec)

    return List(exit_code=0)

def rules():

    return collect_rules()