File: //usr/lib/python2.7/site-packages/leapp/actors/__pycache__/__init__.cpython-36.pyc
3
�S4b�H � @ s d dl Z d dlZd dlZd dlmZ d dlmZ d dlmZm Z m
Z
m Z m Z m
Z
d dlmZmZ d dlmZ d dlmZ d dlmZmZ d d lmZ d d
lmZ d d l m Z G d d
� d
e �Z dd� Z dd� Z!dd� Z"dd� Z#dd� Z$dd� Z%dd� Z&d$d d �Z'd d!� Z(d"d#� Z)dS )%� N)� string_types)�Dialog)�MissingActorAttributeError�RequestStopAfterPhase�StopActorExecution�StopActorExecutionError�WorkflowConfigNotAvailable�WrongAttributeTypeError)� DialogModel�Model)�
ErrorSeverity)�Tag)�get_api_models�path)� install_translation_for_actor)�get_flattened_subclasses)� WorkflowAPIc @ s& e Zd ZdZdZeZdZdZf Zf Z f Z
f Z f Z dZ
dd� Zd6dd�Zdd � Zd
d � Zed d
� �Zedd� �Zedd� �Zedd� �Zedd� �Zedd� �Zedd� �Zdd� Zd d � Zd d � Z d d!� Z d"d#� Z d$d%� Z d&d'� Z d(d)� Z!d*d+� Z"d,d-� Z#d.d/� Z$d0d1� Z%d2d3� Z&ej'dfd4d5�Z(dS )7�Actorz�
The Actor class represents the smallest step in the workflow. It defines what kind
of data it expects, it consumes (processes) the given data, and it produces data for other
actors in the workflow.
Nc C sp | j tjjtjt| �j j�t| �j | j
p2t| �j dd� | j D �dd� | j
D �dd� | jD �dd� | jD �d�S )z?
:return: Serialized information for the actor
c S s g | ]
}|j �qS � )�__name__)�.0�cr r �,/root/tmp_leapp_py3/leapp/actors/__init__.py�
<listcomp>X s z#Actor.serialize.<locals>.<listcomp>c S s g | ]
}|j �qS r )r )r �pr r r r Y s c S s g | ]
}|j �qS r )r )r �tr r r r Z s c S s g | ] }|j � �qS r )� serialize)r �dr r r r [ s )�namer �
class_name� description�consumes�produces�tags�dialogs)r �osr �dirname�sys�modules�type�
__module__�__file__r r �__doc__r! r" r# r$ )�selfr r r r O s zActor.serializeFc C sp d | _ | t_tt| �� || _|p*tjd�j| j �| _
|| _ |rRt | j
|�d �| _ t| _tt| �d�t| �_d S )Nz leapp.actorsr" )�_configurationr �current_instancer r) �
_messaging�logging� getLogger�getChildr �log� skip_dialogs�next�consumer �_pathr r" )r- Z messaging�loggerZ config_modelr5 r r r �__init__^ s zActor.__init__c C s> | j j|| � |t| �jkr:| jr.| j j|�S | j j|�S dS )z�
Gets the answers for a dialog. The dialog needs be predefined in :py:attr:`dialogs`.
:param dialog: Dialog instance to show
:return: dictionary with the requested answers, None if not a defined dialog
N)r0 Zregister_dialogr) r$ r5 � get_answersZrequest_answers)r- �dialogr r r r; u s zActor.get_answersc C s | j j|� dS )z�
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
N)r0 � show_message)r- �messager r r r= � s zActor.show_messagec C s | j st| j��| j S )z]
Returns the config model generated by specific workflow configuration actor
)r. r r )r- r r r �
configuration� s
zActor.configurationc C s t jdd�jd�S )z~
Returns the file paths that are bundled with the actor. (Path to the content of the actor's file directory).
Z LEAPP_FILES� �:)r% �getenv�split)r- r r r �actor_files_paths� s zActor.actor_files_pathsc C s | j | j S )zQ Returns all actor file paths related to the actor and common actors file paths. )rD �common_files_paths)r- r r r � files_paths� s zActor.files_pathsc C s t jdd�jd�S )z+ Returns all common repository file paths. ZLEAPP_COMMON_FILESr@ rA )r% rB rC )r- r r r rE � s zActor.common_files_pathsc C s t jdd�jd�S )z
Returns the tool paths that are bundled with the actor. (Path to the content of the actor's tools directory).
Z LEAPP_TOOLSr@ rA )r% rB rC )r- r r r �actor_tools_paths� s zActor.actor_tools_pathsc C s t jdd�jd�S )z+ Returns all common repository tool paths. ZLEAPP_COMMON_TOOLSr@ rA )r% rB rC )r- r r r �common_tools_paths� s zActor.common_tools_pathsc C s | j | j S )zS Returns all actor tools paths related to the actor and common actors tools paths. )rG rH )r- r r r � tools_paths� s zActor.tools_pathsc C s | j j| j|�S )z�
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
)r8 �get_folder_pathrF )r- r r r r rJ � s zActor.get_folder_pathc C s | j j| j|�S )z�
Finds the first matching folder path within :py:attr:`common_files_paths`.
:param name: Name of the folder
:type name: str
:return: Found folder path
:rtype: str or None
)r8 rJ rE )r- r r r r �get_common_folder_path� s z Actor.get_common_folder_pathc C s | j j| j|�S )z�
Finds the first matching folder path within :py:attr:`actor_files_paths`.
:param name: Name of the folder
:type name: str
:return: Found folder path
:rtype: str or None
)r8 rJ rD )r- r r r r �get_actor_folder_path� s zActor.get_actor_folder_pathc C s | j j| j|�S )z�
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
)r8 �
get_file_pathrF )r- r r r r rM � s zActor.get_file_pathc C s | j j| j|�S )z�
Finds the first matching file path within :py:attr:`common_files_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
)r8 rM rE )r- r r r r �get_common_file_path� s zActor.get_common_file_pathc C s | j j| j|�S )z�
Finds the first matching file path within :py:attr:`actor_files_paths`.
:param name: Name of the file
:type name: str
:return: Found file path
:rtype: str or None
)r8 rM rD )r- r r r r �get_actor_file_path� s zActor.get_actor_file_pathc C s | j j| j|�S )z�
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
)r8 �
get_tool_pathrI )r- r r r r rP � s zActor.get_tool_pathc C s | j j| j|�S )z�
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
)r8 rP rH )r- r r r r �get_common_tool_path s zActor.get_common_tool_pathc C s | j j| j|�S )z�
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
)r8 rP rG )r- r r r r �get_actor_tool_path s zActor.get_actor_tool_pathc G s� | j tjd< zxy| j|� W nd tk
r0 Y nR tk
rd } z| j|j|j|j � W Y dd}~X n t
k
r� | j j � Y nX W dtjj
dd� X dS )z7 Runs the actor calling the method :py:func:`process`. �LEAPP_CURRENT_ACTORN)r r% �environ�processr r � report_errorr> �severity�detailsr r0 Zrequest_stop_after_phase�pop)r- �args�errr r r �run s $z Actor.runc O s
t � �dS )zj Main processing method. In inherited actors, the function needs to be defined to be able to be processed.N)�NotImplementedError)r- rZ �kwargsr r r rU , s z
Actor.processc G sN | j rJxB|D ]:}t|t| �j�r0| j j|| � q | jjdjt|��� q W dS )aN
By calling produce, model instances are stored as messages. Those messages can be then consumed by other actors.
:param models: Messages to be sent (those model types have to be specified in :py:attr:`produces`
:type models: Variable number of the derived classes from :py:class:`leapp.models.Model`
z�Actor is trying to produce a message of type "{}" without mentioning it explicitely in the actor's "produces" tuple. The message will be ignoredN)r0 �
isinstancer) r" �producer4 �warning�format)r- �models�modelr r r r` 0 s
z
Actor.producec G s | j r| j j| f|�� S f S )a�
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: All messages of the specified model(s) produced by other actors
:rtype: Iterable with messages or an empty tuple
)r0 r7 )r- rc r r r r7 @ s
z
Actor.consumec C s< | j r8tj|�s$| jjd|� tj}| j j||| |d� dS )a�
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
zJreport_error: Unknown severity value %s was passed - Falling back to ERROR)r> rW �actorrX N)r0 r �validater4 ra �ERRORrV )r- r> rW rX r r r rV N s
zActor.report_error)NNNF))r r* � __qualname__r, r/ r r r r! r" r# r$ �apisZ text_domainr r: r; r= �propertyr? rD rF rE rG rH rI rJ rK rL rM rN rO rP rQ rR r\ rU r` r7 rg rV r r r r r sH
r c s � fdd�}|S )Nc s t |� �s tdj| |� ���|S )Nz.Actor {} attribute {} should be of the type {})r_ r rb )re r �value)�
value_typer r rf f s
z_is_type.<locals>.validater )rl rf r )rl r �_is_typee s rm c s � fdd�}|S )Nc sR t t�| ||� |s&tdj| |� ���t� fdd�|D ��sNtdj| |� ���|S )NzEActor {} attribute {} should contain at least one item of the type {}c s g | ]}t |� ��qS r )r_ )r �item)rl r r r t s z2_is_tuple_of.<locals>.validate.<locals>.<listcomp>z?Actor {} attribute {} should contain only values of the type {})rm �tupler rb �all)re r rk )rl r r rf o s z _is_tuple_of.<locals>.validater )rl rf r )rl r � _is_tuple_ofn s rq c C sL t | di �}|j|d �sHd||d < t| d|� tjd�jd| ||� d S )N� _warnings�_tupleTz leapp.linterz)Actor %s field %s should be a tuple of %s)�getattr�get�setattrr1 r2 ra )re r � type_name�warningsr r r �
_lint_warn{ s
ry c C sb t |t�r&t|t�r&t| |d� |f}tt�| ||� tdgdd� |D � �s^tdj | |���|S )NZModelsTc S s g | ]}t |t�ot|t��qS r )r_ r) �
issubclassr )r rn r r r r � s z#_is_model_tuple.<locals>.<listcomp>z0Actor {} attribute {} should contain only Models)
r_ r) rz r ry rm ro rp r rb )re r rk r r r �_is_model_tuple� s r{ c C sX t |t�r t| |d� |f}tt�| ||� tdgdd� |D � �sTtdj| |���|S )NZDialogsTc S s g | ]}t |t��qS r )r_ r )r rn r r r r � s z$_is_dialog_tuple.<locals>.<listcomp>z1Actor {} attribute {} should contain only Dialogs)r_ r ry rm ro rp r rb )re r rk r r r �_is_dialog_tuple� s
r| c C sb t |t�r&t|t�r&t| |d� |f}tt�| ||� tdgdd� |D � �s^tdj | |���|S )NZTagsTc S s g | ]}t |t�ot|t��qS r )r_ r) rz r
)r rn r r r r � s z!_is_tag_tuple.<locals>.<listcomp>z.Actor {} attribute {} should contain only Tags)
r_ r) rz r
ry rm ro rp r rb )re r rk r r r �
_is_tag_tuple� s r} c C sb t |t�r&t|t�r&t| |d� |f}tt�| ||� tdgdd� |D � �s^tdj | |���|S )NZApisTc S s g | ]}t |t�ot|t��qS r )r_ r) rz r )r rn r r r r � s z!_is_api_tuple.<locals>.<listcomp>z6Actor {} attribute {} should contain only WorkflowAPIs)
r_ r) rz r ry rm ro rp r rb )re r rk r r r �
_is_api_tuple� s r~ Fr@ c C sf |r|| |�}n t | |d �}| r8|r8tdj| ||���|s@|rL|| ||�}| r^|d k r^|}||fS )Nz#Actor {} is missing attribute {}.{})rt r rb )re r Z validator�required�
default_value�additional_info�resolverk r r r �_get_attribute� s
r� c C s� d}t d| jfdtjjtjjtj| j j ��ft
| dt t �dd�t
| dt
d|d�t
| d td
f td �t
| d td
f td �t
| d
td
f d�t
| dt t �d
| jp�dd�t
| dtd
f d�g �S )a
Creates Actor's metadata dictionary
:param actor: Actor whose metadata are needed
:type actor: derived class from :py:class:`leapp.actors.Actor`
:return: Dictionary with the name, tags, consumes, produces, and description of the actor
zD At least one tag is required for actors. Please fill the tags fieldr r r T)r r# )r r� r! F)r r� r� r" r$ )r r� r z6There has been no description provided for this actor.ri )�dictr r% r r& �realpathr' r( r* r+ r� rm r r} r{ r r| r, r~ )re Zadditional_tag_infor r r �get_actor_metadata� s r� c C s" t t�} x| D ] }t|� qW | S )z<
:return: All registered actors with their metadata
)r r r� )Zactorsre r r r �
get_actors� s
r� )FNr@ N)*r1 r% r' � leapp.compatr Z
leapp.dialogsr �leapp.exceptionsr r r r r r � leapp.modelsr
r �leapp.models.error_severityr Z
leapp.tagsr
Z leapp.utilsr r Zleapp.utils.i18nr �leapp.utils.metar Zleapp.workflows.apir �objectr rm rq ry r{ r| r} r~ r� r� r� r r r r �<module> s2 U