Function test_exception_with_note

Lib/test/test_doctest/test_doctest.py:3682–3742

>>> import _colorize >>> save_colorize = _colorize.COLORIZE >>> _colorize.COLORIZE = False >>> test_exception_with_note('Note') Traceback (most recent call last): ... ValueError: Text Note >>> test_exception_with_note('Note') # doctest: +IGNORE_EXCEPTION_DET

(note)

def test_exception_with_note(note):
    """
    >>> import _colorize
    >>> save_colorize = _colorize.COLORIZE
    >>> _colorize.COLORIZE = False

    >>> test_exception_with_note('Note')
    Traceback (most recent call last):
      ...
    ValueError: Text
    Note

    >>> test_exception_with_note('Note')  # doctest: +IGNORE_EXCEPTION_DETAIL
    Traceback (most recent call last):
      ...
    ValueError: Text
    Note

    >>> test_exception_with_note('''Note
    ... multiline
    ... example''')
    Traceback (most recent call last):
    ValueError: Text
    Note
    multiline
    example

    Different note will fail the test:

    >>> def f(x):
    ...     r'''
    ...     >>> exc = ValueError('message')
    ...     >>> exc.add_note('note')
    ...     >>> raise exc
    ...     Traceback (most recent call last):
    ...     ValueError: message
    ...     wrong note
    ...     '''
    >>> test = doctest.DocTestFinder().find(f)[0]
    >>> doctest.DocTestRunner(verbose=False).run(test)
    ... # doctest: +ELLIPSIS
    **********************************************************************
    File "...", line 5, in f
    Failed example:
        raise exc
    Expected:
        Traceback (most recent call last):
        ValueError: message
        wrong note
    Got:
        Traceback (most recent call last):
          ...
        ValueError: message
        note
    TestResults(failed=1, attempted=...)

    >>> _colorize.COLORIZE = save_colorize
    """