# -*- coding: utf-8 -*-
###########################################################################
# Copyright (c), The AiiDA team. All rights reserved. #
# This file is part of the AiiDA code. #
# #
# The code is hosted on GitHub at https://github.com/aiidateam/aiida_core #
# For further information on the license, see the LICENSE.txt file #
# For further information please visit http://www.aiida.net #
###########################################################################
"""Backend group module"""
from __future__ import division
from __future__ import print_function
from __future__ import absolute_import
import abc
import six
from . import backends
__all__ = ('BackendLog', 'BackendLogCollection')
[docs]@six.add_metaclass(abc.ABCMeta)
class BackendLog(backends.BackendEntity):
"""
Backend Log interface
"""
@abc.abstractproperty
def uuid(self):
"""
Get the UUID of the log entry
:return: The entry's UUID
:rtype: uuid.UUID
"""
@abc.abstractproperty
def time(self):
"""
Get the time corresponding to the entry
:return: The entry timestamp
:rtype: :class:`!datetime.datetime`
"""
@abc.abstractproperty
def loggername(self):
"""
The name of the logger that created this entry
:return: The entry loggername
:rtype: basestring
"""
@abc.abstractproperty
def levelname(self):
"""
The name of the log level
:return: The entry log level name
:rtype: basestring
"""
@abc.abstractproperty
def dbnode_id(self):
"""
Get the id of the object that created the log entry
:return: The id of the object that created the log entry
:rtype: int
"""
@abc.abstractproperty
def message(self):
"""
Get the message corresponding to the entry
:return: The entry message
:rtype: basestring
"""
@abc.abstractproperty
def metadata(self):
"""
Get the metadata corresponding to the entry
:return: The entry metadata
:rtype: :class:`!json.json`
"""
[docs]@six.add_metaclass(abc.ABCMeta)
class BackendLogCollection(backends.BackendCollection[BackendLog]):
"""The collection of Log entries."""
ENTITY_CLASS = BackendLog
[docs] @abc.abstractmethod
def delete(self, log_id):
"""
Remove a Log entry from the collection with the given id
:param log_id: id of the log to delete
"""
[docs] @abc.abstractmethod
def delete_many(self, filters):
"""
Delete multiple log entries in the table
"""