�
9�Egc@s
dZd
dl
Z
d
dlmZ
ejZd�Zejdd�Zd�Z	d�Z
d�Zd	�Zd
�Z
d�Zd�Zd
�Zd�Zd�Zd�Zd�Zd�Zd�Zd�Zd�Zd�Zd�Zd�Zd�Zd�ZdS(s

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.
i����N(
tActorc
Cstj
S(
s�
    Retrieve the Actor class instance of the current active actor.
    :return: Instance of the currently instantiated actor.
    :rtype: leapp.actors.Actor
    (Rtcurrent_instance(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyt
current_actorscCst�j
d
|d|
d|�S(s�

    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
    tmessagetseveritytdetails(Rtreport_error(RRR((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRsc

Cst�j
d
|�
S(s�
    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
    R(Rtshow_message(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR's	cCs t�rt�j
Stjd
�
S(s�
    Retrieve the logger of the current active actor.
    :return: Logger instance for the current actor.
    :rtype: logging.Logger
    sleapp.fallback(Rtlogtloggingt	getLogger(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pytcurrent_logger3sc
Gst�j
|�S(
sY

    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`
    (Rtproduce(
tmodel_instances((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR<sc
Gst�j
|�S(
s 

    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`
    (Rtconsume(
tmodels((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRFsc

Cst�j
|�
S(
s�
    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
    (Rtget_answers(
tdialog((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRQsc
Cs
t�j
S(
sv
    Returns the file paths that are bundled with the actor. (Path to the content of the actor's file directory).
    (Rtactor_files_paths(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR[sc
Cs
t�j
S(
sQ Returns all actor file paths related to the actor and common actors file paths. (Rtfiles_paths(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRbsc
Cs
t�j
S(
s+ Returns all common repository file paths. (Rtcommon_files_paths(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRgsc
Cs
t�j
S(
sw
    Returns the tool paths that are bundled with the actor. (Path to the content of the actor's tools directory).
    (Rtactor_tools_paths(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRlsc
Cs
t�j
S(
sS Returns all actor tools paths related to the actor and common actors tools paths. (Rttools_paths(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRssc
Cs
t�j
S(
s+ Returns all common repository tool paths. (Rtcommon_tools_paths(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyRxsc

Cst�j
|�
S(
s�
    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
    (Rtget_common_folder_path(
tname((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR}s	c

Cst�j
|�
S(
s�
    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
    (Rtget_actor_folder_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR�s	c

Cst�j
|�
S(
s�
    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
    (Rtget_folder_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR�s	c

Cst�j
|�
S(
s�
    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
    (Rtget_common_file_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR�s	c

Cst�j
|�
S(
s�
    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
    (Rtget_actor_file_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR�s	c

Cst�j
|�
S(
s�
    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
    (Rt
get_file_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR�s	c

Cst�j
|�
S(
s�
    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
    (Rt
get_tool_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR�s	c

Cst�j
|�
S(
s�
    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
    (Rtget_common_tool_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR �s	c

Cst�j
|�
S(
s�
    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
    (Rtget_actor_tool_path(
R((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR!�s	c
Cs
t�j
�S(
sF
    Retrieve the configuration specific to the specified schema.
    (Rtretrieve_config(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyR"�s(t__doc__R	tleapp.actorsRt
ErrorSeverityRtERRORtNoneRRRRRRRRRRRRRRRRRRRR R!R"(((s>/usr/lib/python2.7/site-packages/leapp/libraries/stdlib/api.pyt<module>s4