Skip to content

Commit

Permalink
Fix Poetry req synthesis for URLs with markers. (Cherry-pick of #18535)…
Browse files Browse the repository at this point in the history
… (#18537)

Previously the PEP-508 direct reference URL requirement synthesis ran
afoul of creating ambiguous requirement strings as detailed here:
pypa/packaging#456 (comment)

Fixes #18530

(cherry picked from commit 54fb80b)
  • Loading branch information
jsirois authored Mar 21, 2023
1 parent a40b6fa commit 5362293
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 49 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ def add_markers(base: str, attributes: PyprojectAttr, fp) -> str:
if not markers_lookup and not python_lookup:
return base

result = f"{base};("
result = f"{base} ;("

if markers_lookup:
result += f"{markers_lookup})"
Expand Down
109 changes: 61 additions & 48 deletions src/python/pants/backend/python/macros/poetry_requirements_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,36 +107,44 @@ def test_handle_str(test, exp) -> None:
assert parse_str_version(test, proj_name="foo", file_path="", extras_str="") == f"foo {exp}"


def assert_equal_requirements(actual: str | None, expected: str) -> None:
assert actual is not None
assert PipRequirement.parse(expected) == PipRequirement.parse(actual)


def test_add_markers() -> None:

attr_mark = PyprojectAttr({"markers": "platform_python_implementation == 'CPython'"})
assert (
add_markers("foo==1.0.0", attr_mark, "somepath")
== "foo==1.0.0;(platform_python_implementation == 'CPython')"
assert_equal_requirements(
add_markers("foo==1.0.0", attr_mark, "somepath"),
"foo==1.0.0;(platform_python_implementation == 'CPython')",
)

attr_mark_adv = PyprojectAttr(
{"markers": "platform_python_implementation == 'CPython' or sys_platform == 'win32'"}
)
assert (
add_markers("foo==1.0.0", attr_mark_adv, "somepath")
== "foo==1.0.0;(platform_python_implementation == 'CPython' or sys_platform == 'win32')"
assert_equal_requirements(
add_markers("foo==1.0.0", attr_mark_adv, "somepath"),
"foo==1.0.0;(platform_python_implementation == 'CPython' or sys_platform == 'win32')",
)
attr_basic_both = PyprojectAttr({"python": "3.6"})
attr_basic_both.update(attr_mark)

assert (
add_markers("foo==1.0.0", attr_basic_both, "somepath")
== "foo==1.0.0;(platform_python_implementation == 'CPython') and (python_version == '3.6')"
assert_equal_requirements(
add_markers("foo==1.0.0", attr_basic_both, "somepath"),
"foo==1.0.0;(platform_python_implementation == 'CPython') and (python_version == '3.6')",
)
attr_adv_py_both = PyprojectAttr(
{"python": "^3.6", "markers": "platform_python_implementation == 'CPython'"}
)
assert add_markers("foo==1.0.0", attr_adv_py_both, "somepath") == softwrap(
"""
foo==1.0.0;(platform_python_implementation == 'CPython') and
(python_version >= '3.6' and python_version< '4.0')
"""
assert_equal_requirements(
add_markers("foo==1.0.0", attr_adv_py_both, "somepath"),
softwrap(
"""
foo==1.0.0;(platform_python_implementation == 'CPython') and
(python_version >= '3.6' and python_version< '4.0')
"""
),
)

attr_adv_both = PyprojectAttr(
Expand All @@ -145,11 +153,14 @@ def test_add_markers() -> None:
"markers": "platform_python_implementation == 'CPython' or sys_platform == 'win32'",
}
)
assert add_markers("foo==1.0.0", attr_adv_both, "somepath") == softwrap(
"""
foo==1.0.0;(platform_python_implementation == 'CPython' or
sys_platform == 'win32') and (python_version >= '3.6' and python_version< '4.0')
"""
assert_equal_requirements(
add_markers("foo==1.0.0", attr_adv_both, "somepath"),
softwrap(
"""
foo==1.0.0;(platform_python_implementation == 'CPython' or
sys_platform == 'win32') and (python_version >= '3.6' and python_version< '4.0')
"""
),
)


Expand Down Expand Up @@ -196,9 +207,9 @@ def test_handle_git(empty_pyproject_toml: PyProjectToml) -> None:
def assert_git(extra_opts: PyprojectAttr, suffix: str) -> None:
attr = PyprojectAttr({"git": "https://github.com/requests/requests.git"})
attr.update(extra_opts)
assert (
handle_dict_attr("requests", attr, empty_pyproject_toml)
== f"requests @ git+https://github.com/requests/requests.git{suffix}"
assert_equal_requirements(
handle_dict_attr("requests", attr, empty_pyproject_toml),
f"requests @ git+https://github.com/requests/requests.git{suffix}",
)

assert_git({}, "")
Expand All @@ -213,7 +224,7 @@ def assert_git(extra_opts: PyprojectAttr, suffix: str) -> None:
"python": "3.6",
}
),
"@main;(platform_python_implementation == 'CPython') and (python_version == '3.6')",
"@main ;(platform_python_implementation == 'CPython') and (python_version == '3.6')",
)


Expand Down Expand Up @@ -257,53 +268,53 @@ def test_handle_path_arg(tmp_path: Path) -> None:
file_attr_extras = PyprojectAttr({"path": "../../my_py_proj.whl", "extras": ["extra1"]})
dir_attr = PyprojectAttr({"path": "../../my_py_proj"})

assert (
handle_dict_attr("my_py_proj", file_attr, one_pyproject_toml)
== f"my_py_proj @ file://{external_file}"
assert_equal_requirements(
handle_dict_attr("my_py_proj", file_attr, one_pyproject_toml),
f"my_py_proj @ file://{external_file}",
)

assert (
handle_dict_attr("my_py_proj", file_attr_extras, one_pyproject_toml)
== f"my_py_proj[extra1] @ file://{external_file}"
assert_equal_requirements(
handle_dict_attr("my_py_proj", file_attr_extras, one_pyproject_toml),
f"my_py_proj[extra1] @ file://{external_file}",
)

assert (
handle_dict_attr("my_py_proj", file_attr_mark, one_pyproject_toml)
== f"my_py_proj @ file://{external_file};(os_name=='darwin')"
assert_equal_requirements(
handle_dict_attr("my_py_proj", file_attr_mark, one_pyproject_toml),
f"my_py_proj @ file://{external_file} ;(os_name=='darwin')",
)

assert (
handle_dict_attr("my_py_proj", file_attr, two_pyproject_toml)
== f"my_py_proj @ file://{internal_file}"
assert_equal_requirements(
handle_dict_attr("my_py_proj", file_attr, two_pyproject_toml),
f"my_py_proj @ file://{internal_file}",
)

assert (
handle_dict_attr("my_py_proj", dir_attr, one_pyproject_toml)
== f"my_py_proj @ file://{external_project}"
assert_equal_requirements(
handle_dict_attr("my_py_proj", dir_attr, one_pyproject_toml),
f"my_py_proj @ file://{external_project}",
)

assert handle_dict_attr("my_py_proj", dir_attr, two_pyproject_toml) is None


def test_handle_url_arg(empty_pyproject_toml: PyProjectToml) -> None:
attr = PyprojectAttr({"url": "https://my-site.com/mydep.whl"})
assert (
handle_dict_attr("my_py_proj", attr, empty_pyproject_toml)
== "my_py_proj @ https://my-site.com/mydep.whl"
assert_equal_requirements(
handle_dict_attr("my_py_proj", attr, empty_pyproject_toml),
"my_py_proj @ https://my-site.com/mydep.whl",
)

attr_with_extra = PyprojectAttr({"extras": ["extra1"]})
attr_with_extra.update(attr)
assert (
handle_dict_attr("my_py_proj", attr_with_extra, empty_pyproject_toml)
== "my_py_proj[extra1] @ https://my-site.com/mydep.whl"
assert_equal_requirements(
handle_dict_attr("my_py_proj", attr_with_extra, empty_pyproject_toml),
"my_py_proj[extra1] @ https://my-site.com/mydep.whl",
)

attr_with_mark = PyprojectAttr({"markers": "os_name=='darwin'"})
attr_with_mark.update(attr)
assert (
handle_dict_attr("my_py_proj", attr_with_mark, empty_pyproject_toml)
== "my_py_proj @ https://my-site.com/mydep.whl;(os_name=='darwin')"
assert_equal_requirements(
handle_dict_attr("my_py_proj", attr_with_mark, empty_pyproject_toml),
"my_py_proj @ https://my-site.com/mydep.whl ;(os_name=='darwin')",
)


Expand All @@ -315,7 +326,9 @@ def test_version_only(empty_pyproject_toml: PyProjectToml) -> None:
def test_py_constraints(empty_pyproject_toml: PyProjectToml) -> None:
def assert_py_constraints(py_req: str, suffix: str) -> None:
attr = PyprojectAttr({"version": "1.2.3", "python": py_req})
assert handle_dict_attr("foo", attr, empty_pyproject_toml) == f"foo ==1.2.3;{suffix}"
assert_equal_requirements(
handle_dict_attr("foo", attr, empty_pyproject_toml), f"foo ==1.2.3;{suffix}"
)

assert_py_constraints("3.6", "(python_version == '3.6')")
assert_py_constraints("3.6 || 3.7", "((python_version == '3.6') or (python_version == '3.7'))")
Expand Down

0 comments on commit 5362293

Please sign in to comment.