o va@sdZddlmZddlZddlZddlmZddlmZdZ dZ dd d Z d d Z d dZ ddZddZddZddZddZGdddeZdS)z#Fields description interface class.)pformatN)logger) iteritemszhttp://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.  cCs\t|tr"t|dkr"t|dtr"|t|dddd|S|t|dd|S)Nr ) isinstancelistlendictrreplace)statindentrG/usr/lib/python3/dist-packages/glances/outputs/glances_stdout_apidoc.py indent_stat/s$ rcCsZd}t|tdt|tdtdtdtdttt|tddS)NzGET plugins list-zGet the plugins list::z # curl {}/pluginslist)printr formatAPI_URLr)r sub_titlerrrprint_plugins_list8s  rcCsbd|}t|tdt|tdtdtdtdt|tt|tddS)NzGET {}rrzGet plugin stats::z # curl {}/{})rrr rr)plugin stat_exportrrrrprint_plugin_exportDs   rcCs|jr7tdtdt|jD] \}}td||ddr'|dddn|d|dqtddStd|dS) NzFields descriptions:rz* **{}**: {} (unit is *{}*) description.Zunitz4No fields_description variable defined for plugin {})Zfields_descriptionrrrendswithrerror)rrZfieldrrrrprint_plugin_descriptionQs$ r"cCs\d}d}t|trt|d}d}n)t|tr=t|dkr=t|dtr=d|dvr3|dd}n t|dd}|ry||ryt||}t||trZ||d}n||}tdtdtd t ||tt |td|r|r| ||rtdtdtd t |||tt t| ||tddSdSdSdS)NrkeyzGet a specific field::rz # curl {}/{}/{}z7Get a specific item when field matchs the given value::z # curl {}/{}/{}/{}) r r r keysr Zget_stats_itemjsonloadsrrrrZget_stats_value)rrritemvalueZ stat_itemrrrprint_plugin_item_value_s4 $    r)cCsVd}t|tdt|tdtdtdtdttdtddS)Nz GET all statsrrzGet all Glances stats::z # curl {}/allzZ Return a very big dictionnary (avoid using this request, performances will be poor)...)rr rr)rrrr print_all}s r*cCsdtd|td|d}t|tdt|tdtdtdtdtttt | dj dd tdtd tdtd tttt | dj d d tdtd tdtdtttt | d dtdtdtdtdtttt | dj dd d tddS)NrzGET stats historyrrzHistory of a plugin::z # curl {}/cpu/historycpu)nbz Limit history to last 2 values::z # curl {}/cpu/history/2rzHistory for a specific field::z # curl {}/cpu/system/historysystemz5Limit history for a specific field to last 2 values::) timesleepupdaterr rrrr%r& get_pluginZget_stats_historystatsrrrr print_historys8    " r5cCsd}t|tdt|tdtdtdtdttt|tdtdtdtdttt|djtddS) Nz GET limits (used for thresholds)rrzAll limits/thresholds::z # curl {}/all/limitsz&Limits/thresholds for the cpu plugin::z # curl {}/cpu/limitsr+)rr rrrZgetAllLimitsAsDictr2Zlimitsr3rrr print_limitss r6c@s.eZdZdZd ddZddZ d dd ZdS) GlancesStdoutApiDocz< This class manages the fields description display. NcCs||_||_dSN)configargs)selfr9r:rrr__init__s zGlancesStdoutApiDoc.__init__cCsdSr8r)r;rrrendszGlancesStdoutApiDoc.endrcCstttt|jt|jD](}||}|}|dus'|gks'|ikr(qt||t||t |||qt t |t |dS)zDisplay issue NT) r APIDOC_HEADERrsortedZ_pluginsr2Z get_exportrr"r)r*r5r6)r;r4Zdurationrrrrrrr1s   zGlancesStdoutApiDoc.update)NN)r)__name__ __module__ __qualname____doc__r<r=r1rrrrr7s  r7)r)rCZpprintrr%r/Zglances.loggerrZglances.compatrrr>rrrr"r)r*r5r6objectr7rrrrs"