Profiles API

Warning

This feature is experimental and subject to breaking changes. See the Conan stability section for more information.

Warning

Subapis must not be initialized by themselves. They are intended to be accessed only through the main ConanAPI attributes.

class ProfilesAPI(conan_api, api_helpers)

This ProfilesAPI is used to list, manage and load Conan profiles

get_default_host()

Returns:

the path to the default “host” profile, either in the cache or as defined by the user in configuration

get_default_build()

Returns:

the path to the default “build” profile, either in the cache or as defined by the user in configuration

get_profile(profiles, settings=None, options=None, conf=None, cwd=None, context=None)

Computes a Profile as the result of aggregating all the user arguments, first it loads the “profiles”, composing them in order (last profile has priority), and finally adding the individual settings, options (priority over the profiles)

Parameters:

• profiles – the list of profiles to load

• settings – list of “key=value” settings to define the profile. Patterns allowed as “pkg-pattern:key=value”

• options – list of “key=value” options. Patterns allowed as “pkg-pattern:key=value”

• conf – list of “key=value” configurations. Following “conf” definitions, patterns are allowed as “pkg-pattern:key=value”, values that are lists or dictionaries might be allowed, and configuration operations like += for appending are allowed.

• cwd – the current working directory. If None, os.getcwd() will be used.

• context – the context, “build” or “host” to which this profile belongs

get_path(profile, cwd=None, exists=True)

Returns:

the resolved path of the given profile name, that could be in the cache, or local, depending on the “cwd”

list()

List all the profiles files in the cache

Returns:

an alphabetically ordered list of profile files in the default cache location

static detect()

Detects a possible default profile.

The output of this detection is not guaranteed to be complete or stable, it might change in future releases, following the same rules as the “conan profile detect” command.

Returns:

an automatically detected Profile, with a “best guess” of the system settings