File: //usr/lib/python3.6/site-packages/glances/outputs/__pycache__/glances_stdout_apidoc.cpython-36.pyc
3
Eo�c� � @ s� d Z ddlmZ ddlZddlZddlmZ ddlmZ dZ dZ
d d d
�Z d d � Z d
d� Z
dd� Zdd� Zdd� Zdd� Zdd� Zdd� ZG dd � d e�ZdS ) z#Fields description interface class.� )�pformatN)�logger)� iteritemsz http://localhost:61208/api/3a .. _api:
API (Restfull/JSON) documentation
=================================
The Glances Restfull/API server could be ran using the following command line:
.. code-block:: bash
# glances -w --disable-webui
Note: Change request URL api/3 by api/2 if you use Glances 2.x.
� c C sp t | t�rLt| �dkrLt | d t�rL|t| dd� �jdd| �jdd� S |t| �jdd| �jdd� S d S )N� r � �
�'�")�
isinstance�list�len�dictr �replace)�stat�indent� r �+/usr/lib/python3.6/glances_stdout_apidoc.py� indent_stat% s $(r c C sr d} t | � t dt| � � t d� t d� t d� t d� t d� t d� t djt�� t td�� t d� d S ) NzGET API status�-� z8This entry point should be used to check the API status.z@It will return nothing but a 200 return code if everythin is OK.zGet the Rest API status::z # curl -I {}/statuszHTTP/1.0 200 OK)�printr
�format�API_URLr )� sub_titler r r �print_api_status. s r c C sZ d}t |� t dt|� � t d� t d� t d� t djt�� t t| �� t d� d S )NzGET plugins listr r zGet the plugins list::z # curl {}/pluginslist)r r
r r r )r r r r r �print_plugins_list= s r c C sl dj | �}t|� tdt|� � td� td� td� tdj t| �� tttj|j� ��� td� d S )NzGET {}r r zGet plugin stats::z # curl {}/{})r r r
r r �json�loadsZ get_stats)�pluginr r r r r �print_plugin_statsI s
r c C s� |j rptd� td� xNt|j �D ]@\}}tdj||d jd�rP|d d d � n|d |d �� q"W td� ntjdj| �� d S )
NzFields descriptions:r z* **{}**: {} (unit is *{}*)� description�.r Zunitz4No fields_description variable defined for plugin {}���)Zfields_descriptionr r r �endswithr �error)r r Zfieldr! r r r �print_plugin_descriptionV s
r& c C sV d }d }t |t�r(t|j� �d }d }nRt |t�rzt|�dkrzt |d t�rzd|d krf|d d }nt|d j� �d }|r�|j|�r�tj|j|��}t || t�r�|| d }n|| }td� td� tdj t
| |�� tt |�� td� |�rR|�rR|j ||��rRtd� td� tdj t
| ||�� tt tj|j ||���� td� d S )Nr �keyzGet a specific field::r z # curl {}/{}/{}z7Get a specific item when field matchs the given value::z # curl {}/{}/{}/{})
r r r �keysr
Zget_stats_itemr r r r r r Zget_stats_value)r r � stat_export�item�valueZ stat_itemr r r �print_plugin_item_valuej s2
$ r, c C sV d} t | � t dt| � � t d� t d� t d� t djt�� t d� t d� d S )Nz
GET all statsr r zGet all Glances stats::z # curl {}/allzZ Return a very big dictionnary (avoid using this request, performances will be poor)...)r r
r r )r r r r � print_all� s r- c C sd t jd� | j� t jd� | j� d}t|� tdt|� � td� td� td� tdjt�� tttj | j
d�j dd ���� td� td
� td� td jt�� tttj | j
d�j d d ���� td� td
� td� tdjt�� tttj | j
d�j d���� td� td� td� tdjt�� tttj | j
d�j dd d ���� td� d S )Nr zGET stats historyr r zHistory of a plugin::z # curl {}/cpu/history�cpu� )Znbz Limit history to last 2 values::z # curl {}/cpu/history/2r z History for a specific field::z # curl {}/cpu/system/history�systemz5Limit history for a specific field to last 2 values::) �timeZsleep�updater r
r r r r r �
get_pluginZget_stats_history)�statsr r r r �
print_history� s8
"r5 c C s� d}t |� t dt|� � t d� t d� t d� t djt�� t t| j� �� t d� t d� t d� t djt�� t t| jd�j�� t d� d S ) Nz GET limits (used for thresholds)r r zAll limits/thresholds::z # curl {}/all/limitsz&Limits/thresholds for the cpu plugin::z # curl {}/cpu/limitsr. )r r
r r r ZgetAllLimitsAsDictr3 Zlimits)r4 r r r r � print_limits� s r6 c @ s, e Zd ZdZd
dd�Zdd� Zd dd �ZdS ) �GlancesStdoutApiDocz2This class manages the fields description display.Nc C s || _ || _d S )N)�config�args)�selfr8 r9 r r r �__init__� s z GlancesStdoutApiDoc.__init__c C s d S )Nr )r: r r r �end� s zGlancesStdoutApiDoc.endr c C s� t t� t� tt|j�� x^t|j�D ]P}|j|�}|j� }|dks(|g ks(|i krXq(t||� t ||� t
|||� q(W t � t |� t
|� dS )z
Display issueNT)r �
APIDOC_HEADERr r �sortedZ_pluginsr3 Z
get_exportr r& r, r- r5 r6 )r: r4 Zdurationr r r) r r r r2 � s
zGlancesStdoutApiDoc.update)NN)r )�__name__�
__module__� __qualname__�__doc__r; r< r2 r r r r r7 � s
r7 )r )rB �pprintr r r1 Zglances.loggerr Zglances.compatr r r= r r r r r& r, r- r5 r6 �objectr7 r r r r �<module>
s"