Modulemd.ModuleStreamV1

Subclasses:

None

Methods

Inherited:

Modulemd.ModuleStream (21), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (module_name, module_stream)
	add_buildtime_requirement (module_name, module_stream)
	add_component (component)
	add_content_license (license)
	add_module_license (license)
	add_profile (profile)
	add_rpm_api (rpm)
	add_rpm_artifact (nevr)
	add_rpm_filter (rpm)
	add_runtime_requirement (module_name, module_stream)
	add_servicelevel (servicelevel)
	clear_buildtime_requirements ()
	clear_content_licenses ()
	clear_module_components ()
	clear_module_licenses ()
	clear_profiles ()
	clear_rpm_api ()
	clear_rpm_artifacts ()
	clear_rpm_components ()
	clear_rpm_filters ()
	clear_runtime_requirements ()
	clear_servicelevels ()
	get_arch ()
	get_buildopts ()
	get_buildtime_modules ()
	get_buildtime_requirement_stream (module_name)
	get_community ()
	get_content_licenses ()
	get_description (locale)
	get_documentation ()
	get_eol ()
	get_module_component (component_name)
	get_module_component_names ()
	get_module_licenses ()
	get_profile (profile_name)
	get_profile_names ()
	get_rpm_api ()
	get_rpm_artifacts ()
	get_rpm_component (component_name)
	get_rpm_component_names ()
	get_rpm_filters ()
	get_runtime_modules ()
	get_runtime_requirement_stream (module_name)
	get_servicelevel (servicelevel_name)
	get_servicelevel_names ()
	get_summary (locale)
	get_tracker ()
	get_xmd ()
	remove_buildtime_requirement (module_name)
	remove_content_license (license)
	remove_module_component (component_name)
	remove_module_license (license)
	remove_rpm_api (rpm)
	remove_rpm_artifact (nevr)
	remove_rpm_component (component_name)
	remove_rpm_filter (rpm)
	remove_runtime_requirement (module_name)
	set_arch (arch)
	set_buildopts (buildopts)
	set_community (community)
	set_description (description)
	set_documentation (documentation)
	set_eol (eol)
	set_summary (summary)
	set_tracker (tracker)
	set_xmd (xmd)

Virtual Methods

Inherited:

Modulemd.ModuleStream (6), GObject.Object (7)

Properties

Inherited:

Modulemd.ModuleStream (6)

Name	Type	Flags	Short Description
buildopts	Modulemd.Buildopts	r/w	Build options for module components
community	str	r/w/c	The website address of the upstream community for this module
documentation	str	r/w/c	The website address of the upstream documentation for this module
tracker	str	r/w/c	The website address of the upstream bug tracker for this module

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Modulemd.ModuleStreamV1(**kwargs)

Bases:

Modulemd.ModuleStream

Abstract:

No

Structure:

Modulemd.ModuleStreamV1Class

classmethod new(module_name, module_stream)

Parameters:

• module_name (str or None) – The name of this module.

• module_stream (str or None) – The name of this module stream.

Returns:

A newly-allocated Modulemd.ModuleStreamV1 object, with the specified module and stream names, if provided.

Return type:

Modulemd.ModuleStreamV1

Added in version 2.0.

add_buildtime_requirement(module_name, module_stream)

Parameters:

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

• module_stream (str) – The name of the module stream to depend on.

Add a build-time dependency for this module.

Added in version 2.0.

add_component(component)

Parameters:

component (Modulemd.Component) – A Modulemd.Component to be added to this module stream.

Add a component definition to the module.

Added in version 2.0.

add_content_license(license)

Parameters:

license (str) – A license under which one or more of the components of this module stream are distributed.

Added in version 2.0.

add_module_license(license)

Parameters:

license (str) – A license under which this module stream is distributed.

Added in version 2.0.

add_profile(profile)

Parameters:

profile (Modulemd.Profile) – A Modulemd.Profile for this module stream.

Adds a profile definition to this module stream.

Added in version 2.0.

add_rpm_api(rpm)

Parameters:

rpm (str) – The name of a binary RPM present in this module that is considered stable public API.

Added in version 2.0.

add_rpm_artifact(nevr)

Parameters:

nevr (str) – The NEVR of a binary RPM present in this module stream.

Added in version 2.0.

add_rpm_filter(rpm)

Parameters:

rpm (str) – The name of a binary RPM to filter out of this module stream.

Added in version 2.0.

add_runtime_requirement(module_name, module_stream)

Parameters:

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

• module_stream (str) – The name of the module stream to depend on.

Add a runtime dependency for this module.

Added in version 2.0.

add_servicelevel(servicelevel)

Parameters:

servicelevel (Modulemd.ServiceLevel) – A Modulemd.ServiceLevel for this module stream.

Adds a servicelevel definition to this module stream.

Added in version 2.0.

clear_buildtime_requirements()

Remove all buildtime dependencies for this module.

Added in version 2.5.

clear_content_licenses()

Remove all content licenses.

Added in version 2.5.

clear_module_components()

Remove all module components from this module stream.

Added in version 2.5.

clear_module_licenses()

Remove all module licenses.

Added in version 2.5.

clear_profiles()

Remove all profiles from this module stream.

Added in version 2.0.

clear_rpm_api()

Remove all RPMs from the list of stable public API.

Added in version 2.5.

clear_rpm_artifacts()

Remove all RPM NEVRs from the list of artifacts.

Added in version 2.5.

clear_rpm_components()

Remove all RPM components from this module stream.

Added in version 2.5.

clear_rpm_filters()

Remove all RPMs from the filter list.

Added in version 2.5.

clear_runtime_requirements()

Remove all runtime dependencies for this module.

Added in version 2.5.

clear_servicelevels()

Remove all servicelevels from this module stream.

Added in version 2.0.

get_arch()

Returns:

The module artifact architecture.

Return type:

str

Added in version 2.0.

get_buildopts()

Returns:

The build options for this module’s components.

Return type:

Modulemd.Buildopts

Added in version 2.0.

get_buildtime_modules()

Returns:

An ordered #GStrv list of module names that this module depends on at build-time.

Return type:

[str]

Added in version 2.0.

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

Added in version 2.0.

get_community()

Returns:

The module community website address.

Return type:

str

Added in version 2.0.

get_content_licenses()

Returns:

An ordered #GStrv list of licenses under which one or more components of this module stream are released.

Return type:

[str]

Added in version 2.0.

get_description(locale)

Parameters:

locale (str or None) – The name of the locale to use when translating the string. If None, it will determine the locale with a system call to setlocale(LC_MESSAGES, NULL) and return that. If the caller wants the untranslated string, they should pass "C" for the locale.

Returns:

The module description, translated to the requested locale if available. Translation information is managed by the Modulemd.Translation and Modulemd.TranslationEntry objects.

Return type:

str

Added in version 2.0.

get_documentation()

Returns:

The module documentation website address.

Return type:

str

Added in version 2.0.

get_eol()

Returns:

The end-of-life date for the “rawhide” service level.

Return type:

GLib.Date

Compatibility function with early iterations of modulemd v1. This function is a wrapper for modulemd_module_stream_v1_get_servicelevel("rawhide").

Added in version 2.0.

Deprecated since version 2.0: Use Modulemd.ModuleStreamV1.get_servicelevel() instead.

get_module_component(component_name)

Parameters:

component_name (str) – The name of the component to retrieve.

Returns:

The module component matching component_name if it exists, else None.

Return type:

Modulemd.ComponentModule

Added in version 2.0.

get_module_component_names()

Returns:

An ordered #GStrv list of module component names included in this stream.

Return type:

[str]

Added in version 2.0.

get_module_licenses()

Returns:

An ordered #GStrv list of licenses under which this module stream is released.

Return type:

[str]

Added in version 2.0.

get_profile(profile_name)

Parameters:

profile_name (str) – The name of a profile to retrieve.

Returns:

The requested profile definition if present in the module stream. None otherwise.

Return type:

Modulemd.Profile

Added in version 2.0.

get_profile_names()

Returns:

An ordered #GStrv list of profile names associated with this module stream.

Return type:

[str]

Added in version 2.0.

get_rpm_api()

Returns:

An ordered #GStrv list of binary RPM names that forms the public API of this module stream.

Return type:

[str]

Added in version 2.0.

get_rpm_artifacts()

Returns:

An ordered #GStrv list of RPM NEVRs are included in this module stream.

Return type:

[str]

Added in version 2.0.

get_rpm_component(component_name)

Parameters:

component_name (str) – The name of the component to retrieve.

Returns:

The RPM component matching component_name if it exists, else None.

Return type:

Modulemd.ComponentRpm

Added in version 2.0.

get_rpm_component_names()

Returns:

An ordered #GStrv list of RPM component names included in this stream.

Return type:

[str]

Added in version 2.0.

get_rpm_filters()

Returns:

An ordered #GStrv list of binary RPM names that are filtered out of this module stream.

Return type:

[str]

Added in version 2.0.

get_runtime_modules()

Returns:

An ordered #GStrv list of module names that this module depends on at runtime.

Return type:

[str]

Added in version 2.0.

get_runtime_requirement_stream(module_name)

Parameters:

module_name (str)

Return type:

str

get_servicelevel(servicelevel_name)

Parameters:

servicelevel_name (str) – The name of a servicelevel to retrieve.

Returns:

The requested servicelevel definition if present in the module stream. None otherwise.

Return type:

Modulemd.ServiceLevel

Added in version 2.0.

get_servicelevel_names()

Returns:

An ordered #GStrv list of servicelevel names associated with this module stream.

Return type:

[str]

Added in version 2.0.

get_summary(locale)

Parameters:

locale (str or None) – The name of the locale to use when translating the string. If None, it will determine the locale with a system call to setlocale(LC_MESSAGES, NULL) and return that. If the caller wants the untranslated string, they should pass "C" for the locale.

Returns:

The module summary, translated to the requested locale if available. Translation information is managed by the Modulemd.Translation and Modulemd.TranslationEntry objects.

Return type:

str

Added in version 2.0.

get_tracker()

Returns:

The module bug tracker website address.

Return type:

str

Added in version 2.0.

get_xmd()

Returns:

The extensible metadata block as a GLib.Variant.

Return type:

GLib.Variant

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.

Added in version 2.0.

remove_content_license(license)

Parameters:

license (str) – A license to remove from the list. Has no effect if the license is not present.

Added in version 2.0.

remove_module_component(component_name)

Parameters:

component_name (str) – The name of the component to remove from the module stream.

Remove a component from this module stream.

Added in version 2.0.

remove_module_license(license)

Parameters:

license (str) – A license to remove from the list. Has no effect if the license is not present.

Added in version 2.0.

remove_rpm_api(rpm)

Parameters:

rpm (str) – A binary RPM name to remove from the list of stable public API.

Added in version 2.0.

remove_rpm_artifact(nevr)

Parameters:

nevr (str) – An RPM NEVR to remove from the list of artifacts.

Added in version 2.0.

remove_rpm_component(component_name)

Parameters:

component_name (str) – The name of the component to remove from the module stream.

Remove a component from this module stream.

Added in version 2.0.

remove_rpm_filter(rpm)

Parameters:

rpm (str) – A binary RPM name to remove from the filter list.

Added in version 2.0.

remove_runtime_requirement(module_name)

Parameters:

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

Remove a runtime dependency for this module.

Added in version 2.0.

set_arch(arch)

Parameters:

arch (str) – The module artifact architecture.

Set the module artifact architecture.

Added in version 2.0.

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.

Added in version 2.0.

set_community(community)

Parameters:

community (str) – The upstream community website for this module.

Set the module community website address.

Added in version 2.0.

set_description(description)

Parameters:

description (str or None) – The untranslated description of this module.

Set the module description.

Added in version 2.0.

set_documentation(documentation)

Parameters:

documentation (str) – The upstream documentation website for this module.

Set the module documentation website address.

Added in version 2.0.

set_eol(eol)

Parameters:

eol (GLib.Date) – The end-of-life date for the “rawhide” service level.

Comptibility function with early iterations of modulemd v1. This function is a wrapper for modulemd_module_stream_v1_add_servicelevel("rawhide", eol).

Added in version 2.0.

Deprecated since version 2.0: Use Modulemd.ModuleStreamV1.add_servicelevel() instead.

set_summary(summary)

Parameters:

summary (str or None) – The untranslated summary of this module.

Set the module summary.

Added in version 2.0.

set_tracker(tracker)

Parameters:

tracker (str) – The upstream bug tracker website for this module.

Set the module bug tracker website address.

Added in version 2.0.

set_xmd(xmd)

Parameters:

xmd (GLib.Variant) – A GLib.Variant representing arbitrary YAML.

Sets the eXtensible MetaData (XMD) for this module. XMD is arbitrary YAML data that will be set and returned as-is (with the exception that the ordering of mapping keys is not defined). Useful for carrying private data.

This function assumes ownership of the XMD GLib.Variant and thus should not be freed by the caller.

Added in version 2.0.

Property Details

Modulemd.ModuleStreamV1.props.buildopts

Name:

buildopts

Type:

Modulemd.Buildopts

Default Value:

None

Flags:

READABLE, WRITABLE

Build options for module components

Modulemd.ModuleStreamV1.props.community

Name:

community

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The website address of the upstream community for this module

Modulemd.ModuleStreamV1.props.documentation

Name:

documentation

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The website address of the upstream documentation for this module

Modulemd.ModuleStreamV1.props.tracker

Name:

tracker

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The website address of the upstream bug tracker for this module