# Copyright (c) 2013 Potential Ventures Ltd
# Copyright (c) 2013 SolarFlare Communications Inc
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * 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.
# * Neither the name of Potential Ventures Ltd,
# SolarFlare Communications Inc nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# 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 POTENTIAL VENTURES LTD 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.
import sys
# TODO: Could use cStringIO?
import traceback
import warnings
from io import StringIO
"""Exceptions and functions for simulation result handling."""
[docs]
def raise_error(obj, msg):
"""Create a :exc:`TestError` exception and raise it after printing a traceback.
.. deprecated:: 1.3
Raise a standard Python exception instead of calling this function.
A stacktrace will be printed by cocotb automatically if the exception is unhandled.
Args:
obj: Object with a log method.
msg (str): The log message.
"""
warnings.warn(
"``raise_error`` is deprecated - raise a standard Exception instead",
DeprecationWarning,
stacklevel=2,
)
_raise_error(obj, msg)
def _raise_error(obj, msg):
exc_info = sys.exc_info()
buff = StringIO()
traceback.print_exception(*exc_info, file=buff)
obj.log.error(f"{msg}\n{buff.getvalue()}")
exception = TestError(msg)
exception.stderr.write(buff.getvalue())
raise exception
[docs]
def create_error(obj, msg):
"""Like :func:`raise_error`, but return the exception rather than raise it,
simply to avoid too many levels of nested `try/except` blocks.
.. deprecated:: 1.3
Raise a standard Python exception instead of calling this function.
Args:
obj: Object with a log method.
msg (str): The log message.
"""
warnings.warn(
"``create_error`` is deprecated - raise a standard Exception instead",
DeprecationWarning,
stacklevel=2,
)
try:
# use the private version to avoid multiple warnings
_raise_error(obj, msg)
except TestError as error:
return error
return TestError("Creating error traceback failed")
[docs]
class ReturnValue(Exception):
"""
Helper exception needed for Python versions prior to 3.3.
.. deprecated:: 1.4
Use a :keyword:`return` statement instead; this works in all supported versions of Python.
"""
def __init__(self, retval):
warnings.warn(
"``ReturnValue`` is deprecated, use a normal return statement instead.",
DeprecationWarning,
stacklevel=2,
)
self.retval = retval
[docs]
class TestComplete(Exception):
"""
Exception showing that the test was completed. Sub-exceptions detail the exit status.
.. deprecated:: 1.6.0
The ``stdout`` and ``stderr`` attributes.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.__stdout = StringIO()
self.__stderr = StringIO()
@staticmethod
def __deprecated(which: str) -> None:
warnings.warn(
f"Attribute {which} is deprecated and will be removed in the next major release",
DeprecationWarning,
stacklevel=3,
)
@property
def stdout(self) -> StringIO:
self.__deprecated("stdout")
return self.__stdout
@stdout.setter
def stdout(self, new_value: StringIO) -> None:
self.__deprecated("stdout")
self.__stdout = new_value
@property
def stderr(self) -> StringIO:
self.__deprecated("stderr")
return self.__stderr
@stderr.setter
def stderr(self, new_value: StringIO) -> None:
self.__deprecated("stderr")
self.__stderr = new_value
[docs]
class ExternalException(Exception):
"""Exception thrown by :class:`cocotb.external` functions."""
def __init__(self, exception):
self.exception = exception
[docs]
class TestError(TestComplete):
"""
Exception showing that the test was completed with severity Error.
.. deprecated:: 1.5
Raise a standard Python exception instead.
A stacktrace will be printed by cocotb automatically if the exception is unhandled.
"""
def __init__(self, *args, **kwargs):
warnings.warn(
"TestError is deprecated - raise a standard Exception instead",
DeprecationWarning,
stacklevel=2,
)
super().__init__(*args, **kwargs)
[docs]
class TestFailure(TestComplete, AssertionError):
"""
Exception showing that the test was completed with severity Failure.
.. deprecated:: 1.6.0
Use a standard ``assert`` statement instead of raising this exception.
Use ``expect_fail`` rather than ``expect_error`` with this exception in the
:class:`cocotb.test` decorator.
"""
def __init__(self, *args, **kwargs):
warnings.warn(
"TestFailure is deprecated, use an ``assert`` statement instead",
DeprecationWarning,
stacklevel=2,
)
super().__init__(*args, **kwargs)
[docs]
class TestSuccess(TestComplete):
"""Exception showing that the test was completed successfully."""
pass
[docs]
class SimFailure(TestComplete):
"""Exception showing that the simulator exited unsuccessfully."""
pass
[docs]
class SimTimeoutError(TimeoutError):
"""Exception for when a timeout, in terms of simulation time, occurs."""
pass