List classes

class PackagesList

A collection of recipes, revisions and packages.

split()

Returns a list of PackageList, splitted one per reference. This can be useful to parallelize things like upload, parallelizing per-reference

only_recipes() → None

Filter out all the packages and package revisions, keep only the recipes and recipe revisions in self.recipes.

serialize()

Serialize the instance to a dictionary.

static deserialize(data)

Loads the data from a serialized dictionary.

class MultiPackagesList

A collection of PackagesList by remote name.

serialize()

Serialize object to a dictionary.

static load(file)

Create an instance of the class from a serialized JSON file path pointed by file.

static load_graph(graphfile, graph_recipes=None, graph_binaries=None, context=None)

Create an instance of the class from a graph file path, which is the json format returned by a few commands like conan graph info or conan create/install.

Parameters:

  • graphfile (str) – Path to the graph file

  • graph_recipes (list[str]) – List for kinds of recipes to return. For example "cache" will return only recipes in the local cache, "download" will return only recipes that have been downloaded, and passing "*" will return all recipes.

  • graph_binaries (list[str]) – List for kinds of binaries to return. For example "cache" will return only binaries in the local cache, "download" will return only binaries that have been downloaded, "build" will return only binaries that are built, "missing" will return only binaries that are missing, "invalid" will return only binaries that are invalid, and passing "*" will return all binaries.

  • context (str) – Context to filter the graph, can be "host", "build", "host-only" or "build-only"

class ListPattern(expression, rrev='latest', package_id=None, prev='latest', only_recipe=False)

Object holding a pattern that matches recipes, revisions and packages.

Parameters:

  • expression – The pattern to match, e.g. "name/*:*"

  • rrev – The recipe revision to match, defaults to "latest", can also be "!latest" or "~latest" to match all but the latest revision, a pattern like "1234*" to match a specific revision, or a specific revision like "1234".

  • package_id – The package ID to match, defaults to None, which matches all package IDs.

  • prev – The package revision to match, defaults to "latest", can also be "!latest" or "~latest" to match all but the latest revision, a pattern like "1234*" to match a specific revision, or a specific revision like "1234".

  • only_recipe – If True, only the recipe part of the expression is parsed, ignoring package_id and prev. This is useful for commands that only operate on recipes, like conan search.