summaryrefslogtreecommitdiffstats
path: root/docs/source/reflect.rst
blob: 6c0767ac4ee86d3c34608b3e22d8330f9a845aaa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
``reflect.py``: Getting information about code
==============================================

Classes
*******

.. autoclass:: reflect.Reflect
    :members:

.. autoexception::  reflect.MonitoredFileNotInProducedFilesException

Thrown if the user has tried to monitor a file that isn't in the list of produced files in the :ref:`assessmentyaml`.

Functions
*********

.. autofunction:: reflect.gen_reflection_report

Generates a json file report. It is quite a complex structure, but it is made so users can add other rendering templates 
later on. For example, the :ref:`quickstart` looks like this:

.. literalinclude:: _static/simple.json
    :linenos:
    :language: yaml