Source code for spinn_utilities.log_store
# Copyright (c) 2022 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from .abstract_base import abstractmethod
[docs]class LogStore(object):
"""
API supported by classes that can store logs for later retrieval.
"""
[docs] @abstractmethod
def store_log(self, level, message, timestamp=None):
"""
Writes the log message for later retrieval.
:param int level: The logging level.
:param str message: The logged message.
:param timestamp: The time-stamp of the message.
:type timestamp: ~datetime.datetime or None
"""
[docs] @abstractmethod
def retreive_log_messages(self, min_level=0):
"""
Retrieves all log messages at or above the `min_level`.
:param int min_level:
Constraint on the minimum logging level to retrieve.
:return:
A list of messages that satisfy the constraint.
:rtype: list(tuple(int, str))
"""
[docs] @abstractmethod
def get_location(self):
"""
Retrieves the location of the log store.
:rtype: str
"""