Package entropy :: Package client :: Package interfaces :: Module client :: Class Client

Class Client

source code


Instance Methods
 
init_singleton(self, indexing=True, installed_repo=None, xcache=True, user_xcache=False, repo_validation=True, url_fetcher=None, multiple_url_fetcher=None, **kwargs)
Entropy Client Singleton interface.
source code
 
destroy(self, _from_shutdown=False)
Destroy this Singleton instance, closing repositories, removing SystemSettings plugins added during instance initialization.
source code
 
shutdown(self)
This method should be called when the whole process is going to be killed.
source code
bool
repository_packages_spm_sync(self, *args, **kwargs)
Service method used to sync package names with Source Package Manager via metadata stored in Repository dbs collected at server-time.
source code
 
is_destroyed(self) source code
 
clear_cache(self)
Clear all the Entropy default cache directory.
source code
entropy.qa.QAInterface
QA(self)
Load Entropy QA interface object
source code
 
Settings(self)
Return SystemSettings instance object
source code
 
ClientSettings(self)
Return SystemSettings Entropy Client plugin metadata dictionary
source code
entropy.cache.EntropyCacher
Cacher(self)
Return EntropyCacher instance object
source code
 
PackageActionFactory(self)
Load Entropy PackageActionFactory instance object
source code
 
ConfigurationUpdates(self)
Return Entropy Configuration File Updates management object.
source code
 
Spm(self)
Load Source Package Manager instance object
source code
 
Spm_class(self)
Load Source Package Manager default plugin class
source code
entropy.client.interfaces.repository.Repository
Repositories(self, *args, **kwargs)
Load Entropy Repositories manager instance object
source code
entropy.security.System
Security(self, *args, **kwargs)
Load Entropy Security Advisories interface object
source code
entropy.security.Repository
RepositorySecurity(self, keystore_dir=None)
Load Entropy Repository Security interface object
source code
entropy.client.interfaces.sets.Sets
Sets(self)
Load Package Sets interface object
source code
entropy.client.services.interfaces.WebServicesFactory
WebServices(self)
Load the Entropy Web Services Factory interface, that can be used to obtain a WebService object that is able to communicate with repository remote services, if available.
source code
entropy.client.services.interfaces.RepositoryWebServiceFactory
RepositoryWebServices(self)
Load the Repository Entropy Web Services Factory interface, that can be used to obtain a RepositoryWebService object that is able to communicate with repository remote services, querying for package metadata and general repository status.
source code

Inherited from core.Singleton: __init__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Inherited from dep.CalculatorsMixin: atom_match, atom_search, calculate_available_packages, calculate_critical_updates, calculate_masked_packages, calculate_orphaned_packages, calculate_security_updates, calculate_updates, check_package_update, dependencies_test, get_install_queue, get_masked_packages, get_removal_queue, get_reverse_queue, packages_expand, validate_package_removal

Inherited from methods.RepositoryMixin: add_package_repository, add_repository, backup_repository, clean_downloaded_packages, close_installed_repository, close_repositories, disable_repository, enable_repository, filter_repositories, installed_repository, installed_repository_backups, installed_repository_path, open_generic_repository, open_repository, open_temp_repository, remove_repository, reopen_installed_repository, repositories, repositories_checksum, restore_repository, shift_repository, unavailable_repositories

Inherited from methods.MiscMixin: benchmark_mirrors, generate_package, get_licenses_to_accept, get_meant_packages, get_package_groups, is_entropy_package_free, reorder_mirrors, set_branch, switch_chroot

Inherited from methods.MatchMixin: get_package_action, is_package_masked, is_package_masked_by_user, is_package_unmasked_by_user, mask_package, mask_package_generic, search_available_mimetype, search_installed_mimetype, unmask_package, unmask_package_generic

Class Methods

Inherited from output.TextInterface: ask_question, edit_file, input_box, output, set_title

Inherited from methods.RepositoryMixin: get_repository

Static Methods

Inherited from core.Singleton: __new__

Class Variables

Inherited from output.TextInterface: OUTPUT_LOCK

Inherited from dep.CalculatorsMixin: DISABLE_ASAP_SCHEDULING, DISABLE_AUTOCONFLICT, DISABLE_NEEDED_SCANNING, DISABLE_REWRITE_SELECTED_MATCHES, DISABLE_SLOT_INTERSECTION

Properties
  logger
Return the Entropy Client Logger instance.

Inherited from object: __class__

Method Details

init_singleton(self, indexing=True, installed_repo=None, xcache=True, user_xcache=False, repo_validation=True, url_fetcher=None, multiple_url_fetcher=None, **kwargs)

source code 

Entropy Client Singleton interface. Your hitchhikers' guide to the Galaxy.

Parameters:
  • indexing (bool) - enable metadata indexing (default is True)
  • installed_repo (bool or int) - open installed packages repository? (default is True). Accepted values: True = open, False = open but consider it not available, -1 = do not even try to open
  • xcache (bool) - enable on-disk cache (default is True)
  • user_xcache (bool) - enable on-disk cache even for users not in the entropy group (default is False). Dangerous, could lead to cache inconsistencies.
  • repo_validation (bool) - validate all the available repositories and automatically exclude the faulty ones
  • url_fetcher (class or None) - override default entropy.fetchers.UrlFetcher class usage. Provide your own implementation of UrlFetcher using this argument.
  • multiple_url_fetcher - override default entropy.fetchers.MultipleUrlFetcher class usage. Provide your own implementation of MultipleUrlFetcher using this argument.

destroy(self, _from_shutdown=False)

source code 

Destroy this Singleton instance, closing repositories, removing SystemSettings plugins added during instance initialization. This method should be always called when instance is not used anymore.

shutdown(self)

source code 

This method should be called when the whole process is going to be killed. It calls destroy() and stops any running thread

repository_packages_spm_sync(self, *args, **kwargs)

source code 

Service method used to sync package names with Source Package Manager via metadata stored in Repository dbs collected at server-time. Source Package Manager can change package names, categories or slot and Entropy repositories must be kept in sync.

In other words, it checks for /usr/portage/profiles/updates changes, of course indirectly, since there is no way entropy.client can directly depend on Portage.

Parameters:
  • repository_identifier (string) - repository identifier which repo_db parameter is bound
  • repo_db (entropy.db.EntropyRepository) - repository database instance
Returns: bool
bool stating if changes have been made
Decorators:
  • @sharedinstlock

clear_cache(self)

source code 

Clear all the Entropy default cache directory. This function is fault tolerant and will never return any exception.

Cacher(self)

source code 

Return EntropyCacher instance object

Returns: entropy.cache.EntropyCacher
EntropyCacher instance object

Repositories(self, *args, **kwargs)

source code 

Load Entropy Repositories manager instance object

Returns: entropy.client.interfaces.repository.Repository
Repository instance object

Security(self, *args, **kwargs)

source code 

Load Entropy Security Advisories interface object

Returns: entropy.security.System
Repository Security instance object

RepositorySecurity(self, keystore_dir=None)

source code 

Load Entropy Repository Security interface object

Returns: entropy.security.Repository
Repository Repository Security instance object
Raises:

Sets(self)

source code 

Load Package Sets interface object

Returns: entropy.client.interfaces.sets.Sets
Sets instance object

WebServices(self)

source code 

Load the Entropy Web Services Factory interface, that can be used to obtain a WebService object that is able to communicate with repository remote services, if available.

Returns: entropy.client.services.interfaces.WebServicesFactory
WebServicesFactory instance object

RepositoryWebServices(self)

source code 

Load the Repository Entropy Web Services Factory interface, that can be used to obtain a RepositoryWebService object that is able to communicate with repository remote services, querying for package metadata and general repository status.

Returns: entropy.client.services.interfaces.RepositoryWebServiceFactory
RepositoryWebServiceFactory instance object

Property Details

logger

Return the Entropy Client Logger instance.

Get Method:
unreachable.logger(self) - Return the Entropy Client Logger instance.