msl.io.dataset_logging module

A Dataset that handles logging records.

class msl.io.dataset_logging.DatasetLogging(name, parent, level=0, attributes=None, logger=None, date_fmt=None, **kwargs)

Bases: Dataset, Handler

A Dataset that handles logging records.

Do not instantiate directly. Create a new DatasetLogging using create_dataset_logging().

Parameters:

• name (str) – A name to associate with the Dataset.

• parent (Group) – The parent Group to the Dataset.

• level (int or str, optional) – The logging level to use.

• attributes (list or tuple of str, optional) – The attribute names to include in the Dataset for each logging record.

• logger (Logger, optional) – The Logger that this DatasetLogging object will be added to. If None then it is added to the root Logger.

• date_fmt (str, optional) – The datetime format code to use to represent the asctime attribute in.

• **kwargs – Additional keyword arguments are passed to Dataset. The default behaviour is to append every logging record to the Dataset. This guarantees that the size of the Dataset is equal to the number of logging records that were added to it. However, this behaviour can decrease the performance if many logging records are added often because a copy of the data in the Dataset is created for each logging record that is added. You can improve the performance by specifying an initial size of the Dataset by including a shape or a size keyword argument. This will also automatically create additional empty rows in the Dataset, that is proportional to the size of the Dataset, if the size of the Dataset needs to be increased. If you do this then you will want to call remove_empty_rows() before writing DatasetLogging to a file or interacting with the data in DatasetLogging to remove the extra rows that were created.

property attributes

The attribute names used by the DatasetLogging object.

Type:

tuple of str

property date_fmt

The datetime format code that is used to represent the asctime attribute in.

Type:

str

property logger

The Logger that this DatasetLogging object is added to.

Type:

Logger

remove_empty_rows()

Remove empty rows from the Dataset.

If the DatasetLogging object was initialized with a shape or a size keyword argument then the size of the Dataset is always \(\geq\) to the number of logging records that were added to it. Calling this method will remove the rows in the Dataset that were not from a logging record.

remove_handler()

Remove this class’s Handler from the associated Logger.

After calling this method logging records are no longer added to the Dataset.

set_logger(logger)

Add this class’s Handler to a Logger.

Parameters:

logger (Logger) – The Logger to add this class’s Handler to.