Package entropy :: Package spm :: Package plugins :: Package interfaces :: Module portage_plugin :: Class PortagePlugin

Class PortagePlugin

source code


Nested Classes
  paren_normalize
Take a dependency structure as returned by paren_reduce or use_reduce and generate an equivalent structure that has no redundant lists.
Instance Methods
 
init_singleton(self, OutputInterface)
Source Package Manager Plugin singleton method.
source code
list
package_metadata_keys(self)
Reimplemented from SpmPlugin class.
source code
string
get_cache_directory(self, root=None)
Reimplemented from SpmPlugin class.
source code
string
get_package_metadata(self, package, key)
Reimplemented from SpmPlugin class.
source code
string or None
get_package_changelog(self, package)
Reimplemented from SpmPlugin class.
source code
string
get_package_build_script_path(self, package)
Reimplemented from SpmPlugin class.
source code
string
get_installed_package_build_script_path(self, package, root=None)
Reimplemented from SpmPlugin class.
source code
string
get_installed_package_metadata(self, package, key, root=None)
Reimplemented from SpmPlugin class.
source code
list
get_system_packages(self)
Reimplemented from SpmPlugin class.
source code
list
get_package_categories(self)
Reimplemented from SpmPlugin class.
source code
dict
get_package_category_description_metadata(self, category)
Reimplemented from SpmPlugin class.
source code
list
get_security_packages(self, security_property)
Reimplemented from SpmPlugin class.
source code
dict
get_security_advisory_metadata(self, advisory_id)
Reimplemented from SpmPlugin class.
source code
 
get_setting(self, key)
Reimplemented from SpmPlugin class.
source code
string
get_user_installed_packages_file(self, root=None)
Reimplemented from SpmPlugin class.
source code
list
get_merge_protected_paths(self)
Reimplemented from SpmPlugin class.
source code
 
get_merge_protected_paths_mask(self)
Reimplemented from SpmPlugin class.
source code
list
get_download_mirrors(self, mirror_name)
Reimplemented from SpmPlugin class.
source code
 
packages_repositories_metadata_update(self)
Reimplemented from SpmPlugin class.
source code
string or list or None
match_package(self, package, match_type=None)
Reimplemented from SpmPlugin class.
source code
string or list or None
match_installed_package(self, package, match_all=False, root=None)
Reimplemented from SpmPlugin class.
source code
None
generate_package(self, package, file_save_path)
Reimplemented from SpmPlugin class.
source code
dict
extract_package_metadata(self, package_file)
Reimplemented from SpmPlugin class.
source code
bool
enable_package_compile_options(self, package, options)
Reimplemented from SpmPlugin class.
source code
bool
disable_package_compile_options(self, package, options)
Reimplemented from SpmPlugin class.
source code
dict
get_package_compile_options(self, package)
Reimplemented from SpmPlugin class.
source code
dict
get_installed_package_compile_options(self, package, root=None)
Reimplemented from SpmPlugin class.
source code
list
get_installed_package_content(self, package, root=None)
Reimplemented from SpmPlugin class.
source code
list
get_packages(self, categories=None, filter_reinstalls=True)
Reimplemented from SpmPlugin class.
source code
list
get_installed_packages(self, categories=None, root=None)
Reimplemented from SpmPlugin class.
source code
dict
get_package_sets(self, builtin_sets)
Reimplemented from SpmPlugin class.
source code
int
assign_uid_to_installed_package(self, package, root=None)
Reimplemented from SpmPlugin class.
source code
dict
search_paths_owners(self, paths, exact_match=True)
Reimplemented from SpmPlugin class.
source code
int
execute_package_phase(self, package, build_script_path, phase_name, work_dir=None, licenses_accepted=None)
Reimplemented from SpmPlugin class.
source code
 
add_installed_package(self, package_metadata)
Reimplemented from SpmPlugin class.
source code
 
remove_installed_package(self, package_metadata)
Reimplemented from SpmPlugin class.
source code
 
configure_installed_package(self, package_metadata)
Reimplemented from SpmPlugin class.
source code

Inherited from skel.SpmPlugin: log_message, package_phases

Inherited from core.Singleton: is_destroyed, is_singleton

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Static Methods
 
get_package_groups()
Return package groups available metadata (Spm categories are grouped into macro categories called "groups").
source code
int
entropy_install_setup_hook(entropy_client, package_metadata)
Reimplemented from SpmPlugin class.
source code
int
entropy_install_unpack_hook(entropy_client, package_metadata)
Reimplemented from SpmPlugin class.
source code

Inherited from core.Singleton: __new__

Class Variables
  builtin_pkg_sets = ['system', 'world', 'installed', 'module-re...
  package_phases_map = {'configure': 'config', 'postinstall': 'p...
  PLUGIN_API_VERSION = 0
  SUPPORTED_MATCH_TYPES = ['bestmatch-visible', 'cp-list', 'list...

Inherited from skel.SpmPlugin: BASE_PLUGIN_API_VERSION

Properties

Inherited from object: __class__

Method Details

init_singleton(self, OutputInterface)

source code 

Source Package Manager Plugin singleton method. This method must be reimplemented by subclasses. At this stage, you should also consider to tweak etpConst['spm'] content (importing etpConst from entropy.const).

Parameters:
  • output_interface - Entropy output interface
Raises:
  • NotImplementedError() - when method is not reimplemented
Overrides: skel.SpmPlugin.init_singleton
(inherited documentation)

get_package_groups()
Static Method

source code 

Return package groups available metadata (Spm categories are grouped into macro categories called "groups").

Overrides: skel.SpmPlugin.get_package_groups

package_metadata_keys(self)

source code 

Reimplemented from SpmPlugin class.

Returns: list
list of package metadata
Overrides: skel.SpmPlugin.package_metadata_keys

get_cache_directory(self, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • root - specify an alternative root directory "/"
Returns: string
cache directory
Overrides: skel.SpmPlugin.get_cache_directory

get_package_metadata(self, package, key)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • key - metadata key (name)
Returns: string
package metadata value
Overrides: skel.SpmPlugin.get_package_metadata

get_package_changelog(self, package)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
Returns: string or None
changelog
Overrides: skel.SpmPlugin.get_package_changelog

get_package_build_script_path(self, package)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
Returns: string
build script path
Overrides: skel.SpmPlugin.get_package_build_script_path

get_installed_package_build_script_path(self, package, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • root - specify an alternative root directory "/"
Returns: string
build script path
Overrides: skel.SpmPlugin.get_installed_package_build_script_path

get_installed_package_metadata(self, package, key, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package identifier
  • key - metadata key (name)
  • root - specify an alternative root directory "/"
Returns: string
package metadata value
Overrides: skel.SpmPlugin.get_installed_package_metadata

get_system_packages(self)

source code 

Reimplemented from SpmPlugin class.

Returns: list
list of system packages
Overrides: skel.SpmPlugin.get_system_packages

get_package_categories(self)

source code 

Reimplemented from SpmPlugin class.

Returns: list
list of package categories
Overrides: skel.SpmPlugin.get_package_categories

get_package_category_description_metadata(self, category)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • category - package category name
Returns: dict
category description metadata
Overrides: skel.SpmPlugin.get_package_category_description_metadata

get_security_packages(self, security_property)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • security_property - packages security property
Returns: list
list of packages affected by given security property
Overrides: skel.SpmPlugin.get_security_packages

get_security_advisory_metadata(self, advisory_id)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • advisory_id - security advisory identifier
Returns: dict
advisory metadata
Overrides: skel.SpmPlugin.get_security_advisory_metadata

get_setting(self, key)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • key - source package manager setting
Raises:
  • KeyError - if setting is not available
Overrides: skel.SpmPlugin.get_setting

get_user_installed_packages_file(self, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • root - specify an alternative root directory "/"
Returns: string
path to installed packages list file
Overrides: skel.SpmPlugin.get_user_installed_packages_file

get_merge_protected_paths(self)

source code 

Reimplemented from SpmPlugin class.

Returns: list
list of protected paths
Overrides: skel.SpmPlugin.get_merge_protected_paths

get_merge_protected_paths_mask(self)

source code 

Reimplemented from SpmPlugin class.

Overrides: skel.SpmPlugin.get_merge_protected_paths_mask

get_download_mirrors(self, mirror_name)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • mirror_name - mirror name
Returns: list
list of download URLs
Overrides: skel.SpmPlugin.get_download_mirrors

packages_repositories_metadata_update(self)

source code 

Reimplemented from SpmPlugin class.

Overrides: skel.SpmPlugin.packages_repositories_metadata_update

match_package(self, package, match_type=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package string to match inside available repositories
  • match_type - match type
Returns: string or list or None
matched package (atom) or None
Raises:
  • KeyError - if match_type is not valid
Overrides: skel.SpmPlugin.match_package

match_installed_package(self, package, match_all=False, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package string to match inside installed packages repository
  • match_all - return all the matching packages, not just the best
  • root - specify an alternative root directory "/"
Returns: string or list or None
matched package (atom) or None
Raises:
  • KeyError - if match_type is not valid
Overrides: skel.SpmPlugin.match_installed_package

generate_package(self, package, file_save_path)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • file_save_path - exact path (including file name and extension) where package file is saved
Returns: None
None
Raises:
Overrides: skel.SpmPlugin.generate_package

extract_package_metadata(self, package_file)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package_file - path to valid SPM package file
Returns: dict
package metadata extracted
Raises:
Overrides: skel.SpmPlugin.extract_package_metadata

enable_package_compile_options(self, package, options)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • options - list of compile options to enable
Returns: bool
enable status, True if enabled, False if not
Overrides: skel.SpmPlugin.enable_package_compile_options

disable_package_compile_options(self, package, options)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • options - list of compile options to disable
Returns: bool
enable status, True if disabled, False if not
Overrides: skel.SpmPlugin.disable_package_compile_options

get_package_compile_options(self, package)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
Returns: dict
compile options
Overrides: skel.SpmPlugin.get_package_compile_options

get_installed_package_compile_options(self, package, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • root - specify an alternative root directory "/"
Returns: dict
compile options
Overrides: skel.SpmPlugin.get_installed_package_compile_options

get_installed_package_content(self, package, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • root - specify an alternative root directory "/"
Returns: list
list of files/directories owned by package
Overrides: skel.SpmPlugin.get_installed_package_content

get_packages(self, categories=None, filter_reinstalls=True)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • categories - list of package categories to look into
  • filter_reinstalls - enable reinstall packages filter
Returns: list
list of available packages found
Overrides: skel.SpmPlugin.get_packages

get_installed_packages(self, categories=None, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • categories - list of package categories to look into
  • root - specify an alternative root directory "/"
Returns: list
list of installed packages found
Overrides: skel.SpmPlugin.get_installed_packages

get_package_sets(self, builtin_sets)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • builtin_sets - if True, also return SPM built-in package sets
Returns: dict
dictionary featuring set name as key, list (set) of package dependencies as value
Overrides: skel.SpmPlugin.get_package_sets

assign_uid_to_installed_package(self, package, root=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • root - specify an alternative root directory "/"
Returns: int
assigned Unique Identifier
Overrides: skel.SpmPlugin.assign_uid_to_installed_package

search_paths_owners(self, paths, exact_match=True)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • paths - list of paths to resolve
  • exact_match - match paths exactly
Returns: dict
packages owning list of paths
Overrides: skel.SpmPlugin.search_paths_owners

execute_package_phase(self, package, build_script_path, phase_name, work_dir=None, licenses_accepted=None)

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • package - package name
  • build_script_path - path to Source Package Manager build script to call
  • phase_name - name of the phase to call, must be a valid phase contained in package_phases() output.
  • work_dir - specify a work directory if required by your SPM
  • licenses_accepted - list of license names already accepted that can be given to Source Package Manager (to skip its license acceptance verification stuff, for example)
Returns: int
phase script exit status
Raises:
  • KeyError - if phase is not available
Overrides: skel.SpmPlugin.execute_package_phase

add_installed_package(self, package_metadata)

source code 

Reimplemented from SpmPlugin class.

Overrides: skel.SpmPlugin.add_installed_package

remove_installed_package(self, package_metadata)

source code 

Reimplemented from SpmPlugin class.

Overrides: skel.SpmPlugin.remove_installed_package

configure_installed_package(self, package_metadata)

source code 

Reimplemented from SpmPlugin class.

Overrides: skel.SpmPlugin.configure_installed_package

entropy_install_setup_hook(entropy_client, package_metadata)
Static Method

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • entropy_client - Entropy Client interface instance
  • package_metadata - Entropy package metadata
Returns: int
execution status
Overrides: skel.SpmPlugin.entropy_install_setup_hook

entropy_install_unpack_hook(entropy_client, package_metadata)
Static Method

source code 

Reimplemented from SpmPlugin class.

Parameters:
  • entropy_client - Entropy Client interface instance
  • package_metadata - Entropy package metadata
Returns: int
execution status
Overrides: skel.SpmPlugin.entropy_install_unpack_hook

Class Variable Details

builtin_pkg_sets

Value:
['system',
 'world',
 'installed',
 'module-rebuild',
 'security',
 'preserved-rebuild',
 'live-rebuild',
 'downgrade',
...

package_phases_map

Value:
{'configure': 'config',
 'postinstall': 'postinst',
 'postremove': 'postrm',
 'preinstall': 'preinst',
 'preremove': 'prerm',
 'setup': 'setup'}

SUPPORTED_MATCH_TYPES

Value:
['bestmatch-visible',
 'cp-list',
 'list-visible',
 'match-all',
 'match-visible',
 'minimum-all',
 'minimum-visible']