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

Sort extras and extras dependencies in lockfile #6169

Merged
merged 4 commits into from
Aug 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/poetry/packages/locker.py
Original file line number Diff line number Diff line change
Expand Up @@ -587,13 +587,13 @@ def _dump_package(self, package: Package) -> dict[str, Any]:

if package.extras:
extras = {}
for name, deps in package.extras.items():
for name, deps in sorted(package.extras.items()):
# TODO: This should use dep.to_pep_508() once this is fixed
# https://github.com/python-poetry/poetry-core/pull/102
extras[name] = [
extras[name] = sorted(
dep.base_pep_508_name if not dep.constraint.is_any() else dep.name
for dep in deps
mkniewallner marked this conversation as resolved.
Show resolved Hide resolved
]
)

data["extras"] = extras

Expand Down
18 changes: 9 additions & 9 deletions tests/installation/fixtures/with-pypi-repository.test
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ optional = false
python-versions = "*"

[package.extras]
dev = ["coverage", "hypothesis", "pympler", "pytest", "six", "zope-interface", "sphinx", "zope-interface"]
dev = ["coverage", "hypothesis", "pympler", "pytest", "six", "sphinx", "zope-interface", "zope-interface"]
docs = ["sphinx", "zope-interface"]
tests = ["coverage", "hypothesis", "pympler", "pytest", "six", "zope-interface"]

Expand Down Expand Up @@ -72,14 +72,6 @@ pluggy = ">=0.5,<0.7"
funcsigs = {"version" = "*", "markers" = "python_version < \"3.0\""}
colorama = {"version" = "*", "markers" = "sys_platform == \"win32\""}

[[package]]
name = "six"
version = "1.11.0"
description = "Python 2 and 3 compatibility utilities"
category = "dev"
optional = false
python-versions = "*"

[[package]]
name = "setuptools"
version = "39.2.0"
Expand All @@ -92,6 +84,14 @@ python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*"
certs = ["certifi (==2016.9.26)"]
ssl = ["wincertstore (==0.2)"]

[[package]]
name = "six"
version = "1.11.0"
description = "Python 2 and 3 compatibility utilities"
category = "dev"
optional = false
python-versions = "*"

[metadata]
python-versions = "*"
lock-version = "1.1"
Expand Down
3 changes: 1 addition & 2 deletions tests/installation/test_installer.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
from cleo.io.null_io import NullIO
from cleo.io.outputs.buffered_output import BufferedOutput
from cleo.io.outputs.output import Verbosity
from deepdiff import DeepDiff
from poetry.core.packages.dependency_group import MAIN_GROUP
from poetry.core.packages.dependency_group import DependencyGroup
from poetry.core.packages.package import Package
Expand Down Expand Up @@ -1164,7 +1163,7 @@ def test_installer_with_pypi_repository(

expected = fixture("with-pypi-repository")

assert not DeepDiff(expected, locker.written_data, ignore_order=True)
assert expected == locker.written_data
radoering marked this conversation as resolved.
Show resolved Hide resolved


def test_run_installs_with_local_file(
Expand Down
3 changes: 1 addition & 2 deletions tests/installation/test_installer_old.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
import pytest

from cleo.io.null_io import NullIO
from deepdiff import DeepDiff
from poetry.core.packages.project_package import ProjectPackage
from poetry.core.toml.file import TOMLFile

Expand Down Expand Up @@ -833,7 +832,7 @@ def test_installer_with_pypi_repository(

expected = fixture("with-pypi-repository")

assert not DeepDiff(expected, locker.written_data, ignore_order=True)
assert expected == locker.written_data


def test_run_installs_with_local_file(
Expand Down
45 changes: 45 additions & 0 deletions tests/packages/test_locker.py
Original file line number Diff line number Diff line change
Expand Up @@ -778,6 +778,51 @@ def test_locker_dumps_subdir(locker: Locker, root: ProjectPackage) -> None:
assert content == expected


def test_locker_dumps_dependency_extras_in_correct_order(
locker: Locker, root: ProjectPackage
):
root_dir = Path(__file__).parent.parent.joinpath("fixtures")
package_a = get_package("A", "1.0.0")
Factory.create_dependency("B", "1.0.0", root_dir=root_dir)
Factory.create_dependency("C", "1.0.0", root_dir=root_dir)
package_first = Factory.create_dependency("first", "1.0.0", root_dir=root_dir)
package_second = Factory.create_dependency("second", "1.0.0", root_dir=root_dir)
package_third = Factory.create_dependency("third", "1.0.0", root_dir=root_dir)

package_a.extras = {
"C": [package_third, package_second, package_first],
"B": [package_first, package_second, package_third],
}

locker.set_lock_data(root, [package_a])

with locker.lock.open(encoding="utf-8") as f:
content = f.read()

expected = """[[package]]
name = "A"
version = "1.0.0"
description = ""
category = "main"
optional = false
python-versions = "*"

[package.extras]
B = ["first (==1.0.0)", "second (==1.0.0)", "third (==1.0.0)"]
C = ["first (==1.0.0)", "second (==1.0.0)", "third (==1.0.0)"]

[metadata]
lock-version = "1.1"
python-versions = "*"
content-hash = "115cf985d932e9bf5f540555bbdd75decbb62cac81e399375fc19f6277f8c1d8"

[metadata.files]
A = []
"""

assert content == expected


def test_locked_repository_uses_root_dir_of_package(
locker: Locker, mocker: MockerFixture
):
Expand Down