-------------------------------------------
lines 6-73 of file: at_cascade/check_log.py
-------------------------------------------

{xrst_begin check_log}

Checks Logs For Warnings and Errors
###################################

Prototype
*********
{xrst_literal ,
   # BEGIN_DEF, # END_DEF
   # BEGIN_RETURN, # END_RETURN
}

Purpose
*******
Read the logs for a cascade and return all the messages of a certain type.
The databases are not modified (are opened in a read only fashion).

message_type
************
is  equal to ``error``, ``warning`` or ``at_cascade`` .
The corresponding messages are returned.

all_node_database
*****************
specifies the location of the
:ref:`all_node_db-name`
relative to the current working directory.
This argument can't be ``None``.

root_database
*************
specifies the location of the dismod_at
:ref:`glossary@root_database`.

job_table
*********
This is the :ref:`create_job_table@job_table` that we are checking
the log messages in.
Only jobs for which :ref:`create_job_table@job_table@prior_only` is false
are included; i.e., only jobs that correspond to fits.

start_job_id
************
This is the job that the log messages should start at.
If this is None, the first job in the job table is the start job.
Jobs before this job in the :ref:`create_job_table@job_table`
are not included.

max_job_depth
*************
This is the number of generations below the start job that are included;
see :ref:`job_descendant@Node Depth Versus Job Depth` .
If *max_job_depth* is None, all the jobs below the start job are included.
If *max_job_depth* is zero, only the start job is included.

message_dict
************
For each :ref:`create_job_table@job_table@job_name` in the job table
that is a key in *message_dict*.  The corresponding value

| *message_dict* [ *job_name* ]


is a non-empty ``list`` of ``str`` containing the messages for that job.
If a *job_name* is not a *key* is in *message_dict*,
there were no messages of the specified type for that job.

{xrst_end check_log}