Specfile module

class rebasehelper.specfile.BaseSpecHook

Base class for a spec hook

classmethod get_categories()

Returns list of categories of a spec hook

classmethod get_name()

Returns the name of a spec hook

classmethod run(spec_file, rebase_spec_file, **kwargs)

Runs a spec hook.

Parameters:

• spec_file – Original spec file object
• rebase_spec_file – Rebased spec file object
• kwargs – Keyword arguments from Application instance

class rebasehelper.specfile.PatchList

class rebasehelper.specfile.PatchObject(path, index, option)

Class represents set of information about patches

get_index()

get_option()

get_patch_name()

get_path()

git_generated = ''

index = ''

option = ''

path = ''

set_path(new_path)

class rebasehelper.specfile.SpecFile(path, changelog_entry, sources_location='', download=True)

Class representing a SPEC file

category = None

static construct_string_with_comment(lines)

Wraps the line in a rebase-helper specific comments

Parameters:lines – line (or list of lines) to be wrapped Returns:list with lines

copy(new_path=None)

Create a copy of the current object and copy the SPEC file the new object represents to a new location.

Parameters:new_path – new path to which to copy the SPEC file Returns:copy of the current object

defined_sections = ['%package', '%description', '%prep', '%build', '%install', '%check', '%files', '%changelog']

download = False

download_remote_sources()

Method that iterates over all sources and downloads ones, which contain URL instead of just a file.

Returns:None

extra_version = None

static extract_version_from_archive_name(archive_path, source_string='')

Method extracts the version from archive name based on the source string from SPEC file. It extracts also an extra version such as ‘b1’, ‘rc1’, …

Parameters:

• archive_path – archive name or path with archive name from which to extract the version
• source_string – Source string from SPEC file used to construct version extraction regex

Returns:

tuple of strings with (extracted version, extra version) or (None, None) if extraction failed

find_archive_target_in_prep(archive)

Tries to find a command that is used to extract the specified archive and attempts to determine target path from it. ‘tar’ and ‘unzip’ commands are supported so far.

Parameters:archive – Path to archive Returns:Target path relative to builddir or None if not determined

get_applied_patches()

Method returns list of all applied patches.

Returns:list of PatchObject

get_archive()

Method returns the basename of first Source in SPEC file a.k.a. Source0

Returns:basename of first Source in SPEC file Return type:str

get_epoch_number()

Method for getting epoch of the package

Returns:

get_extra_version()

Returns an extra version of the package - like b1, rc2, …

Returns:String

get_extra_version_separator()

Returns the separator between version and extra version as used by upstream. If there is not separator or extra version, it returns an empty string.

Returns:String with the separator between version as extra version as used by upstream. Return type:str

get_full_version()

Returns the full version string, which is a combination of version, separator and extra version.

Returns:String with full version, including the extra version part. Return type:str

get_new_log()

get_not_used_patches()

Method returns list of all unpplied patches.

Returns:list of PatchObject

get_package_name()

Function returns a package name

Returns:

get_patch_option(line)

Function returns a patch options

Parameters:line – Returns:patch options like -p1

get_patches()

Method returns list of all applied and not applied patches

Returns:list of PatchObject

get_path()

Return only spec file path

Returns:

static get_paths_with_rpm_macros(files)

Method modifies paths in passed list to use RPM macros

Parameters:files – list of absolute paths Returns:modified list of paths with RPM macros

get_prep_section(complete=False)

Function returns whole prep section

get_release()

Method for getting full release string of the package

Returns:

get_release_number()

Method for getting the release of the package

Returns:

get_requires()

Function returns a package requirements

Returns:

get_setup_dirname()

Get dirname from %setup or %autosetup macro arguments

Returns:dirname

get_sources()

Method returns dictionary with local sources list.

Returns:list of Sources with absolute path Return type:list of str

get_spec_section(section_name)

Returns the section of selected name

Parameters:section_name – section name to get Returns:list of lines contained in the selected section

get_version()

Method returns the version

Returns:

hdr = None

insert_changelog(new_log)

is_test_suite_enabled()

Returns whether test suite is enabled during the build time

Returns:True if enabled or False if not

modify_spec_files_section(files)

Function repairs spec file according to new sources.

Parameters:files – Returns:

patches = None

path = ''

prep_section = []

redefine_release_with_macro(macro)

Method redefines the Release: line to include passed macro and comments out the old line

Parameters:macro – Returns:

removed_patches = []

revert_redefine_release_with_macro(macro)

Method removes the redefined the Release: line with given macro and uncomments the old Release line.

Parameters:macro – Returns:

rpm_sections = {}

save()

Save changes made to the spec_content to the disc and update internal variables

set_extra_version(extra_version)

Method to update the extra version in the SPEC file. Redefined Source0 if needed and also changes Release accordingly.

Parameters:extra_version – the extra version string, if any (e.g. ‘b1’, ‘rc2’, …) Returns:None

set_extra_version_separator(separator)

Set the string that separates the version and extra version

Parameters:separator – Returns:

set_release_number(release)

Method to set release number

Parameters:release – Returns:

set_spec_section(section_name, new_section)

Returns the section of selected name

Parameters:section_name – section name to get Returns:list of lines contained in the selected section

set_tag(tag, value, preserve_macros=False)

Sets value of a tag while trying to preserve macros if requested

set_version(version)

Method to update the version in the SPEC file

Parameters:version – string with new version Returns:None

set_version_using_archive(archive_path)

Method to update the version in the SPEC file using a archive path. The version is extracted from the archive name.

Parameters:archive_path – Returns:

sources = None

spc = None

spec_content = []

static split_version_string(version_string='')

Method splits version string into version and possibly extra string as ‘rc1’ or ‘b1’, …

Parameters:version_string – version string such as ‘1.1.1’ or ‘1.2.3b1’, … Returns:tuple of strings with (extracted version, extra version, separator) or (None, None, None) if extraction failed

update_changelog(new_log)

Function updates changelog with new version

update_paths_to_patches()

update_setup_dirname(dirname)

Update %setup or %autosetup dirname argument if needed

Parameters:dirname – new dirname to be used

write_updated_patches(patches, disable_inapplicable)

Function writes the patches to -rebase.spec file

class rebasehelper.specfile.SpecHooksRunner

Class representing the process of running various spec file hooks.

get_available_spec_hooks()

Returns a list of all available spec hooks

run_spec_hooks(spec_file, rebase_spec_file, **kwargs)

Runs all spec hooks.

Parameters:

• spec_file – Original spec file object
• rebase_spec_file – Rebased spec file object
• kwargs – Keyword arguments from Application instance

rebasehelper.specfile.get_rebase_name(dir_name, name)

Function returns a name in results directory

Parameters:

• dir_name –
• name –

Returns:

full path to results dir with name