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.

Sign up for GitHub

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

Support multi-file version constraints #546

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+266 −9
Open

Support multi-file version constraints #546

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2dc54e9
Support multi-file version constraints
knedlsepp Nov 10, 2023
d6c4873
Split up _merge_matchspecs
knedlsepp Nov 25, 2023
19436cb
Add tests for _merge_versions/_merge_builds
knedlsepp Nov 25, 2023
1eafa23
Simplify aggregation
knedlsepp Nov 25, 2023
8379271
Don't disallow merging different categories
knedlsepp Nov 25, 2023
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
122 changes: 122 additions & 0 deletions conda_lock/models/lock_spec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
from __future__ import annotations

import copy
import hashlib
import json
import pathlib
import typing

from fnmatch import fnmatchcase
from typing import Dict, List, Optional, Union

from pydantic import BaseModel, Field, validator
Expand All @@ -24,23 +28,141 @@ class _BaseDependency(StrictModel):
def sorted_extras(cls, v: List[str]) -> List[str]:
return sorted(v)

def _merge_base(self, other: _BaseDependency) -> _BaseDependency:
if other is None:
return self
if (
self.name != other.name
or self.manager != other.manager
or self.category != other.category
knedlsepp marked this conversation as resolved.
Show resolved Hide resolved
):
raise ValueError(
"Cannot merge incompatible dependencies: {self} != {other}"
)
return _BaseDependency(
name=self.name,
manager=self.manager,
category=self.category,
extras=list(set(self.extras + other.extras)),
)


class VersionedDependency(_BaseDependency):
version: str
build: Optional[str] = None
conda_channel: Optional[str] = None

@staticmethod
def _merge_matchspecs(
matchspec1: Optional[str],
matchspec2: Optional[str],
combine_constraints: bool = True,
) -> Optional[str]:
if matchspec1 == matchspec2:
return matchspec1
if matchspec1 is None or matchspec1 == "":
return matchspec2
if matchspec2 is None or matchspec2 == "":
return matchspec1
if fnmatchcase(matchspec1, matchspec2):
knedlsepp marked this conversation as resolved.
Show resolved Hide resolved
return matchspec1
if fnmatchcase(matchspec2, matchspec1):
return matchspec2
if not combine_constraints:
raise ValueError(
f"Found incompatible constraint {matchspec1}, {matchspec2}"
)
return f"{matchspec1},{matchspec2}"

def merge(self, other: Optional[VersionedDependency]) -> VersionedDependency:
if other is None:
return self

if (
self.conda_channel is not None
and other.conda_channel is not None
and self.conda_channel != other.conda_channel
):
raise ValueError(
f"VersionedDependency has two different conda_channels:\n{self}\n{other}"
)
merged_base = self._merge_base(other)
try:
build = self._merge_matchspecs(
self.build, other.build, combine_constraints=False
)
Copy link
Contributor

Choose a reason for hiding this comment

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

I spent pretty long in confusion here. Rather than use combine_constraints I think it would be better to have a separate functions here, like _merge_version and _merge_build. I have far less qualms about wildcard tricks for build numbers.

Also I think you can get rid of the surrounding try/except block: just raise the exception directly in _merge_build.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also I think you can get rid of the surrounding try/except block: just raise the exception directly in _merge_build.

The surrounding try/except block adds the package names to the exception, which is convenient for the user to figure out which package has conflicting builds. Otherwise the error message would only contain the build ids

except ValueError as exc:
raise ValueError(
f"Unsupported usage of two incompatible builds for same dependency {self}, {other}"
) from exc

return VersionedDependency(
name=merged_base.name,
manager=merged_base.manager,
category=merged_base.category,
extras=merged_base.extras,
version=self._merge_matchspecs(self.version, other.version), # type: ignore
knedlsepp marked this conversation as resolved.
Show resolved Hide resolved
build=build,
conda_channel=self.conda_channel or other.conda_channel,
)


class URLDependency(_BaseDependency):
url: str
hashes: List[str]

def merge(self, other: Optional[URLDependency]) -> URLDependency:
if other is None:
return self
if self.url != other.url:
raise ValueError(f"URLDependency has two different urls:\n{self}\n{other}")

if self.hashes != other.hashes:
raise ValueError(
f"URLDependency has two different hashess:\n{self}\n{other}"
)
merged_base = self._merge_base(other)

return URLDependency(
name=merged_base.name,
manager=merged_base.manager,
category=merged_base.category,
extras=merged_base.extras,
url=self.url,
hashes=self.hashes,
)


class VCSDependency(_BaseDependency):
source: str
vcs: str
rev: Optional[str] = None

def merge(self, other: Optional[VCSDependency]) -> VCSDependency:
if other is None:
return self
if self.source != other.source:
raise ValueError(
f"VCSDependency has two different sources:\n{self}\n{other}"
)

if self.vcs != other.vcs:
raise ValueError(f"VCSDependency has two different vcss:\n{self}\n{other}")

if self.rev is not None and other.rev is not None and self.rev != other.rev:
raise ValueError(f"VCSDependency has two different revs:\n{self}\n{other}")
merged_base = self._merge_base(other)

return VCSDependency(
name=merged_base.name,
manager=merged_base.manager,
category=merged_base.category,
extras=merged_base.extras,
source=self.source,
vcs=self.vcs,
rev=self.rev or other.rev,
)


Dependency = Union[VersionedDependency, URLDependency, VCSDependency]

Expand Down
6 changes: 5 additions & 1 deletion conda_lock/src_parser/aggregation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ def aggregate_lock_specs(
lock_spec.dependencies.get(platform, []) for lock_spec in lock_specs
):
key = (dep.manager, dep.name)
unique_deps[key] = dep
if unique_deps.get(key) is not None and type(unique_deps[key]) != type(dep):
raise ValueError(
f"Unsupported use of different dependency types for same package:\n{dep}\n{unique_deps[key]}"
)
unique_deps[key] = dep.merge(unique_deps.get(key)) # type: ignore
knedlsepp marked this conversation as resolved.
Show resolved Hide resolved

dependencies[platform] = list(unique_deps.values())

Expand Down
117 changes: 109 additions & 8 deletions tests/test_conda_lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1625,22 +1625,123 @@ def test_aggregate_lock_specs():
assert actual.content_hash() == expected.content_hash()


def test_aggregate_lock_specs_override_version():
base_spec = LockSpecification(
dependencies={"linux-64": [_make_spec("package", "=1.0")]},
def test_aggregate_lock_specs_combine_version():
first_spec = LockSpecification(
dependencies={"linux-64": [_make_spec("package", ">1.0")]},
channels=[Channel.from_string("conda-forge")],
sources=[Path("base.yml")],
)

second_spec = LockSpecification(
dependencies={"linux-64": [_make_spec("package", "<2.0")]},
channels=[Channel.from_string("internal"), Channel.from_string("conda-forge")],
sources=[Path("additional.yml")],
)

result_spec = LockSpecification(
dependencies={"linux-64": [_make_spec("package", "<2.0,>1.0")]},
channels=[Channel.from_string("internal"), Channel.from_string("conda-forge")],
sources=[Path("result.yml")],
)

agg_spec = aggregate_lock_specs([first_spec, second_spec], platforms=["linux-64"])

assert agg_spec.dependencies == result_spec.dependencies


def test_aggregate_lock_specs_combine_build():
first_spec = LockSpecification(
dependencies={
"linux-64": [
VersionedDependency(name="openblas", version="*", build="openmp*"),
VersionedDependency(
name="_openmp_mutex", version="4.5", build="*_llvm"
),
]
},
channels=[Channel.from_string("conda-forge")],
sources=[Path("base.yml")],
)

override_spec = LockSpecification(
dependencies={"linux-64": [_make_spec("package", "=2.0")]},
second_spec = LockSpecification(
dependencies={
"linux-64": [
VersionedDependency(
name="openblas", version="0.3.20", build="openmp_h53a8fd6_1"
),
VersionedDependency(
name="_openmp_mutex", version="4.5", build="2_kmp_llvm"
),
]
},
channels=[Channel.from_string("internal"), Channel.from_string("conda-forge")],
sources=[Path("second.yml")],
)

third_spec = LockSpecification(
dependencies={
"linux-64": [
VersionedDependency(
name="openblas", version="*", build="openmp_h53a8fd6_1"
),
VersionedDependency(
name="_openmp_mutex", version="4.5", build="*_kmp_llvm"
),
]
},
channels=[Channel.from_string("internal"), Channel.from_string("conda-forge")],
sources=[Path("third.yml")],
)

result_spec = LockSpecification(
dependencies={
"linux-64": [
VersionedDependency(
name="openblas", version="0.3.20", build="openmp_h53a8fd6_1"
),
VersionedDependency(
name="_openmp_mutex", version="4.5", build="2_kmp_llvm"
),
]
},
channels=[Channel.from_string("internal"), Channel.from_string("conda-forge")],
sources=[Path("override.yml")],
sources=[Path("result.yml")],
)

agg_spec = aggregate_lock_specs(
[first_spec, second_spec, third_spec], platforms=["linux-64"]
)

assert agg_spec.dependencies == result_spec.dependencies


def test_aggregate_lock_specs_combine_build_incompatible():
first_spec = LockSpecification(
dependencies={
"linux-64": [
VersionedDependency(
name="openblas", version="0.3.20", build="openmp_h53a8fd6_2"
),
]
},
channels=[Channel.from_string("conda-forge")],
sources=[Path("base.yml")],
)

agg_spec = aggregate_lock_specs([base_spec, override_spec], platforms=["linux-64"])
second_spec = LockSpecification(
dependencies={
"linux-64": [
VersionedDependency(
name="openblas", version="0.3.20", build="openmp_h53a8fd6_1"
),
]
},
channels=[Channel.from_string("internal"), Channel.from_string("conda-forge")],
sources=[Path("second.yml")],
)

assert agg_spec.dependencies == override_spec.dependencies
with pytest.raises(ValueError):
aggregate_lock_specs([first_spec, second_spec], platforms=["linux-64"])


def test_aggregate_lock_specs_invalid_channels():
Expand Down