Project introspection
Finding insights in your project.
Pants provides several goals to provide insights into your project's structure.
xargs to pipe these goals into other Pants commandsFor example:
$ ./pants dependees project:lib | xargs ./pants test
See Advanced target selection for more info and other techniques to use the results.
list - find your project's targets
list will find all targets that match the arguments.
For example, to show all targets in your project:
$ ./pants list ::
//:ansicolors
//:setuptools
helloworld:config
helloworld:config_file
...
filter - find targets that match a predicate
filter is like list, but will only include targets that match the predicate(s).
Specify a predicate by using one of the below filter options, like --target-type. You can use a comma to OR multiple values, meaning that at least one member must be matched. You can repeat the option multiple times to AND each filter. You can prefix the filter with - to negate the filter, meaning that the target must not be true for the filter.
Some examples:
# Only `python_library` targets.
./pants filter --target-type=python_library ::
# `python_library` or `python_tests` targets.
./pants filter --target-type='python_library,python_tests' ::
# `python_library` targets which have "type_checked" in their `tags` field.
./pants filter --target-type=python_library --tag-regex=type_checked ::
# Any target except for `python_library` targets
./pants filter --target-type='-python_library' ::
filter --target-type
Each value should be the name of a target type, e.g. python_library or resources. Run ./pants help targets to see what targets are registered.
filter --address-regex
Regex strings for the address, such as ^dir or :util$.
filter --tag-regex
Regex strings for the tags field. Alternatively, you can use the global --tags option, which uses exact string matches instead of regex. See Advanced target selection.
dependencies - find a target's dependencies
Use dependencies to list all targets used directly by a target.
$ ./pants dependencies helloworld/util:util
//:setuptools
//:translate
helloworld/protos:protos
To include transitive dependencies—meaning the dependencies of the direct dependencies—use --transitive:
$ ./pants dependencies --transitive helloworld/util:util
//:protobuf
//:requirements.txt
//:setuptools
//:translate
helloworld/protos:protos
You can also output your 3rdparty requirements (e.g. Python requirement strings) by using --type=3rdparty or --type=source-and-3rdparty:
$ ./pants dependencies --type=3rdparty helloworld/util:util
setuptools>=42.0.0
translate>=3.2.1
dependees - find which targets depend on a target
The dependees goal finds all targets that directly depend on the target you specify.
$ ./pants dependees helloworld/util:util
helloworld:config
helloworld/greet:greet
helloworld/util:tests
To include transitive dependees—meaning targets that don't directly depend on your target, but which depend on a target that does directly use your target—use --transitive:
$ ./pants dependees --transitive helloworld/util:util
helloworld:config
helloworld:helloworld
helloworld:helloworld-awslambda
helloworld/greet:greet
helloworld/greet:tests
helloworld/util:tests
To include the original target itself, use --closed:
$ ./pants dependees --closed helloworld/util:util
helloworld:config
helloworld/greet:greet
helloworld/util:tests
helloworld/util:util
Finally, we recommend --output-format=json when using multiple input targets:
$ ./pants dependees --output-format=json helloworld/util:util helloworld/protos:protos
{
"helloworld/protos:protos": [
"helloworld/util:util",
"helloworld:config"
],
"helloworld/util:util": [
"helloworld/greet:greet",
"helloworld/util:tests",
"helloworld:config"
]
}
dependees when starting a big migrationRunning ./pants dependees --transitive --output-format=json :: will allow you to find the most-depended on code in your project, such as util code. Often, you will want to convert these targets first.
For example, do this when migrating from Python 2 to Python 3, or adding an incremental type checker like MyPy or TypeScript to your project.
filedeps - find which files a target owns
filedeps outputs all of the files belonging to a target, based on its sources field.
$ ./pants filedeps helloworld/util:util
helloworld/util/BUILD
helloworld/util/config_loader.py
helloworld/util/lang.py
To output absolute paths, use the option --absolute:
$ ./pants filedeps --absolute helloworld/util:util
/Users/pantsbuild/example-python/helloworld/util/BUILD
/Users/pantsbuild/example-python/helloworld/util/config_loader.py
/Users/pantsbuild/example-python/helloworld/util/lang.py
To include the files used by dependencies (including transitive dependencies), use --transitive:
$ ./pants filedeps --transitive helloworld/util:util
BUILD
helloworld/protos/BUILD
helloworld/protos/config.proto
helloworld/util/BUILD
helloworld/util/config_loader.py
helloworld/util/lang.py
requirements.txt
peek - programmatically inspect a target
peek outputs JSON for each target specified.
$ ./pants peek helloworld/util:tests
[
{
"address": "helloworld/util:tests",
"target_type": "python_tests",
"dependencies": null,
"description": null,
"interpreter_constraints": null,
"skip_black": false,
"skip_docformatter": false,
"skip_flake8": true,
"skip_isort": false,
"skip_mypy": false,
"sources": [
"*.py",
"*.pyi",
"!test_*.py",
"!*_test.py",
"!tests.py",
"!conftest.py",
"!test_*.pyi",
"!*_test.pyi",
"!tests.pyi"
],
"tags": null
}
]
You can use --exclude-defaults for less verbose output:
$ ./pants peek helloworld/util:tests
[
{
"address": "helloworld/util:tests",
"target_type": "python_tests",
"skip_flake8": true,
}
]
peek can be particularly useful when paired with JQ to query the JSON. For example, you can combine ./pants peek with JQ to find all targets where you set the field skip_flake8=True:
$ ./pants peek :: | jq -r '.[] | select(.skip_flake8 == true) | .["address"]'
helloworld/greet:lib
helloworld/greet:tests
helloworld/util:lib
count-loc - count lines of code
count-loc counts the lines of code of the specified files by running the Succinct Code Counter tool.
$ ./pants count-loc ::
───────────────────────────────────────────────────────────────────────────────
Language Files Lines Blanks Comments Code Complexity
───────────────────────────────────────────────────────────────────────────────
Python 1690 618679 23906 7270 587503 18700
HTML 61 6522 694 67 5761 0
JSON 36 18755 6 0 18749 0
YAML 30 2451 4 19 2428 0
JavaScript 6 671 89 8 574 32
CSV 1 2 0 0 2 0
JSONL 1 4 0 0 4 0
Jinja 1 11 0 0 11 2
Shell 1 13 2 2 9 4
TOML 1 146 5 0 141 0
───────────────────────────────────────────────────────────────────────────────
Total 1828 647254 24706 7366 615182 18738
───────────────────────────────────────────────────────────────────────────────
Estimated Cost to Develop $22,911,268
Estimated Schedule Effort 50.432378 months
Estimated People Required 53.813884
───────────────────────────────────────────────────────────────────────────────
$ ./pants count-loc '**/*.py' '**/*.proto'
───────────────────────────────────────────────────────────────────────────────
Language Files Lines Blanks Comments Code Complexity
───────────────────────────────────────────────────────────────────────────────
Python 13 155 50 22 83 5
Protocol Buffers 1 11 3 2 6 0
───────────────────────────────────────────────────────────────────────────────
Total 14 166 53 24 89 5
───────────────────────────────────────────────────────────────────────────────
SCC has dozens of options. You can pass through options by either setting --scc-args or using -- at the end of your command, like this:
./pants count-loc '**' -- --no-cocomo
pants_ignore.By default, Pants will ignore all globs specified in your .gitignore, along with dist/ and any hidden files.
To ignore additional files, add to the global option pants_ignore in your pants.toml, using the same syntax as .gitignore files.
For example:
[GLOBAL]
pants_ignore.add = ["/ignore_this_dir/"]