Allow changing the versioning scheme for `python_distribution` first-party dependencies #10977

Eric-Arellano · 2020-10-16T19:42:00Z

Users can now choose between no version requirements, compatible versions (~=), and exact requirements (==). See https://www.python.org/dev/peps/pep-0440/#compatible-release.

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

…ion` first-party dependencies # 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/backend/python/goals/setup_py.py

Eric-Arellano · 2020-10-16T19:44:19Z

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

+        register(
+            "--exact-first-party-dependency-requirements",
+            type=bool,
+            default=False,


I think we should default to ~=, but curious what you all think.

Note that this is an API change. If this weren't 2.0, we would need to set the default to using == and use a deprecation cycle to be able to change the default.

I went back to using the prior default of ==, because imo the default should favor correctness over ergonomics. Users can loosen it if they are okay with the risk of less correctness.

Also, we avoid a deprecation cycle.

# 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-16T20:34:51Z

Coverage remained the same at 0.0% when pulling 9af929a on Eric-Arellano:actual-setup-py into 9edbd82 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]

src/python/pants/backend/python/goals/setup_py.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]

We should probably default to the safest behavior, given that the purpose of a tool like Pants is correctness. This also avoids making a breaking API change. # 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]

benjyw · 2020-10-17T02:25:51Z

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

+class PythonDistributionSubsystem(Subsystem):
+    """Options for packaging wheels/sdists from a `python_distribution` target."""
+
+    options_scope = "python-distribution"


Should this be python_distribution to match the target type name?

Related: I want to make a change that normalizes dashes in scope names to underscores, so that they behave similarly to the option name itself. (i.e., --sco-pe-na-me and [sco_pe].na_me both work, as well as, [sco-pe].na_me for backwards compat).

I had it as python_distribution before, but changed it because every single scope I've seen using -, so it seemed confusing to be inconsistent.

That flexibility would be nice. We will want to decide the canonical format used in documentation.

I don't think this is worth changing to python_distribution until we add the new flexibility you describe.

…p-py # Conflicts: # src/python/pants/backend/python/goals/setup_py_test.py

…party dependencies (Cherry-pick of pantsbuild#10977) [ci skip-rust] [ci skip-build-wheels] # Conflicts: # src/python/pants/backend/python/goals/setup_py_test.py

…party dependencies (Cherry-pick of #10977) (#10989) [ci skip-rust] [ci skip-build-wheels]

Eric-Arellano requested review from benjyw, asherf and gshuflin October 16, 2020 19:42

Allow using compatible release versions (~=) with `python_distribut…

a5f0d5e

…ion` first-party dependencies # 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 force-pushed the actual-setup-py branch from 7f40800 to a5f0d5e Compare October 16, 2020 19:42

Eric-Arellano commented Oct 16, 2020

View reviewed changes

Fix tests

e519b12

# 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]

Use an enum for a cleaner interface

36637de

# 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 changed the title ~~Allow using compatible release versions (~=) with python_distribution first-party dependencies~~ Allow changing the versioning scheme for python_distribution first-party dependencies Oct 16, 2020

asherf reviewed Oct 16, 2020

View reviewed changes

src/python/pants/backend/python/goals/setup_py.py Outdated Show resolved Hide resolved

asherf approved these changes Oct 16, 2020

View reviewed changes

Eric-Arellano added 2 commits October 16, 2020 13:51

Use @enum.unique

407e1c8

# 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]

benjyw approved these changes Oct 17, 2020

View reviewed changes

Merge branch 'master' of github.com:pantsbuild/pants into actual-setu…

9af929a

…p-py # Conflicts: # src/python/pants/backend/python/goals/setup_py_test.py

Eric-Arellano merged commit f6975ec into pantsbuild:master Oct 19, 2020

Eric-Arellano deleted the actual-setup-py branch October 19, 2020 18:23

Eric-Arellano added a commit that referenced this pull request Oct 19, 2020

Allow changing the versioning scheme for python_distribution first-…

8588d5a

…party dependencies (Cherry-pick of #10977) (#10989) [ci skip-rust] [ci skip-build-wheels]

gshuflin mentioned this pull request Oct 30, 2020

Prepare 2.1.0.dev0 #11089

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow changing the versioning scheme for `python_distribution` first-party dependencies #10977

Allow changing the versioning scheme for `python_distribution` first-party dependencies #10977

Eric-Arellano commented Oct 16, 2020 •

edited

Eric-Arellano Oct 16, 2020

Eric-Arellano Oct 16, 2020

coveralls commented Oct 16, 2020 •

edited

benjyw Oct 17, 2020

Eric-Arellano Oct 19, 2020

Allow changing the versioning scheme for python_distribution first-party dependencies #10977

Allow changing the versioning scheme for python_distribution first-party dependencies #10977

Conversation

Eric-Arellano commented Oct 16, 2020 • edited

Eric-Arellano Oct 16, 2020

Choose a reason for hiding this comment

Eric-Arellano Oct 16, 2020

Choose a reason for hiding this comment

coveralls commented Oct 16, 2020 • edited

benjyw Oct 17, 2020

Choose a reason for hiding this comment

Eric-Arellano Oct 19, 2020

Choose a reason for hiding this comment

Allow changing the versioning scheme for `python_distribution` first-party dependencies #10977

Allow changing the versioning scheme for `python_distribution` first-party dependencies #10977

Eric-Arellano commented Oct 16, 2020 •

edited

coveralls commented Oct 16, 2020 •

edited