:py:mod:`pywebui.reports`
=========================

.. py:module:: pywebui.reports


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   pywebui.reports.Report
   pywebui.reports.Script
   pywebui.reports.ReportMethods




.. py:class:: Report



   Report object.

   .. attribute:: date

      The date of creating report or date of last edition of script (Unix Epoch format).

      :type: int

   .. attribute:: user

      The name of user who edit.

      :type: str

   .. attribute:: fileName

      The name of report or script.

      :type: str

   .. attribute:: directory

      The directory name

      :type: str


.. py:class:: Script



   Script object.

   .. attribute:: date

      The date of creating report or date of last edition of script (Unix Epoch format).

      :type: int

   .. attribute:: user

      The name of user who edit.

      :type: str

   .. attribute:: fileName

      The name of report or script.

      :type: str

   .. attribute:: directory

      The directory name

      :type: str


.. py:class:: ReportMethods

   Encapsulates methods for manage reports.

   .. py:method:: _get_objects(self, attr, _class)


   .. py:method:: get_reports(self) -> List[Report]

      Returns the list of reports.


   .. py:method:: get_scripts(self) -> List[Script]

      Returns the list of scripts.


   .. py:method:: get_report(self, filename: str, directory: str) -> str

      Returns  details of report.


   .. py:method:: get_log(self, filename: str, directory: str) -> str

      Returns details of log file.


   .. py:method:: generate(self, script_dir: str, script_name: str, report_dir: str) -> bool

      Runs script to generate report.


   .. py:method:: export_report(self, filename: str, directory: str) -> str

      Returns report content.