Modulemd.PackagerV3

g GObject.Object GObject.Object Modulemd.PackagerV3 Modulemd.PackagerV3 GObject.Object->Modulemd.PackagerV3

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

add_build_config (buildconfig)

add_component (component)

add_demodularized_rpm (rpm)

add_module_license (license)

add_profile (profile)

add_rpm_api (rpm)

add_rpm_filter (rpm)

clear_build_configs ()

clear_demodularized_rpms ()

clear_module_components ()

clear_module_licenses ()

clear_profiles ()

clear_rpm_api ()

clear_rpm_components ()

clear_rpm_filters ()

convert_to_index ()

copy ()

get_build_config (context)

get_build_config_contexts_as_strv ()

get_community ()

get_demodularized_rpms ()

get_description ()

get_documentation ()

get_mdversion ()

get_module_component (component_name)

get_module_component_names ()

get_module_licenses_as_strv ()

get_module_name ()

get_profile (profile_name)

get_profile_names_as_strv ()

get_rpm_api_as_strv ()

get_rpm_component (component_name)

get_rpm_component_names ()

get_rpm_filters_as_strv ()

get_stream_name ()

get_summary ()

get_tracker ()

get_xmd ()

remove_demodularized_rpm (rpm)

remove_module_component (component_name)

remove_module_license (license)

remove_rpm_api (rpm)

remove_rpm_component (component_name)

remove_rpm_filter (rpm)

replace_demodularized_rpms (set)

replace_rpm_api (set)

replace_rpm_filters (set)

set_community (community)

set_description (description)

set_documentation (documentation)

set_module_name (module_name)

set_stream_name (stream_name)

set_summary (summary)

set_tracker (tracker)

set_xmd (xmd)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Modulemd.PackagerV3(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Modulemd.PackagerV3Class

classmethod new()
Returns:

A newly-allocated Modulemd.PackagerV3 object. This object must be freed with GObject.Object.unref().

Return type:

Modulemd.PackagerV3

Added in version 2.11.

add_build_config(buildconfig)
Parameters:

buildconfig (Modulemd.BuildConfig) – A Modulemd.BuildConfig to include.

Added in version 2.11.

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.11.

add_demodularized_rpm(rpm)
Parameters:

rpm (str) – A name of a binary RPM package to become non-modular.

Add a binary package name to a list of demodularized packages.

Added in version 2.13.

add_module_license(license)
Parameters:

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

Added in version 2.11.

add_profile(profile)
Parameters:

profile (Modulemd.Profile) – The new Modulemd.Profile to add.

Adds a Modulemd.Profile to this Modulemd.PackagerV3 object.

Added in version 2.11.

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.11.

add_rpm_filter(rpm)
Parameters:

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

Added in version 2.11.

clear_build_configs()

Remove all added Modulemd.BuildConfig objects from self

Added in version 2.11.

clear_demodularized_rpms()

Remove all RPM packages from a demodularized list of the object.

Added in version 2.13.

clear_module_components()

Remove all module components from this module stream.

Added in version 2.11.

clear_module_licenses()

Remove all module licenses from self

Added in version 2.11.

clear_profiles()

Removes all Modulemd.Profile objects from this Modulemd.PackagerV3 object.

Added in version 2.11.

clear_rpm_api()

Remove all RPMs from the list of stable public API.

Added in version 2.11.

clear_rpm_components()

Remove all RPM components from this module stream.

Added in version 2.11.

clear_rpm_filters()

Remove all RPMs from the filter list.

Added in version 2.11.

convert_to_index()
Raises:

GLib.Error

Returns:

A newly-allocated Modulemd.ModuleIndex object containing a set of one or more Modulemd.ModuleStreamV2 objects and possibly a Modulemd.Defaults object corresponding to the Modulemd.PackagerV3 object self. None if there was an error doing the mapping and sets error appropriately. One of the errors is missing a module name or a stream name if a default profile is present.

Return type:

Modulemd.ModuleIndex

Added in version 2.11.

copy()
Returns:

A newly-allocated deep-copy of this Modulemd.PackagerV3 object. This object must be freed with GObject.Object.unref().

Return type:

Modulemd.PackagerV3

Added in version 2.11.

get_build_config(context)
Parameters:

context (str) – The context of the Modulemd.BuildConfig to retrieve from self.

Returns:

A Modulemd.BuildConfig with the provided context or None if it was not present.

Return type:

Modulemd.BuildConfig

Added in version 2.11.

get_build_config_contexts_as_strv()
Returns:

A list of contexts associated with the build configurations.

Return type:

[str]

Added in version 2.11.

get_community()
Returns:

The module community website address.

Return type:

str

Added in version 2.11.

get_demodularized_rpms()
Returns:

An ordered #GStrv list of binary RPM package names that became non-modular.

Return type:

[str]

Added in version 2.13.

get_description()
Returns:

The long description of the module.

Return type:

str

Added in version 2.11.

get_documentation()
Returns:

The module documentation website address.

Return type:

str

Added in version 2.11.

get_mdversion()
Returns:

The metadata version of this Modulemd.PackagerV3.

Return type:

int

Added in version 2.11.

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.11.

get_module_component_names()
Returns:

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

Return type:

[str]

Added in version 2.11.

get_module_licenses_as_strv()
Returns:

A #GStrv of module licenses associated with this module stream.

Return type:

[str]

Added in version 2.11.

get_module_name()
Returns:

The module name.

Return type:

str

Added in version 2.11.

get_profile(profile_name)
Parameters:

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

Returns:

The requested profile definition if present in the Modulemd.PackagerV3 object. None otherwise.

Return type:

Modulemd.Profile

Added in version 2.11.

get_profile_names_as_strv()
Returns:

An ordered #GStrv list of profile names associated with this Modulemd.PackagerV3 object.

Return type:

[str]

Added in version 2.11.

get_rpm_api_as_strv()
Returns:

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

Return type:

[str]

Added in version 2.11.

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.11.

get_rpm_component_names()
Returns:

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

Return type:

[str]

Added in version 2.11.

get_rpm_filters_as_strv()
Returns:

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

Return type:

[str]

Added in version 2.11.

get_stream_name()
Returns:

The module stream name.

Return type:

str

Added in version 2.11.

get_summary()
Returns:

The short description of the module.

Return type:

str

Added in version 2.11.

get_tracker()
Returns:

The module bug tracker website address.

Return type:

str

Added in version 2.11.

get_xmd()
Returns:

The extensible metadata block as a GLib.Variant.

Return type:

GLib.Variant

Added in version 2.11.

remove_demodularized_rpm(rpm)
Parameters:

rpm (str) – A binary RPM package name to remove from a demodularized list.

Remove a binary package name from a list of demodularized packages.

Added in version 2.13.

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.11.

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.11.

remove_rpm_api(rpm)
Parameters:

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

Added in version 2.11.

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.11.

remove_rpm_filter(rpm)
Parameters:

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

Added in version 2.11.

replace_demodularized_rpms(set)
Parameters:

set ({object: object}) – A GLib.HashTable set of names of binary RPM packages to demodularize.

Any existing demodularized binary RPM package names associated with module stream self are removed and replaced by set.

Added in version 2.13.

replace_rpm_api(set)
Parameters:

set ({object: object}) – A GLib.HashTable set of binary RPMs present in this module stream that is considered stable public API.

Any existing API RPMs associated with module stream self are removed and replaced by set.

Added in version 2.11.

replace_rpm_filters(set)
Parameters:

set ({object: object}) – A GLib.HashTable set of names of binary RPMs to filter out of this module stream.

Any existing filtered binary RPM names associated with module stream self are removed and replaced by set.

Added in version 2.11.

set_community(community)
Parameters:

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

Set the module community website address.

Added in version 2.11.

set_description(description)
Parameters:

description (str or None) – A complete description of the module.

Sets the module’s long description.

Added in version 2.11.

set_documentation(documentation)
Parameters:

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

Set the module documentation website address.

Added in version 2.11.

set_module_name(module_name)
Parameters:

module_name (str) – The name of the module.

Sets the module name that this Modulemd.PackagerV3 object references.

Added in version 2.11.

set_stream_name(stream_name)
Parameters:

stream_name (str) – The name of the module.

Sets the stream name that this Modulemd.PackagerV3 object references.

Added in version 2.11.

set_summary(summary)
Parameters:

summary (str or None) – A short description of the module.

Sets the module’s short description.

Added in version 2.11.

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.11.

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.11.