sos.archive — Archive Interface

class sos.archive.Archive

Bases: object

Abstract base class for archives.

add_binary(content, dest)

add_dir(path)

add_file(src, dest=None)

add_link(source, link_name)

add_node(path, mode, device)

add_string(content, dest, mode='w')

classmethod archive_type()

Returns the archive class’s name as a string.

cleanup()

Clean up any temporary resources used by an Archive class.

finalize(method)

Finalize an archive object via method. This may involve creating An archive that is subsequently compressed or simply closing an archive that supports in-line handling. If method is automatic then the following methods are tried in order: xz, gzip

get_archive_path()

Return a string representing the path to the temporary archive. For archive classes that implement in-line handling this will be the archive file itself. Archives that use a directory based cache prior to packaging should return the path to the temporary directory where the report content is located

get_tmp_dir()

Return a temporary directory that clients of the archive may use to write content to. The content of the path is guaranteed to be included in the generated archive.

log = <Logger sos (WARNING)>

log_debug(msg)

log_error(msg)

log_info(msg)

log_warn(msg)

name_max()

Return the maximum file name length this archive can support. This is the lesser of the name length limit of the archive format and any temporary file system based cache.

set_debug(debug)

class sos.archive.FileCacheArchive(name, tmpdir, policy, threads, enc_opts, sysroot, manifest=None)

Bases: sos.archive.Archive

Abstract superclass for archive types that use a temporary cache directory in the file system.

add_binary(content, dest)

add_dir(path)

Create a directory in the archive.

Parameters:path – the path in the host file system to add

add_file(src, dest=None)

add_final_manifest_data(method)

Adds component-agnostic data to the manifest so that individual SoSComponents do not need to redundantly add these manually

add_link(source, link_name)

add_node(path, mode, device)

add_string(content, dest, mode='w')

cleanup()

Clean up any temporary resources used by an Archive class.

dest_path(name)

finalize(method)

Finalize an archive object via method. This may involve creating An archive that is subsequently compressed or simply closing an archive that supports in-line handling. If method is automatic then the following methods are tried in order: xz, gzip

get_archive_path()

Return a string representing the path to the temporary archive. For archive classes that implement in-line handling this will be the archive file itself. Archives that use a directory based cache prior to packaging should return the path to the temporary directory where the report content is located

get_tmp_dir()

Return a temporary directory that clients of the archive may use to write content to. The content of the path is guaranteed to be included in the generated archive.

join_sysroot(path)

makedirs(path, mode=448)

Create path, including leading components.

Used by sos.sosreport to set up sos_* directories.

name_max()

Return the maximum file name length this archive can support. This is the lesser of the name length limit of the archive format and any temporary file system based cache.

open_file(path)

rename_archive_root(cleaner)

Rename the archive to an obfuscated version using an initialized SoSCleaner instance

class sos.archive.TarFileArchive(name, tmpdir, policy, threads, enc_opts, sysroot, manifest=None)

Bases: sos.archive.FileCacheArchive

archive class using python TarFile to create tar archives

copy_permissions_filter(tarinfo)

get_selinux_context(path)

method = None

name()

name_max()

Return the maximum file name length this archive can support. This is the lesser of the name length limit of the archive format and any temporary file system based cache.

set_tarinfo_from_stat(tar_info, fstat, mode=None)