Class RepositoryMixin

Add a package repository (through its package file) to Entropy Client. This is temporary and the lifecycle of it being available within Entropy Client is limited to this process lifetime. Any package file, either smart package or simple or webinstall must pass from here in order to get inserted, properly validated and made available.

Parameters:

• package_file_path (string) - path to entropy package repository file

Returns:

list of package matches found in package repository.

Raises:

• entropy.exceptions.EntropyPackageException - if package file doesn't contain a valid package repository.

Add repository to Entropy Client configuration and data structures. NOTE: this method is NOT thread-safe. TODO: document metadata structure

Parameters:

• repository_metadata (dict) - repository metadata dict. See SystemSettings()['repositories']['available'][repository_id] for example metadata.

Returns: bool

True, if repository has been added

Backup given repository into given backup directory.

Parameters:

• repository_id (string) - repository identifier
• backup_dir (string) - backup directory
• silent (bool) - execute in silent mode if True
• compress_level (int) - compression level, range from 1 to 9

Clean Entropy Client downloaded packages older than the setting specified by "packages-autoprune-days" in /etc/entropy/client.conf. If setting is not set or invalid, this method will do nothing. Otherwise, files older than given settings (representing time delta in days) will be removed.

Parameters:

• dry_run (bool) - do not remove files, just return them
• days_override (int) - override SystemSettings setting (from client.conf)
• skip_available_packages (bool) - if True, the package files still available in repositories are skipped. This can be used to implement cleanups using just a shared Entropy Resources lock.

Returns: list

list of removed package file paths.

Raises:

• AttributeError - if days_override or client.conf setting is invalid (the latter cannot really happen).

Close the Installed Packages repository. It will be reopened on demand.

Close all the previously opened (through open_repository()) repository instances. If mask_clear is True, package masking information will be cleared as well (by calling SystemSettings.clear()).

Parameters:

• mask_clear (bool) - clear package masking information if True

Disable given repository in Entropy Client configuration. If repository_id doesn't exist, nothing will change. But please, make sure this won't happen. NOTE: this method is NOT thread-safe.

Parameters:

• repository_id (string) - repository identifier

Returns: bool

True, if repository has been disabled, False otherwise

Raises:

• ValueError - if repository is not available
• ValueError - if repository is a package repository

Enable given repository in Entropy Client configuration. If repository_id doesn't exist, nothing will change. But please, make sure this won't happen. NOTE: this method is NOT thread-safe.

Parameters:

• repository_id (string) - repository identifier

Returns: bool

True, if repository has been enabled

Filter out package repositories from a given list.

Parameters:

• repository_ids (list) - an alternative list of enabled repository identifiers

Given a repository identifier, returns the repository class associated with it. NOTE: stub. When more EntropyRepositoryBase classes will be available, this method will start making more sense. WARNING: do not use this to open a repository. Please use Client.open_repository() instead. If repository_id is None, a generic repository class is returned.

Parameters:

• repository_id (string) - repository identifier

Returns: class object

EntropyRepositoryBase based class

Return Entropy Client installed packages repository.

Returns: entropy.db.EntropyRepository

Entropy Client installed packages repository

List available backups for the installed packages repository.

Parameters:

• repository_directory (string) - alternative backup directory

Returns: list

list of paths

Return the Entropy Client installed packages repository path.

Returns: string

repository path

Open a Generic Entropy Repository interface, using entropy.client.interfaces.db.GenericRepository class.

Parameters:

• repository_path (string) - path to valid Entropy Repository file
• dbname (string) - backward compatibility, don't use this
• name (string) - repository identifier hold by the repository object and returned by repository_id()
• xcache (bool) - enable on-disk cache for repository?
• read_only (bool) - True, will keep the repository read-only, rolling back any transaction
• indexing_override (bool) - override default indexing settings (default is disabled for this kind of, usually small, repositories)
• skip_checks (bool) - skip integrity checks on repository
• direct (bool) - True, if direct mode should be always enabled

Returns: entropy.client.interfaces.db.GenericRepository

a GenericRepository object

If you just want open a read-only repository, use this method.

Parameters:

• repository_id (string) - repository identifier

Returns: entropy.db.skel.EntropyRepositoryBase

EntropyRepositoryBase based instance

Open a temporary (using mkstemp()) Entropy Repository. Indexing and Caching are disabled by default.

Parameters:

• dbname (string) - backward compatibility, don't use this
• name (string) - repository identifier hold by the repository object and returned by repository_id()
• temp_file (string) - override random temporary file and open given temp_file. No path validity check will be run.

Returns: entropy.client.interfaces.db.GenericRepository

a GenericRepository object

Remove repository from Entropy Client configuration and data structures, if available. NOTE: this method is NOT thread-safe.

Parameters:

• repository_id (string) - repository identifier
• disable (bool) - instead of removing the repository from entropy configuration, just disable it. (default is remove)

Returns: bool

True, if repository has been removed

Return a list of enabled (and valid) repository identifiers, excluding installed packages repository. You can use the identifiers in this list to open EntropyRepository instances using Client.open_repository() NOTE: this method directly returns a reference to the internal enabled repository list object. NOTE: the returned list is built based on SystemSettings repository metadata but might differ because extra checks are done at runtime. So, if you want to iterate over valid repositories, use this method.

Returns:

enabled and valid repository identifiers @rtype list

Return a SHA1 of the checksums and mtimes of all the repositories.

This method can be used for cache validation/lookup purposes.

Returns: string

a SHA1 string of the checksum and mtimes of all the available repositories, including package repositories, excluding the installed packages repository

Restore given repository.

Parameters:

• backup_path (string) - path to backed up repository file
• repository_path (string) - repository destination path
• repository_id (string) - repository identifier
• silent (bool) - execute in silent mode if True

Change repository priority, move to given index "new_position_idx". The reference ordered list is at SystemSettings()['repositories']['order'] NOTE: this method is NOT thread-safe.

Parameters:

• repository_id (string) - repository identifier
• new_position_idx (int) - new ordered list index

Raises:

• ValueError - if repository_id is invalid

Return a list of repositories that are currently unavailable on the local system. This method does a set difference from repositories() and SystemSettings metadata.

Returns: list

list of unavailable (or broken) repositories