Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ./pants py-constraints --summary for project overview #11099

Merged
merged 3 commits into from Nov 6, 2020

Conversation

Eric-Arellano
Copy link
Contributor

This is intended to give an overview of the current status of your project, and to help with prioritization for things like Python 3. In contrast, ./pants py-constraints without --summary is intended for debugging on the local terminal.

We export as a CSV and expect users to import into Excel or Google Sheets to analyze the data. For example, https://docs.google.com/spreadsheets/d/1B_2WNmXuXCMbhU6h8nwhSV3YdArJZtE_qODYcI2968o/edit?usp=sharing.

We always run over the entire repo, rather than looking at user specs. This simplifies handling of subtargets and differences between file args vs. target args; both types of addresses are included in the analysis.

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

[ci skip-rust]
[ci skip-build-wheels]
@Eric-Arellano
Copy link
Contributor Author

fyi @rcuza - feedback welcomes. Blog post about Py2 -> Py3 support coming soon :)

@coveralls
Copy link

coveralls commented Nov 5, 2020

Coverage Status

Coverage remained the same at 0.0% when pulling 02d3716 on Eric-Arellano:interp-summary into 72d0409 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]
Copy link
Contributor

@rcuza rcuza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. I think the CSV output is a great way of avoiding the UX overflow this amount of data would produce.

I offer some suggestions on how to improve the wording to users. Not sure if they are better or worse than the original wording. Use or ignore as you see fit.

Thanks Raúl! Great suggestions.

Also, improve the warning of when you're not using `--summary` and have no matching targets/files.

# 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 Eric-Arellano merged commit fbe4c2f into pantsbuild:master Nov 6, 2020
@Eric-Arellano Eric-Arellano deleted the interp-summary branch November 6, 2020 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants