Source code for smartredis.srobject

# BSD 2-Clause License
#
# Copyright (c) 2021-2024, Hewlett Packard Enterprise
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from .smartredisPy import PySRObject, SRLoggingLevel
from .util import exception_handler, typecheck


[docs]class SRObject: def __init__(self, context: str) -> None: """Initialize a SRObject object :param context: logging context :type name: str """ typecheck(context, "context", (str, PySRObject)) if isinstance(context, str): self._name = context self._srobject = PySRObject(context) else: self._srobject = context
[docs] @exception_handler def log_data(self, level: SRLoggingLevel, data: str) -> None: """Conditionally log data if the logging level is high enough :param level: Minimum logging level for data to be logged :type name: enum :param data: Text of data to be logged :type name: str :raises RedisReplyError: if logging fails """ typecheck(level, "level", SRLoggingLevel) typecheck(data, "data", str) self._srobject.log_data(level, data)
[docs] @exception_handler def log_warning(self, level: SRLoggingLevel, data: str) -> None: """Conditionally log warning data if the logging level is high enough :param level: Minimum logging level for data to be logged :type name: enum :param data: Text of data to be logged :type name: str :raises RedisReplyError: if logging fails """ typecheck(level, "level", SRLoggingLevel) typecheck(data, "data", str) self._srobject.log_warning(level, data)
[docs] @exception_handler def log_error(self, level: SRLoggingLevel, data: str) -> None: """Conditionally log error data if the logging level is high enough :param level: Minimum logging level for data to be logged :type name: enum :param data: Text of data to be logged :type name: str :raises RedisReplyError: if logging fails """ typecheck(level, "level", SRLoggingLevel) typecheck(data, "data", str) self._srobject.log_error(level, data)