Correctly describe the origin of invalid specs, e.g. --paths-from (#…

…15730)

Before:

```
❯ ./pants paths --from=fake/f.py --to=src/python/pants/util/strutil.py
12:54:23.99 [ERROR] 1 Exception encountered:

  Exception: Unmatched glob from CLI arguments
```

After:

```
❯ ./pants paths --from=fake/f.py --to=src/python/pants/util/strutil.py
12:54:23.99 [ERROR] 1 Exception encountered:

  Exception: Unmatched glob from the option `--paths-from`: "fake/f.py"
```

It was a lie to hardcode "CLI arguments". 

Most of these rules should never error because we only error if the directory of the CLI specs do not exist, and we programmatically compute the specs based on already existing targets. But still, this gives us much better debugging if those assumptions are violated.

This also unblocks us from #14468. The `Specs` will be able to pass down their `description_of_origin` to `AddressInput` for much better errors with invalid `AddressLiteralSpec`s.

[ci skip-build-wheels]

src/python/pants/backend/go/goals/tailor.py

@@ -95,7 +95,10 @@ async def find_putative_go_targets(
         ]
         existing_targets = await Get(
             UnexpandedTargets,
-            RawSpecs(ancestor_globs=tuple(AncestorGlobSpec(d) for d in main_package_dirs)),
+            RawSpecs(
+                ancestor_globs=tuple(AncestorGlobSpec(d) for d in main_package_dirs),
+                description_of_origin="the `go_binary` tailor rule",
+            ),
         )
         owned_main_packages = await MultiGet(
             Get(GoBinaryMainPackage, GoBinaryMainPackageRequest(t[GoBinaryMainPackageField]))

src/python/pants/backend/go/target_type_rules.py

@@ -277,7 +277,13 @@ async def determine_main_pkg_for_go_binary(
             )
         return GoBinaryMainPackage(wrapped_specified_tgt.target.address)
 
-    candidate_targets = await Get(Targets, RawSpecs(dir_globs=(DirGlobSpec(addr.spec_path),)))
+    candidate_targets = await Get(
+        Targets,
+        RawSpecs(
+            dir_globs=(DirGlobSpec(addr.spec_path),),
+            description_of_origin="the `go_binary` dependency inference rule",
+        ),
+    )
     relevant_pkg_targets = [
         tgt
         for tgt in candidate_targets

src/python/pants/backend/go/util_rules/go_mod.py

@@ -44,7 +44,11 @@ class OwningGoMod:
 async def find_nearest_go_mod(request: OwningGoModRequest) -> OwningGoMod:
     # We don't expect `go_mod` targets to be generated, so we can use UnexpandedTargets.
     candidate_targets = await Get(
-        UnexpandedTargets, RawSpecs(ancestor_globs=(AncestorGlobSpec(request.address.spec_path),))
+        UnexpandedTargets,
+        RawSpecs(
+            ancestor_globs=(AncestorGlobSpec(request.address.spec_path),),
+            description_of_origin="the `OwningGoMod` rule",
+        ),
     )
 
     # Sort by address.spec_path in descending order so the nearest go_mod target is sorted first.

src/python/pants/backend/project_info/paths.py

@@ -103,14 +103,18 @@ async def paths(
             Targets,
             Specs,
             specs_parser.parse_specs(
-                [path_from], convert_dir_literal_to_address_literal=convert_dir_literals
+                [path_from],
+                description_of_origin="the option `--paths-from`",
+                convert_dir_literal_to_address_literal=convert_dir_literals,
             ),
         ),
         Get(
             Targets,
             Specs,
             specs_parser.parse_specs(
-                [path_to], convert_dir_literal_to_address_literal=convert_dir_literals
+                [path_to],
+                description_of_origin="the option `--paths-to`",
+                convert_dir_literal_to_address_literal=convert_dir_literals,
             ),
         ),
     )

src/python/pants/backend/project_info/peek_test.py

@@ -195,7 +195,10 @@ def test_get_target_data(rule_runner: RuleRunner) -> None:
             "foo/b.txt": "",
         }
     )
-    tds = rule_runner.request(TargetDatas, [RawSpecs(recursive_globs=(RecursiveGlobSpec("foo"),))])
+    tds = rule_runner.request(
+        TargetDatas,
+        [RawSpecs(recursive_globs=(RecursiveGlobSpec("foo"),), description_of_origin="tests")],
+    )
     assert list(tds) == [
         TargetData(
             GenericTarget({"dependencies": [":baz"]}, Address("foo", target_name="bar")),

src/python/pants/backend/python/goals/export_test.py

@@ -63,7 +63,12 @@ def run(enable_resolves: bool) -> ExportResults:
             env_inherit={"PATH", "PYENV_ROOT"},
         )
         targets = rule_runner.request(
-            Targets, [RawSpecs(recursive_globs=(RecursiveGlobSpec("src/foo"),))]
+            Targets,
+            [
+                RawSpecs(
+                    recursive_globs=(RecursiveGlobSpec("src/foo"),), description_of_origin="tests"
+                )
+            ],
         )
         all_results = rule_runner.request(ExportResults, [ExportVenvsRequest(targets)])
 

src/python/pants/backend/python/goals/setup_py.py

@@ -930,7 +930,13 @@ async def get_exporting_owner(owned_dependency: OwnedDependency) -> ExportedTarg
     """
     target = owned_dependency.target
     ancestor_addrs = AncestorGlobSpec(target.address.spec_path)
-    ancestor_tgts = await Get(Targets, RawSpecs(ancestor_globs=(ancestor_addrs,)))
+    ancestor_tgts = await Get(
+        Targets,
+        RawSpecs(
+            ancestor_globs=(ancestor_addrs,),
+            description_of_origin="the `python_distribution` `package` rules",
+        ),
+    )
     # Note that addresses sort by (spec_path, target_name), and all these targets are
     # ancestors of the given target, i.e., their spec_paths are all prefixes. So sorting by
     # address will effectively sort by closeness of ancestry to the given target.

src/python/pants/backend/python/goals/tailor.py

@@ -186,7 +186,10 @@ def add_req_targets(files: Iterable[str], alias: str, target_name: str) -> None:
         entry_point_dirs = {os.path.dirname(entry_point) for entry_point in entry_points}
         possible_existing_binary_targets = await Get(
             UnexpandedTargets,
-            RawSpecs(ancestor_globs=tuple(AncestorGlobSpec(d) for d in entry_point_dirs)),
+            RawSpecs(
+                ancestor_globs=tuple(AncestorGlobSpec(d) for d in entry_point_dirs),
+                description_of_origin="the `pex_binary` tailor rule",
+            ),
         )
         possible_existing_binary_entry_points = await MultiGet(
             Get(ResolvedPexEntryPoint, ResolvePexEntryPointRequest(t[PexEntryPointField]))

src/python/pants/backend/terraform/dependency_inference.py

@@ -143,6 +143,7 @@ async def infer_terraform_module_dependencies(
         RawSpecs(
             dir_globs=tuple(DirGlobSpec(path) for path in candidate_spec_paths),
             unmatched_glob_behavior=GlobMatchErrorBehavior.ignore,
+            description_of_origin="the `terraform_module` dependency inference rule",
         ),
     )
     # TODO: Need to either implement the standard ambiguous dependency logic or ban >1 terraform_module

src/python/pants/base/specs.py

@@ -204,15 +204,20 @@ def matches_target_residence_dir(self, residence_dir: str) -> bool:
 
 
 def _create_path_globs(
-    globs: Iterable[str], unmatched_glob_behavior: GlobMatchErrorBehavior
+    globs: Iterable[str],
+    unmatched_glob_behavior: GlobMatchErrorBehavior,
+    *,
+    description_of_origin: str,
 ) -> PathGlobs:
     return PathGlobs(
         globs=globs,
         glob_match_error_behavior=unmatched_glob_behavior,
         # We validate that _every_ glob is valid.
         conjunction=GlobExpansionConjunction.all_match,
         description_of_origin=(
-            None if unmatched_glob_behavior == GlobMatchErrorBehavior.ignore else "CLI arguments"
+            None
+            if unmatched_glob_behavior == GlobMatchErrorBehavior.ignore
+            else description_of_origin
         ),
     )
 
@@ -228,6 +233,8 @@ class RawSpecs:
     either `Specs` or `RawSpecs` in rules, e.g. to find what targets exist in a directory.
     """
 
+    description_of_origin: str
+
     address_literals: tuple[AddressLiteralSpec, ...] = ()
     file_literals: tuple[FileLiteralSpec, ...] = ()
     file_globs: tuple[FileGlobSpec, ...] = ()
@@ -245,6 +252,7 @@ def create(
         cls,
         specs: Iterable[Spec],
         *,
+        description_of_origin: str,
         convert_dir_literal_to_address_literal: bool,
         unmatched_glob_behavior: GlobMatchErrorBehavior = GlobMatchErrorBehavior.error,
         filter_by_global_options: bool = False,
@@ -283,13 +291,14 @@ def create(
             else:
                 raise AssertionError(f"Unexpected type of Spec: {repr(spec)}")
         return RawSpecs(
-            tuple(address_literals),
-            tuple(file_literals),
-            tuple(file_globs),
-            tuple(dir_literals),
-            tuple(dir_globs),
-            tuple(recursive_globs),
-            tuple(ancestor_globs),
+            address_literals=tuple(address_literals),
+            file_literals=tuple(file_literals),
+            file_globs=tuple(file_globs),
+            dir_literals=tuple(dir_literals),
+            dir_globs=tuple(dir_globs),
+            recursive_globs=tuple(recursive_globs),
+            ancestor_globs=tuple(ancestor_globs),
+            description_of_origin=description_of_origin,
             unmatched_glob_behavior=unmatched_glob_behavior,
             filter_by_global_options=filter_by_global_options,
             from_change_detection=from_change_detection,
@@ -324,6 +333,7 @@ def to_specs_paths_path_globs(self) -> PathGlobs:
                 if self.from_change_detection
                 else self.unmatched_glob_behavior
             ),
+            description_of_origin=self.description_of_origin,
         )
 
 
@@ -335,6 +345,8 @@ class RawSpecsWithoutFileOwners:
     `Get(Addresses, RawSpecs)`, which will result in this rule being used.
     """
 
+    description_of_origin: str
+
     address_literals: tuple[AddressLiteralSpec, ...] = ()
     dir_literals: tuple[DirLiteralSpec, ...] = ()
     dir_globs: tuple[DirGlobSpec, ...] = ()
@@ -347,11 +359,12 @@ class RawSpecsWithoutFileOwners:
     @classmethod
     def from_raw_specs(cls, specs: RawSpecs) -> RawSpecsWithoutFileOwners:
         return RawSpecsWithoutFileOwners(
-            specs.address_literals,
-            specs.dir_literals,
-            specs.dir_globs,
-            specs.recursive_globs,
-            specs.ancestor_globs,
+            address_literals=specs.address_literals,
+            dir_literals=specs.dir_literals,
+            dir_globs=specs.dir_globs,
+            recursive_globs=specs.recursive_globs,
+            ancestor_globs=specs.ancestor_globs,
+            description_of_origin=specs.description_of_origin,
             unmatched_glob_behavior=specs.unmatched_glob_behavior,
             filter_by_global_options=specs.filter_by_global_options,
         )
@@ -402,7 +415,11 @@ def to_build_file_path_globs_tuple(
         validation_path_globs = (
             PathGlobs(())
             if self.unmatched_glob_behavior == GlobMatchErrorBehavior.ignore
-            else _create_path_globs((*validation_includes, *ignores), self.unmatched_glob_behavior)
+            else _create_path_globs(
+                (*validation_includes, *ignores),
+                self.unmatched_glob_behavior,
+                description_of_origin=self.description_of_origin,
+            )
         )
         return build_path_globs, validation_path_globs
 
@@ -415,6 +432,8 @@ class RawSpecsWithOnlyFileOwners:
     `Get(Addresses, RawSpecs)`, which will result in this rule being used.
     """
 
+    description_of_origin: str
+
     file_literals: tuple[FileLiteralSpec, ...] = ()
     file_globs: tuple[FileGlobSpec, ...] = ()
 
@@ -425,8 +444,9 @@ class RawSpecsWithOnlyFileOwners:
     @classmethod
     def from_raw_specs(cls, specs: RawSpecs) -> RawSpecsWithOnlyFileOwners:
         return RawSpecsWithOnlyFileOwners(
-            specs.file_literals,
-            specs.file_globs,
+            description_of_origin=specs.description_of_origin,
+            file_literals=specs.file_literals,
+            file_globs=specs.file_globs,
             unmatched_glob_behavior=specs.unmatched_glob_behavior,
             filter_by_global_options=specs.filter_by_global_options,
             from_change_detection=specs.from_change_detection,
@@ -439,7 +459,11 @@ def path_globs_for_spec(self, spec: FileLiteralSpec | FileGlobSpec) -> PathGlobs
             if self.from_change_detection
             else self.unmatched_glob_behavior
         )
-        return _create_path_globs((spec.to_glob(),), unmatched_glob_behavior)
+        return _create_path_globs(
+            (spec.to_glob(),),
+            unmatched_glob_behavior,
+            description_of_origin=self.description_of_origin,
+        )
 
     def all_specs(self) -> Iterator[FileLiteralSpec | FileGlobSpec]:
         yield from self.file_literals
@@ -459,12 +483,19 @@ class Specs:
     directory,  you can directly use `RawSpecs`.
     """
 
-    includes: RawSpecs = RawSpecs()
-    ignores: RawSpecs = RawSpecs()
+    includes: RawSpecs
+    ignores: RawSpecs
 
     def __bool__(self) -> bool:
         return bool(self.includes) or bool(self.ignores)
 
+    @classmethod
+    def empty(self) -> Specs:
+        return Specs(
+            RawSpecs(description_of_origin="<not used>"),
+            RawSpecs(description_of_origin="<not used>"),
+        )
+
     def arguments_provided_description(self) -> str | None:
         """A description of what the user specified, e.g. 'target arguments'."""
         specs_descriptions = []

src/python/pants/base/specs_parser.py

@@ -115,6 +115,7 @@ def parse_specs(
         self,
         specs: Iterable[str],
         *,
+        description_of_origin: str,
         convert_dir_literal_to_address_literal: bool,
         unmatched_glob_behavior: GlobMatchErrorBehavior = GlobMatchErrorBehavior.error,
     ) -> Specs:
@@ -129,12 +130,14 @@ def parse_specs(
 
         includes = RawSpecs.create(
             include_specs,
+            description_of_origin=description_of_origin,
             convert_dir_literal_to_address_literal=convert_dir_literal_to_address_literal,
             unmatched_glob_behavior=unmatched_glob_behavior,
             filter_by_global_options=True,
         )
         ignores = RawSpecs.create(
             ignore_specs,
+            description_of_origin=description_of_origin,
             convert_dir_literal_to_address_literal=convert_dir_literal_to_address_literal,
             unmatched_glob_behavior=unmatched_glob_behavior,
             # By setting the below to False, we will end up matching some targets

src/python/pants/base/specs_test.py

@@ -58,7 +58,7 @@ def test_dir_literal() -> None:
     assert spec.matches_target_residence_dir("dir/subdir/nested") is False
     assert spec.matches_target_residence_dir("another/subdir") is False
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(dir_literals=(spec,)),
+        RawSpecsWithoutFileOwners(dir_literals=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD", "dir/BUILD", "dir/subdir/BUILD"},
         expected_validation_globs={"dir/subdir/*"},
     )
@@ -68,7 +68,7 @@ def test_dir_literal() -> None:
     assert spec.matches_target_residence_dir("") is True
     assert spec.matches_target_residence_dir("dir") is False
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(dir_literals=(spec,)),
+        RawSpecsWithoutFileOwners(dir_literals=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD"},
         expected_validation_globs={"*"},
     )
@@ -83,7 +83,7 @@ def test_dir_glob() -> None:
     assert spec.matches_target_residence_dir("dir/subdir/nested") is False
     assert spec.matches_target_residence_dir("another/subdir") is False
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(dir_globs=(spec,)),
+        RawSpecsWithoutFileOwners(dir_globs=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD", "dir/BUILD", "dir/subdir/BUILD"},
         expected_validation_globs={"dir/subdir/*"},
     )
@@ -93,7 +93,7 @@ def test_dir_glob() -> None:
     assert spec.matches_target_residence_dir("") is True
     assert spec.matches_target_residence_dir("dir") is False
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(dir_globs=(spec,)),
+        RawSpecsWithoutFileOwners(dir_globs=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD"},
         expected_validation_globs={"*"},
     )
@@ -109,7 +109,7 @@ def test_recursive_glob() -> None:
     assert spec.matches_target_residence_dir("dir/subdir/nested/again") is True
     assert spec.matches_target_residence_dir("another/subdir") is False
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(recursive_globs=(spec,)),
+        RawSpecsWithoutFileOwners(recursive_globs=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD", "dir/BUILD", "dir/subdir/BUILD", "dir/subdir/**/BUILD"},
         expected_validation_globs={"dir/subdir/**"},
     )
@@ -120,7 +120,7 @@ def test_recursive_glob() -> None:
     assert spec.matches_target_residence_dir("dir") is True
     assert spec.matches_target_residence_dir("another_dir") is True
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(recursive_globs=(spec,)),
+        RawSpecsWithoutFileOwners(recursive_globs=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD", "**/BUILD"},
         expected_validation_globs={"**"},
     )
@@ -134,7 +134,7 @@ def test_ancestor_glob() -> None:
     assert spec.matches_target_residence_dir("dir/subdir/nested") is False
     assert spec.matches_target_residence_dir("another/subdir") is False
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(ancestor_globs=(spec,)),
+        RawSpecsWithoutFileOwners(ancestor_globs=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD", "dir/BUILD", "dir/subdir/BUILD"},
         expected_validation_globs={"dir/subdir/*"},
     )
@@ -143,7 +143,7 @@ def test_ancestor_glob() -> None:
     assert spec.matches_target_residence_dir("") is True
     assert spec.matches_target_residence_dir("dir") is False
     assert_build_file_globs(
-        RawSpecsWithoutFileOwners(ancestor_globs=(spec,)),
+        RawSpecsWithoutFileOwners(ancestor_globs=(spec,), description_of_origin="tests"),
         expected_build_globs={"BUILD"},
         expected_validation_globs={"*"},
     )

src/python/pants/bsp/util_rules/targets.py

@@ -166,7 +166,9 @@ class _ParseOneBSPMappingRequest:
 async def parse_one_bsp_mapping(request: _ParseOneBSPMappingRequest) -> BSPBuildTargetInternal:
     specs_parser = SpecsParser()
     specs = specs_parser.parse_specs(
-        request.definition.addresses, convert_dir_literal_to_address_literal=False
+        request.definition.addresses,
+        description_of_origin=f"the BSP mapping {request.name}",
+        convert_dir_literal_to_address_literal=False,
     ).includes
     return BSPBuildTargetInternal(request.name, specs, request.definition)