sos.archive — Archive Interface

class sos.archive.Archive

Bases: object

Abstract base class for archives.

Archive.add_binary(content, dest)

Archive.add_dir(path)

Archive.add_file(src, dest=None)

Archive.add_link(source, link_name)

Archive.add_node(path, mode, device)

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

classmethod Archive.archive_type()

Returns the archive class’s name as a string.

Archive.cleanup()

Clean up any temporary resources used by an Archive class.

Archive.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, bz2 and gzip

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

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

Archive.log = <logging.Logger object at 0x7fd88de20990>

Archive.log_debug(msg)

Archive.log_error(msg)

Archive.log_info(msg)

Archive.log_warn(msg)

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

Archive.set_debug(debug)

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

Bases: sos.archive.Archive

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

FileCacheArchive.add_binary(content, dest)

FileCacheArchive.add_dir(path)

Create a directory in the archive.

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

FileCacheArchive.add_file(src, dest=None)

FileCacheArchive.add_link(source, link_name)

FileCacheArchive.add_node(path, mode, device)

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

FileCacheArchive.cleanup()

FileCacheArchive.dest_path(name)

FileCacheArchive.finalize(method)

FileCacheArchive.get_archive_path()

FileCacheArchive.get_tmp_dir()

FileCacheArchive.join_sysroot(path)

FileCacheArchive.makedirs(path, mode=448)

Create path, including leading components.

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

FileCacheArchive.name_max()

FileCacheArchive.open_file(path)

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

Bases: sos.archive.FileCacheArchive

archive class using python TarFile to create tar archives

TarFileArchive.copy_permissions_filter(tarinfo)

TarFileArchive.get_selinux_context(path)

TarFileArchive.method = None

TarFileArchive.name()

TarFileArchive.name_max()

TarFileArchive.set_tarinfo_from_stat(tar_info, fstat, mode=None)