Modulemd.BuildConfig¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`add_buildtime_requirement` (module_name, stream_name)
	`add_runtime_requirement` (module_name, stream_name)
	`clear_buildtime_requirements` ()
	`clear_runtime_requirements` ()
	`compare` (self_2)
	`copy` ()
	`equals` (self_2)
	`get_buildopts` ()
	`get_buildtime_modules_as_strv` ()
	`get_buildtime_requirement_stream` (module_name)
	`get_context` ()
	`get_platform` ()
	`get_runtime_modules_as_strv` ()
	`get_runtime_requirement_stream` (module_name)
	`remove_buildtime_requirement` (module_name)
	`remove_runtime_requirement` (module_name)
	`set_buildopts` (buildopts)
	`set_context` (context)
	`set_platform` (platform)
	`validate` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Modulemd.BuildConfig(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Modulemd.BuildConfigClass

classmethod new()¶

Return type:: Modulemd.BuildConfig

Initialize a new Modulemd.BuildConfig representing a module build configuration.

New in version 2.11.

add_buildtime_requirement(module_name, stream_name)¶

Parameters:

module_name (str) – The name of the module to depend on.
stream_name (str) – The name of the module stream to depend on.

Add a build-time dependency for this module.

New in version 2.11.

add_runtime_requirement(module_name, stream_name)¶

Parameters:

module_name (str) – The name of the module to depend on.
stream_name (str) – The name of the module stream to depend on.

Add a build-time dependency for this module.

New in version 2.11.

clear_buildtime_requirements()¶: Remove all build-time dependencies for this module.

New in version 2.11.

clear_runtime_requirements()¶: Remove all run-time dependencies for this module.

New in version 2.11.

compare(self_2)¶

Parameters:: self_2 (Modulemd.BuildConfig) – A pointer to a Modulemd.BuildConfig object.
Returns:: Less than zero if self sorts less than self_2, zero for equal, greater than zero if self is greater than self_2.
Return type:: int

New in version 2.11.

copy()¶

Returns:: A deep copy of self
Return type:: Modulemd.BuildConfig

New in version 2.11.

equals(self_2)¶

Parameters:: self_2 (Modulemd.BuildConfig) – A pointer to a Modulemd.BuildConfig object.
Returns:: True, if self and self_2 are pointers to Modulemd.BuildConfig objects containing equivalent data. False, otherwise.
Return type:: bool

New in version 2.11.

get_buildopts()¶

Returns:: The build options for this module’s components.
Return type:: Modulemd.Buildopts

New in version 2.11.

get_buildtime_modules_as_strv()¶

Returns:: An ordered #GStrv list of module names that this module depends on at build-time.
Return type:: [str]

New in version 2.11.

get_buildtime_requirement_stream(module_name)¶

Parameters:: module_name (str) – The name of the module this module depends on.
Returns:: The name of the stream matching this module name in the build-time dependencies.
Return type:: str

New in version 2.11.

get_context()¶

Returns:: The string representing the context that this build configuration produces.
Return type:: str

Get the context that this build configuration produces.

Note: This function returns the context as stored internally. If you want to be sure that it is in the correct format, call Modulemd.BuildConfig.validate() first.

New in version 2.11.

get_platform()¶

Returns:: The string representing the platform that this build configuration applies to.
Return type:: str

Get the platform that this build configuration applies to.

New in version 2.11.

get_runtime_modules_as_strv()¶

Returns:: An ordered #GStrv list of module names that this module depends on at run-time.
Return type:: [str]

New in version 2.11.

get_runtime_requirement_stream(module_name)¶

Parameters:: module_name (str) – The name of the module this module depends on.
Returns:: The name of the stream matching this module name in the run-time dependencies.
Return type:: str

New in version 2.11.

remove_buildtime_requirement(module_name)¶

Parameters:: module_name (str) – The name of the module to be removed.

Remove a build-time dependency for this module.

New in version 2.11.

remove_runtime_requirement(module_name)¶

Parameters:: module_name (str) – The name of the module to be removed.

Remove a run-time dependency for this module.

New in version 2.11.

set_buildopts(buildopts)¶

Parameters:: buildopts (Modulemd.Buildopts) – A Modulemd.Buildopts object describing build options that apply globally to components in this module.

Set build options for this module’s components.

New in version 2.11.

set_context(context)¶

Parameters:: context (str) – A string of up to ten alphanumeric characters.

Set the context that this build configuration produces.

Note: For consistency in the API, this function does not validate the input context. This validation will be performed as part of the Modulemd.BuildConfig.validate() routine where it can be reported cleanly.

New in version 2.11.

set_platform(platform)¶

Parameters:: platform (str) – A string of up to ten alphanumeric characters.

Set the platform that this build configuration applies to.

New in version 2.11.

validate()¶

Raises:: GLib.Error
Returns:: True if validation passes. Returns False and sets error appropriately on validation failure.
Return type:: bool

Determine if this Modulemd.BuildConfig is valid according to the YAML specification.

New in version 2.11.