Add CEP for MatchSpec minilanguage #82

jaimergp · 2024-06-04T14:11:17Z

Closes #80

jaimergp · 2024-06-04T14:11:57Z

I'm seeing myself referring to the "MatchSpec" interface in other CEPs yet this is not standardized, so there we go. Let's open that can of worms.

jaimergp · 2024-06-05T09:55:32Z

This will probably need another CEP on PackageRecord, which will probably ask for Repodata counterparts and... channel structure. Yay. I like how packaging.python.org does this btw. I'll probably copy some of that structure.

JeanChristopheMorinPerso · 2024-06-06T20:43:59Z

cep-??.md

+- `license`
+- `license_family`


license and license_family could be used for search packages with a specific license I guess, say with conda search '*[license="Apache-2.0"]?

Yes, true, I hadn't considered search here, only install-oriented operations. I should rephrase this part a bit to cover this aspect.

JeanChristopheMorinPerso · 2024-06-06T20:50:01Z

cep-??.md

+
+The `MatchSpec` mini language has gone through several iterations.
+
+The simplest form merely consists of up to three positional arguments: `name [version [build]]`. Only `name` is required. `version` can be any version specifier. `build` can be any string matcher. See "Match conventions" below.


Suggested change

The simplest form merely consists of up to three positional arguments: `name [version [build]]`. Only `name` is required. `version` can be any version specifier. `build` can be any string matcher. See "Match conventions" below.

The simplest form merely consists of up to three positional arguments: `name [version [build]]`. Only `name` is required. `version` can be any [version specifier](#version-specifier). `build` can be any [string matcher](#string-matching). See [Match conventions](#match-conventions) below.

Also, should we define what characters are accepted in a package name?

I feel this is going to be part of a different CEP, PackageRecord.

JeanChristopheMorinPerso · 2024-06-06T20:54:10Z

cep-??.md

+
+### Exact matches
+
+To fully-specify a package record with a full, exact spec, these fields must be given as exact values: `channel` (preferrably by URL), `subdir`, `name`, `version`, `build`. Alternatively, an exact spec can also be given by `*[md5=12345678901234567890123456789012]` or `*[sha256=f453db4ffe2271ec492a2913af4e61d4a6c118201f07de757df0eff769b65d2e]`.


When matching by checksum, should you also add the subdir? If I'm not mistaken, it's possible for two subdirs to contain a package with the same checksum right? Or is this a corner case?

These checksums are coming from the compressed artifacts, so in principle they should be unique (even with unique contents, the index.json file should have "subdir": <subdir>, I think?).

The hash that conda-build uses for the build_string doesn't consider the subdir, indeed (and maybe it should).

Just FYI, rattler does not currently support this. There we require that at least the package name is still specified.

baszalmstra

Thanks for the great write up @jaimergp !

baszalmstra · 2024-06-13T14:14:19Z

cep-??.md

+
+The simplest form merely consists of up to three positional arguments: `name [version [build]]`. Only `name` is required. `version` can be any version specifier. `build` can be any string matcher. See "Match conventions" below.
+
+The positional syntax also allows the `=` character as a separator, instead of a space. When this is the case, versions are interpreted differently. `pkg=1.8` will be taken as `1.8.*` (fuzzy), but `pkg 1.8` will give `1.8` (exact). To have fuzzy matches with the space syntax, you need to use `pkg =1.8`. This nuance does not apply if a `build` string is present; both `foo==1.0=*` and `foo=1.0=*` are equivalent (they both understand the version as `1.0`, exact).


I know this is just reporting the current state of affairs but, jucky.

In rattler, this form is no longer allowed when parsing in strict mode. (still accepted in lenient parsing mode).

baszalmstra · 2024-06-13T14:21:43Z

cep-??.md

+following conventions:
+
+- If the string begins with `^` and ends with `$`, it is converted to a regex.
+- If the string contains an asterisk (`*`), it is transformed from a glob to a regex.


Maybe I misunderstood what it means to transform a glob to a regex but *cuda is a valid build string glob right?

baszalmstra · 2024-06-13T14:24:19Z

cep-??.md

+>  < 0.960923
+>  < 1.0
+>  < 1.1dev1    # special case 'dev'
+>  < 1.1_       # appended underscore is special case for openssl-like versions


I understand this is not part of this CEP but the suffix _ notion is not present in the description above.. It is also another can of worms. 1.0- is also valid. So is 1.0__ and 1.0--...

baszalmstra · 2024-06-13T14:32:34Z

cep-??.md

+- Exact equality and negated equality: `==`, `!=`.
+- Fuzzy equality: `=`, `*`. `=1.0` and `1.0.*` are equivalent, and both would match `1.0.0` and `1.0.1`, but not `1.1` or `0.9`.
+- Logical operators: `|` means OR, `,` means AND. `1.0|1.2` would match both `1.0` and `1.2`. `>=1.0,<2.0a0` would match everything between `1.0` and the last version before `2.0a0`. `,` (AND) has higher precedence than `|` (OR). `>=1,<2|>3` means `(>=1,<2)|(>3)`; i.e. greater than or equal to `1` AND less than `2` or greater than `3`, which matches `1`, `1.3` and `3.0`, but not `2.2`.
+- Semver-like operator: `~=`. `~=0.5.3` is equivalent to `>=0.5.3, <0.6.0a` and this syntax is preferred for backwards compatibility.


This is not entirely correct, it should be ~= is equivalent to >=0.5.3, 0.5.*. This is an important distinction because both 0.6.0_ and 0.6.0dev are considered smaller than 0.6.0a so they both would still match >=0.5.3, <0.6.0a!

baszalmstra · 2024-06-13T14:34:35Z

cep-??.md

+
+### Exact matches
+
+To fully-specify a package record with a full, exact spec, these fields must be given as exact values: `channel` (preferrably by URL), `subdir`, `name`, `version`, `build`. Alternatively, an exact spec can also be given by `*[md5=12345678901234567890123456789012]` or `*[sha256=f453db4ffe2271ec492a2913af4e61d4a6c118201f07de757df0eff769b65d2e]`.


Just FYI, rattler does not currently support this. There we require that at least the package name is still specified.

baszalmstra · 2024-06-13T14:36:45Z

cep-??.md

+
+## Reference
+
+- [`conda.models.match_spec.MatchSpec`](https://github.com/conda/conda/blob/24.5.0/conda/models/match_spec.py)


Just FYI this is the rattler implementation: https://github.com/mamba-org/rattler/blob/main/crates/rattler_conda_types/src/match_spec/mod.rs

Add CEP for MatchSpec minilanguage

f392cb6

jaimergp mentioned this pull request Jun 4, 2024

CEP request: Document MatchSpec #80

Open

2 tasks

JeanChristopheMorinPerso reviewed Jun 6, 2024

View reviewed changes

jaimergp mentioned this pull request Jun 7, 2024

Discrepancy creating a MatchSpec from package strings (sometimes "==" gets stripped) conda/conda#13932

Open

2 tasks

baszalmstra reviewed Jun 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CEP for MatchSpec minilanguage #82

Add CEP for MatchSpec minilanguage #82

jaimergp commented Jun 4, 2024 •

edited

Loading

jaimergp commented Jun 4, 2024

jaimergp commented Jun 5, 2024

JeanChristopheMorinPerso Jun 6, 2024

jaimergp Jun 7, 2024

JeanChristopheMorinPerso Jun 6, 2024

jaimergp Jun 7, 2024

JeanChristopheMorinPerso Jun 6, 2024

jaimergp Jun 7, 2024

baszalmstra Jun 13, 2024

baszalmstra left a comment

baszalmstra Jun 13, 2024

baszalmstra Jun 13, 2024

baszalmstra Jun 13, 2024

baszalmstra Jun 13, 2024

baszalmstra Jun 13, 2024

baszalmstra Jun 13, 2024


		The `MatchSpec` mini language has gone through several iterations.

		The simplest form merely consists of up to three positional arguments: `name [version [build]]`. Only `name` is required. `version` can be any version specifier. `build` can be any string matcher. See "Match conventions" below.


		### Exact matches

		To fully-specify a package record with a full, exact spec, these fields must be given as exact values: `channel` (preferrably by URL), `subdir`, `name`, `version`, `build`. Alternatively, an exact spec can also be given by `[md5=12345678901234567890123456789012]` or `[sha256=f453db4ffe2271ec492a2913af4e61d4a6c118201f07de757df0eff769b65d2e]`.


		The simplest form merely consists of up to three positional arguments: `name [version [build]]`. Only `name` is required. `version` can be any version specifier. `build` can be any string matcher. See "Match conventions" below.

		The positional syntax also allows the `=` character as a separator, instead of a space. When this is the case, versions are interpreted differently. `pkg=1.8` will be taken as `1.8.` (fuzzy), but `pkg 1.8` will give `1.8` (exact). To have fuzzy matches with the space syntax, you need to use `pkg =1.8`. This nuance does not apply if a `build` string is present; both `foo==1.0=` and `foo=1.0=*` are equivalent (they both understand the version as `1.0`, exact).


		## Reference

		- [`conda.models.match_spec.MatchSpec`](https://github.com/conda/conda/blob/24.5.0/conda/models/match_spec.py)

Add CEP for MatchSpec minilanguage #82

Are you sure you want to change the base?

Add CEP for MatchSpec minilanguage #82

Conversation

jaimergp commented Jun 4, 2024 • edited Loading

jaimergp commented Jun 4, 2024

jaimergp commented Jun 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

baszalmstra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaimergp commented Jun 4, 2024 •

edited

Loading