| Server IP : 188.40.95.74 / Your IP : 216.73.216.142 Web Server : Apache System : Linux cp01.striminghost.net 3.10.0-1160.119.1.el7.tuxcare.els13.x86_64 #1 SMP Fri Nov 22 06:29:45 UTC 2024 x86_64 User : vlasotin ( 1054) PHP Version : 5.6.40 Disable Function : NONE MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /lib/python2.7/site-packages/leapp/libraries/stdlib/ |
Upload File : |
"""
This module implements a convenience API for actions that are accessible to actors.
Any code that wants use this convenience library has to be called from within the actors context.
This is true for actors, actor private libraries and repository libraries.
"""
import logging
from leapp.actors import Actor
ErrorSeverity = Actor.ErrorSeverity
def current_actor():
"""
Retrieve the Actor class instance of the current active actor.
:return: Instance of the currently instantiated actor.
:rtype: leapp.actors.Actor
"""
return Actor.current_instance
def report_error(message, severity=ErrorSeverity.ERROR, details=None):
"""
Reports an execution error
:param message: A message to print the possible error
:type message: str
:param severity: Severity of the error default :py:attr:`leapp.messaging.errors.ErrorSeverity.ERROR`
:type severity: str with defined values from :py:attr:`leapp.messaging.errors.ErrorSeverity.ERROR`
:param details: A dictionary where additional context information is passed along with the error
:type details: dict
:return: None
"""
return current_actor().report_error(message=message, severity=severity, details=details)
def show_message(message):
"""
Display a message in user interterface currently in use (CLI, GUI).
It uses one of the dialog renderers in :py:mod:`leapp.dialogs.renderer`.
:param message: Message to show
:type message: str
"""
return current_actor().show_message(message=message)
def current_logger():
"""
Retrieve the logger of the current active actor.
:return: Logger instance for the current actor.
:rtype: logging.Logger
"""
return current_actor().log if current_actor() else logging.getLogger('leapp.fallback')
def produce(*model_instances):
"""
By calling produce, model instances are stored as messages. Those messages can be then consumed by other actors.
:param model_instances: Messages to be sent (those model types have to be specified in :py:attr:`produces`
:type model_instances: Variable number of instances of derived classes from :py:class:`leapp.models.Model`
"""
return current_actor().produce(*model_instances)
def consume(*models):
"""
Retrieve messages specified in the actors :py:attr:`consumes` attribute, and filter message types by
models.
:param models: Models to use as a filter for the messages to return
:type models: Variable number of the derived classes from :py:class:`leapp.models.Model`
"""
return current_actor().consume(*models)
def get_answers(dialog):
"""
Get the answers for a dialog from answerfile. The dialog needs be predefined in :py:attr:`dialogs` of the actor.
:param dialog: Dialog instance to show
:return: dictionary with the requested answers, None if not a defined dialog
"""
return current_actor().get_answers(dialog)
def actor_files_paths():
"""
Returns the file paths that are bundled with the actor. (Path to the content of the actor's file directory).
"""
return current_actor().actor_files_paths
def files_paths():
""" Returns all actor file paths related to the actor and common actors file paths. """
return current_actor().files_paths
def common_files_paths():
""" Returns all common repository file paths. """
return current_actor().common_files_paths
def actor_tools_paths():
"""
Returns the tool paths that are bundled with the actor. (Path to the content of the actor's tools directory).
"""
return current_actor().actor_tools_paths
def tools_paths():
""" Returns all actor tools paths related to the actor and common actors tools paths. """
return current_actor().tools_paths
def common_tools_paths():
""" Returns all common repository tool paths. """
return current_actor().common_tools_paths
def get_common_folder_path(name):
"""
Finds the first matching folder path within :py:attr:`files_paths`.
:param name: Name of the folder
:type name: str
:return: Found folder path
:rtype: str or None
"""
return current_actor().get_common_folder_path(name)
def get_actor_folder_path(name):
"""
Finds the first matching folder path within :py:attr:`files_paths`.
:param name: Name of the folder
:type name: str
:return: Found folder path
:rtype: str or None
"""
return current_actor().get_actor_folder_path(name)
def get_folder_path(name):
"""
Finds the first matching folder path within :py:attr:`files_paths`.
:param name: Name of the folder
:type name: str
:return: Found folder path
:rtype: str or None
"""
return current_actor().get_folder_path(name)
def get_common_file_path(name):
"""
Finds the first matching file path within :py:attr:`files_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
"""
return current_actor().get_common_file_path(name)
def get_actor_file_path(name):
"""
Finds the first matching file path within :py:attr:`files_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
"""
return current_actor().get_actor_file_path(name)
def get_file_path(name):
"""
Finds the first matching file path within :py:attr:`files_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
"""
return current_actor().get_file_path(name)
def get_tool_path(name):
"""
Finds the first matching executable file path within :py:attr:`tools_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
"""
return current_actor().get_tool_path(name)
def get_common_tool_path(name):
"""
Finds the first matching executable file path within :py:attr:`common_tools_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
"""
return current_actor().get_common_tool_path(name)
def get_actor_tool_path(name):
"""
Finds the first matching executable file path within :py:attr:`actor_tools_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
"""
return current_actor().get_actor_tool_path(name)
def retrieve_config():
"""
Retrieve the configuration specific to the specified schema.
"""
return current_actor().retrieve_config()