Add `./pants help subsystems` #11088

thamenato · 2020-10-30T22:21:47Z

[ci skip-rust]
[ci skip-build-wheels]

Problem

As described on #11032:

As a user I would like to see all the available subsystem options that I currently have in order to make changes to them inside my pants.toml file.

Solution

Implement the "category" subsystems inside the help function.

Result

When running the command ./pants help subsystems the user should be able to see what are the subsystems availables.

> ./pants help subsystems

Subsystems
------------

pex                                Lorem ipsum dolor sit amet.

download-pex-bin       Lorem ipsum dolor sit amet.

...

Use `./pants help $subsystem` to get help for a specific subsystem.

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

coveralls · 2020-10-30T22:56:16Z

Coverage remained the same at 0.0% when pulling 829cacf on thamenato:feature/add-help-subsystems into 4283b13 on pantsbuild:master.

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thamenato · 2020-11-03T02:56:10Z

With my latest changes when running ./pants help subsystems it prints the following:


Subsystems
----------

black                   The Black Python code formatter (https://black.readthedocs.io/).

changed                 Tell Pants to detect what files and targets have changed from Git.

coverage-py             Configuration for Python test coverage measurement.

docformatter            The Python docformatter tool (https://github.com/myint/docformatter).

download-pex-bin        The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex).

flake8                  The Flake8 Python linter (https://flake8.pycqa.org/).

ipython                 The IPython enhanced REPL (https://ipython.org/).

isort                   The Python import sorter tool (https://timothycrosley.github.io/isort/).

mypy                    The MyPy Python type checker (http://mypy-lang.org/).

pants-releases          Options for Pants's release process.

pex                     How Pants uses Pex to run Python subprocesses.

pex-binary-defaults     Default settings for creating PEX executables.

pytest                  The pytest Python test framework (https://docs.pytest.org/).

python-infer            Options controlling which dependencies will be inferred for Python targets.

python-native-code      Options for building native code using Python, e.g. when resolving distributions.

python-repos            External Python code repositories, such as PyPI.

python-setup            A Python environment.

run-tracker             Tracks and times the execution of a pants run.

scc                     The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc).

setup-py-generation     Options to control how setup.py is generated from a `python_distribution` target.

setuptools              The Python setuptools library (https://github.com/pypa/setuptools).

source                  Configuration for roots of source trees.

sourcefile-validation   Configuration for source file validation.

subprocess-environment  Environment settings for forked subprocesses.

Use `./pants help $subsystem_type` to get help for a specific subsystem.

thamenato · 2020-11-03T03:00:09Z

@Eric-Arellano and @benjyw this is ready for review 😃

benjyw · 2020-11-04T00:29:30Z

Thanks @thamenato ! Will review tomorrow.

Eric-Arellano

This looks great! Thanks!

As mentioned over DM, would be good to add 1-2 tests.

src/python/pants/help/help_printer.py

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

src/python/pants/help/help_integration_test.py

Eric-Arellano

Awesome! This looks great.

Eric-Arellano · 2020-11-05T01:42:19Z

src/python/pants/help/help_integration_test.py

+        "pex                     How Pants uses Pex to run Python subprocesses" in pants_run.stdout
+    )
+    assert "to get help for a specific subsystem" in pants_run.stdout
+    assert "test            Run tests." not in pants_run.stdout


Negative assertions are generally brittle. If we rewrite the docstring for TestSubsystem to be different than "Run tests.", then this assertion will always pass, even if we break things. https://thepugautomatic.com/2013/04/negative-assertions/ talks a bit about this.

I suspect the best thing here would be to still use a negative assertion, but to use the re module to make it less brittle. Maybe something like ^test\s+. It's plausible we'll change the docstring and/or number of spaces, but very unlikely we'd ever change the line starting with test imo.

Yeah, I was wondering that myself.. it wouldn't fail but putting only the word "test" is also not a good idea. I think what you said is definitely a good solution, using some regex ❤️

but putting only the word "test" is also not a good idea

Indeed, and this assertion wouldn't work either. test is part of pytest hehe.

Done, updated it to use regex.

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano

Woot! Will merge on green (unless Benjy has more feedback)

Thanks!

benjyw

LGTM!

benjyw · 2020-11-05T03:10:55Z

This is a great contribution, thanks for doing it!

Eric-Arellano · 2020-11-05T03:16:35Z

FYI I reworded the PR title to "Add ./pants help subsystems", mostly for the purpose of the changelog. We use PR titles when aggregating the changelog. The original title was great for an issue description, but now that it's implemented, we can replace "should" with "add" to explain to users this is a new feature, and what command to use it :)

feat: help shows subsystems and subsystems returns something

4a378e7

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

feat: help subsystems returns all subsystems and descriptions

1941475

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thamenato marked this pull request as ready for review November 3, 2020 02:56

thamenato changed the title ~~WIP: Pants should return all available subsystems from help command~~ Pants should return all available subsystems from help command Nov 3, 2020

Eric-Arellano reviewed Nov 4, 2020

View reviewed changes

src/python/pants/help/help_printer.py Outdated Show resolved Hide resolved

src/python/pants/help/help_printer.py Outdated Show resolved Hide resolved

thamenato added 3 commits November 4, 2020 17:04

fix: swap word 'installed' to 'configurable'

6abc071

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

fix: change '' to ''

d88997d

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

test: check if stdout matches one subsystem and doesn't contain a goal

49f3fd0

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thamenato commented Nov 5, 2020

View reviewed changes

src/python/pants/help/help_integration_test.py Show resolved Hide resolved

Eric-Arellano approved these changes Nov 5, 2020

View reviewed changes

test: change the negative assertion to use regex

829cacf

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano approved these changes Nov 5, 2020

View reviewed changes

benjyw approved these changes Nov 5, 2020

View reviewed changes

Eric-Arellano changed the title ~~Pants should return all available subsystems from help command~~ Add ./pants help subsystems Nov 5, 2020

Eric-Arellano merged commit e674148 into pantsbuild:master Nov 5, 2020

Eric-Arellano mentioned this pull request Nov 5, 2020

Pants should return all available subsystems from help command #11032

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `./pants help subsystems` #11088

Add `./pants help subsystems` #11088

thamenato commented Oct 30, 2020 •

edited

coveralls commented Oct 30, 2020 •

edited

thamenato commented Nov 3, 2020

thamenato commented Nov 3, 2020

benjyw commented Nov 4, 2020

Eric-Arellano left a comment

Eric-Arellano left a comment

Eric-Arellano Nov 5, 2020 •

edited

thamenato Nov 5, 2020

Eric-Arellano Nov 5, 2020

thamenato Nov 5, 2020

Eric-Arellano left a comment

benjyw left a comment

benjyw commented Nov 5, 2020

Eric-Arellano commented Nov 5, 2020

Add ./pants help subsystems #11088

Add ./pants help subsystems #11088

Conversation

thamenato commented Oct 30, 2020 • edited

Problem

Solution

Result

coveralls commented Oct 30, 2020 • edited

thamenato commented Nov 3, 2020

thamenato commented Nov 3, 2020

benjyw commented Nov 4, 2020

Eric-Arellano left a comment

Choose a reason for hiding this comment

Eric-Arellano left a comment

Choose a reason for hiding this comment

Eric-Arellano Nov 5, 2020 • edited

Choose a reason for hiding this comment

thamenato Nov 5, 2020

Choose a reason for hiding this comment

Eric-Arellano Nov 5, 2020

Choose a reason for hiding this comment

thamenato Nov 5, 2020

Choose a reason for hiding this comment

Eric-Arellano left a comment

Choose a reason for hiding this comment

benjyw left a comment

Choose a reason for hiding this comment

benjyw commented Nov 5, 2020

Eric-Arellano commented Nov 5, 2020

Add `./pants help subsystems` #11088

Add `./pants help subsystems` #11088

thamenato commented Oct 30, 2020 •

edited

coveralls commented Oct 30, 2020 •

edited

Eric-Arellano Nov 5, 2020 •

edited