Version ranges

Version range expressions are supported, both in conanfile.txt and in conanfile.py requirements.

The syntax uses brackets. The square brackets are the way to inform Conan that is a version range. Otherwise, versions are plain strings. They can be whatever you want them to be (up to limitations of length and allowed characters).

class HelloConan(ConanFile):
   requires = "pkg/[>1.0 <1.8]@user/stable"

So when specifying pkg/[expression]@user/stable, it means that expression will be evaluated as a version range. Otherwise, it will be understood as plain text, so requires = "pkg/version@user/stable" always means to use the version version literally.

There are some packages that do not follow semver. A popular one would be the OpenSSL package with versions as 1.0.2n. They cannot be used with version-ranges. To require such packages you always have to use explicit versions (without brackets).

The process to manage plain versions vs version-ranges is also different. The second one requires a “search” in the remote, which is orders of magnitude slower than direct retrieval of the reference (plain versions). Take it into account if you plan to use it for very large projects.

Expressions are those defined and implemented by https://pypi.org/project/node-semver/. Accepted expressions would be:

[>1.1 <2.1]                # In such range
[2.8]                      # equivalent to =2.8
[~3.0]                     # compatible, according to semver
[>1.1 || 0.8]              # conditions can be OR'ed
[1.2.7 || >=1.2.9 <2.0.0]  # This range would match the versions 1.2.7, 1.2.9, and 1.4.6, but not the versions 1.2.8 or 2.0.0.

There are two options for the version range:

  • loose=True|False (default True): When using loose=False only valid Semantic Versioning strings are accepted.

  • include_prerelease=True|False (default False): If set to include_prerelease=True, Conan will include prerelease versions in the search range. Take into account that prerelease versions have lower precedence than the associated normal one (e.g.: 1.0.0 > 1.0.0-beta).

[>1.1 <2.1, include_prerelease=True]            # Would e.g. accept "2.0.0-pre.1" as match
[~1.2.3, loose=False]                           # Would only accept correct Semantic Versioning strings.
                                                # E.g. version "1.2.3.4" would not be accepted.
[~1.2.3, loose=False, include_prerelease=True]  # Both options can be used for the same version range.

Version range expressions are evaluated at the time of building the dependency graph, from downstream to upstream dependencies. No joint-compatibility of the full graph is computed. Instead, version ranges are evaluated when dependencies are first retrieved.

This means, that if a package A depends on another package B (A->B), and A has a requirement for C/[>1.2 <1.8], this requirement is evaluated first and it can lead to get the version C/1.7. If package B has the requirement to C/[>1.3 <1.6], this one will be overwritten by the downstream one, it will output a version incompatibility error. But the “joint” compatibility of the graph will not be obtained. Downstream packages or consumer projects can impose their own requirements to comply with upstream constraints. In this case a override dependency to C/[>1.3 <1.6] can be easily defined in the downstream package or project.

The order of search for matching versions is as follows:

  • First, the local conan storage is searched for matching versions, unless the --update flag is provided to conan install.

  • If a matching version is found, it is used in the dependency graph as a solution.

  • If no matching version is locally found, it starts to search in the remotes, in order. If some remote is specified with -r=remote, then only that remote will be used.

  • If the --update parameter is used, then the existing packages in the local conan cache will not be used, and the same search of the previous steps is carried out in the remotes. If new matching versions are found, they will be retrieved, so subsequent calls to install will find them locally and use them.

Note

Version ranges are not used in generating package_id those are always determined by the resolved graph.