[isaacsim.test.docstring] Isaac Sim DocTest#

Version: 1.2.1

Provides test case base classes for validating Python docstring examples using Python’s doctest module in both standalone and async execution contexts.

Enable Extension#

The extension can be enabled (if not already) in one of the following ways:

Command-line interface

Define the next entry as an application argument from a terminal.

APP_SCRIPT.(sh|bat) --enable isaacsim.test.docstring

Experience/extension configuration

Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.

[dependencies]
"isaacsim.test.docstring" = {}

Extension Manager UI

Open the Window > Extensions menu in a running application instance and search for isaacsim.test.docstring. Then, toggle the enable control button if it is not already active.

API#

Python API#

Test Cases

`StandaloneDocTestCase`	Base class for all standalone test cases with doctest support for checking docstrings examples.
`AsyncDocTestCase`	Base class for all async test cases with doctest support for checking docstrings examples.

Test Cases#

class AsyncDocTestCase(*args: Any, **kwargs: Any)#

Bases: AsyncTestCase

Base class for all async test cases with doctest support for checking docstrings examples.

This class provides methods to validate that code examples in docstrings execute correctly. It is designed for Kit-based async test environments and inherits from omni.kit.test.AsyncTestCase.

Note

Derive from it to make the tests auto discoverable. Test methods must start with the test_ prefix.

This class adds the following methods:

assertDocTest: Check that the examples in docstrings pass for a class/module member.
assertDocTests: Check that the examples in docstrings pass for all class/module’s members.

Available Doctest Directives:

Use these directives in docstring examples to control test behavior:

# doctest: +NO_CHECK: Run the example but skip output verification.
# doctest: +SKIP: Skip this example entirely (don’t run it).
# doctest: +ELLIPSIS: Allow ... in expected output to match any substring.
# doctest: +NORMALIZE_WHITESPACE: Ignore whitespace differences.

Creating a Test File:

To test docstrings for an extension module or class, create a test file like this:

# test_docstrings.py
from isaacsim.test.docstring import AsyncDocTestCase
import my_extension_module

class TestDocstrings(AsyncDocTestCase):
    async def test_my_module_docstrings(self):
        # Test all members of a module
        await self.assertDocTests(my_extension_module)

    async def test_single_function(self):
        # Test a specific function (sync method)
        self.assertDocTest(my_extension_module.some_function)

    async def test_with_options(self):
        # Test with custom options
        await self.assertDocTests(
            my_extension_module.MyClass,
            exclude=[my_extension_module.MyClass.internal_method],
            stop_on_failure=True,  # Stop at first failure
            await_update=True,  # Await Kit update between tests
        )

Example:

>>> import isaacsim.test.docstring
>>> tester = isaacsim.test.docstring.AsyncDocTestCase()
>>> tester.__class__.__name__
'AsyncDocTestCase'

assertDocTest( expr: object, msg: str = '', flags: int = 1036, ) → None#

Check that the examples in docstrings pass for a class/module member

Parameters:

expr – module function or class definition, property or method to check docstrings examples for
msg (str) – custom message to display when failing
flags (int) – doctest’s option flags

Example:

>>> from isaacsim.test.docstring import AsyncDocTestCase
>>>
>>> tester.assertDocTest(AsyncDocTestCase)

async assertDocTests( expr: object, msg: str = '', flags: int = 1036, order: list[tuple[object, int]] = [], exclude: list[object] = [], stop_on_failure: bool = False, await_update: bool = True, ) → None#

Check that the examples in docstrings pass for all class/module’s members (names)

Parameters:

expr – module or class definition to check members’ docstrings examples for
msg (str) – custom message to display when failing
flags (int) – doctest’s option flags
order (list[tuple[object, int]]) – list of pair (name, index) to modify the examples execution order
exclude (list[object]) – list of class/module names to exclude for testing
stop_on_failure (bool) – stop testing docstrings example at fist encountered failure
await_update (bool) – await next kit application update async before running each docstrings example

Example:

>>> from isaacsim.test.docstring import AsyncDocTestCase
>>> from omni.kit.async_engine import run_coroutine
>>>
>>> async def task():
...     await tester.assertDocTests(AsyncDocTestCase, exclude=[AsyncDocTestCase.assertDocTests])
...
>>> run_coroutine(task())  

class StandaloneDocTestCase(*args, **kwargs)#

Bases: TestCase

Base class for all standalone test cases with doctest support for checking docstrings examples.

This class provides methods to validate that code examples in docstrings execute correctly. It is designed for standalone (non-Kit) test environments using Python’s unittest framework.

Note

Test methods must start with the test_ prefix.

This class adds the following methods:

assertDocTest: Check that the examples in docstrings pass for a class/module member.
assertDocTests: Check that the examples in docstrings pass for all class/module’s members.

Available Doctest Directives:

Use these directives in docstring examples to control test behavior:

# doctest: +NO_CHECK: Run the example but skip output verification.
# doctest: +SKIP: Skip this example entirely (don’t run it).
# doctest: +ELLIPSIS: Allow ... in expected output to match any substring.
# doctest: +NORMALIZE_WHITESPACE: Ignore whitespace differences.

Creating a Test File:

To test docstrings for a module or class, create a test file like this:

# test_docstrings.py
import unittest
from isaacsim.test.docstring import StandaloneDocTestCase
import my_module

class TestDocstrings(StandaloneDocTestCase):
    def test_my_module_docstrings(self):
        # Test all members of a module
        self.assertDocTests(my_module)

    def test_single_function(self):
        # Test a specific function
        self.assertDocTest(my_module.some_function)

    def test_with_exclusions(self):
        # Exclude specific members from testing
        self.assertDocTests(
            my_module.MyClass,
            exclude=[my_module.MyClass.internal_method]
        )

Example:

>>> import isaacsim.test.docstring
>>> tester = isaacsim.test.docstring.StandaloneDocTestCase()
>>> tester.__class__.__name__
'StandaloneDocTestCase'

failureException#: alias of AssertionError

classmethod addClassCleanup(function, /, *args, **kwargs)#: Same as addCleanup, except the cleanup items are called even if setUpClass fails (unlike tearDownClass).

addCleanup(function, /, *args, **kwargs)#

Add a function, with arguments, to be called when the test is completed. Functions added are called on a LIFO basis and are called after tearDown on test failure or success.

Cleanup items are called even if setUp fails (unlike tearDown).

addTypeEqualityFunc(typeobj, function)#

Add a type specific assertEqual style function to compare a type.

This method is for use by TestCase subclasses that need to register their own type equality functions to provide nicer error messages.

Parameters:

typeobj – The data type to call this function on when both values are of the same type in assertEqual().
function – The callable taking two arguments and an optional msg= argument that raises self.failureException with a useful error message when the two arguments are not equal.

assertAlmostEqual( first, second, places=None, msg=None, delta=None, )#

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is more than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

If the two objects compare equal then they will automatically compare almost equal.

assertCountEqual(first, second, msg=None)#

Asserts that two iterables have the same elements, the same number of times, without regard to order.

self.assertEqual(Counter(list(first)),
Counter(list(second)))

Example:

[0, 1, 1] and [1, 0, 1] compare equal.

[0, 0, 1] and [0, 1] compare unequal.

assertDictEqual(d1, d2, msg=None)#

assertDocTest( expr: object, msg: str = '', flags: int = 1036, ) → None#

Check that the examples in docstrings pass for a class/module member

Parameters:

expr – module function or class definition, property or method to check docstrings examples for
msg (str) – custom message to display when failing
flags (int) – doctest’s option flags

Example:

>>> from isaacsim.test.docstring import StandaloneDocTestCase
>>>
>>> tester.assertDocTest(StandaloneDocTestCase)

assertDocTests( expr: object, msg: str = '', flags: int = 1036, order: list[tuple[object, int]] = [], exclude: list[object] = [], stop_on_failure: bool = False, ) → None#

Check that the examples in docstrings pass for all class/module’s members (names)

Parameters:

expr – module or class definition to check members’ docstrings examples for
msg (str) – custom message to display when failing
flags (int) – doctest’s option flags
order (list[tuple[object, int]]) – list of pair (name, index) to modify the examples execution order
exclude (list[object]) – list of class/module names to exclude for testing
stop_on_failure (bool) – stop testing docstrings example at fist encountered failure

Example:

>>> from isaacsim.test.docstring import StandaloneDocTestCase
>>>
>>> tester.assertDocTests(StandaloneDocTestCase, exclude=[StandaloneDocTestCase.assertDocTests])
... 

assertEqual(first, second, msg=None)#: Fail if the two objects are unequal as determined by the ‘==’ operator.

assertFalse(expr, msg=None)#: Check that the expression is false.

assertGreater(a, b, msg=None)#: Just like self.assertTrue(a > b), but with a nicer default message.

assertGreaterEqual(a, b, msg=None)#: Just like self.assertTrue(a >= b), but with a nicer default message.

assertIn(member, container, msg=None)#: Just like self.assertTrue(a in b), but with a nicer default message.

assertIs(expr1, expr2, msg=None)#: Just like self.assertTrue(a is b), but with a nicer default message.

assertIsInstance(obj, cls, msg=None)#: Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.

assertIsNone(obj, msg=None)#: Same as self.assertTrue(obj is None), with a nicer default message.

assertIsNot(expr1, expr2, msg=None)#: Just like self.assertTrue(a is not b), but with a nicer default message.

assertIsNotNone(obj, msg=None)#: Included for symmetry with assertIsNone.

assertLess(a, b, msg=None)#: Just like self.assertTrue(a < b), but with a nicer default message.

assertLessEqual(a, b, msg=None)#: Just like self.assertTrue(a <= b), but with a nicer default message.

assertListEqual(list1, list2, msg=None)#

A list-specific equality assertion.

Parameters:

list1 – The first list to compare.
list2 – The second list to compare.
msg – Optional message to use on failure instead of a list of differences.

assertLogs(logger=None, level=None)#

Fail unless a log message of level level or higher is emitted on logger_name or its children. If omitted, level defaults to INFO and logger defaults to the root logger.

This method must be used as a context manager, and will yield a recording object with two attributes: output and records. At the end of the context manager, the output attribute will be a list of the matching formatted log messages and the records attribute will be a list of the corresponding LogRecord objects.

Example:

with self.assertLogs('foo', level='INFO') as cm:
    logging.getLogger('foo').info('first message')
    logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])

assertMultiLineEqual(first, second, msg=None)#: Assert that two multi-line strings are equal.

assertNoLogs(logger=None, level=None)#

Fail unless no log messages of level level or higher are emitted on logger_name or its children.

This method must be used as a context manager.

assertNotAlmostEqual( first, second, places=None, msg=None, delta=None, )#

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is less than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

Objects that are equal automatically fail.

assertNotEqual(first, second, msg=None)#: Fail if the two objects are equal as determined by the ‘!=’ operator.

assertNotIn(member, container, msg=None)#: Just like self.assertTrue(a not in b), but with a nicer default message.

assertNotIsInstance(obj, cls, msg=None)#: Included for symmetry with assertIsInstance.

assertNotRegex(text, unexpected_regex, msg=None)#: Fail the test if the text matches the regular expression.

assertRaises(

expected_exception,

*args,

**kwargs,

)#

Fail unless an exception of class expected_exception is raised by the callable when invoked with specified positional and keyword arguments. If a different type of exception is raised, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

If called with the callable and arguments omitted, will return a context object used like this:

with self.assertRaises(SomeException):
    do_something()

An optional keyword argument ‘msg’ can be provided when assertRaises is used as a context object.

The context manager keeps a reference to the exception as the ‘exception’ attribute. This allows you to inspect the exception after the assertion:

with self.assertRaises(SomeException) as cm:
    do_something()
the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)

assertRaisesRegex(

expected_exception,

expected_regex,

*args,

**kwargs,

)#

Asserts that the message in a raised exception matches a regex.

Parameters:

expected_exception – Exception class expected to be raised.
expected_regex – Regex (re.Pattern object or string) expected to be found in error message.
args – Function to be called and extra positional args.
kwargs – Extra kwargs.
msg – Optional message used in case of failure. Can only be used when assertRaisesRegex is used as a context manager.

assertRegex(text, expected_regex, msg=None)#: Fail the test unless the text matches the regular expression.

assertSequenceEqual( seq1, seq2, msg=None, seq_type=None, )#

An equality assertion for ordered sequences (like lists and tuples).

For the purposes of this function, a valid ordered sequence type is one which can be indexed, has a length, and has an equality operator.

Parameters:

seq1 – The first sequence to compare.
seq2 – The second sequence to compare.
seq_type – The expected datatype of the sequences, or None if no datatype should be enforced.
msg – Optional message to use on failure instead of a list of differences.

assertSetEqual(set1, set2, msg=None)#

A set-specific equality assertion.

Parameters:

set1 – The first set to compare.
set2 – The second set to compare.
msg – Optional message to use on failure instead of a list of differences.

assertSetEqual uses ducktyping to support different types of sets, and is optimized for sets specifically (parameters must support a difference method).

assertTrue(expr, msg=None)#: Check that the expression is true.

assertTupleEqual(tuple1, tuple2, msg=None)#

A tuple-specific equality assertion.

Parameters:

tuple1 – The first tuple to compare.
tuple2 – The second tuple to compare.
msg – Optional message to use on failure instead of a list of differences.

assertWarns(expected_warning, *args, **kwargs)#

Fail unless a warning of class warnClass is triggered by the callable when invoked with specified positional and keyword arguments. If a different type of warning is triggered, it will not be handled: depending on the other warning filtering rules in effect, it might be silenced, printed out, or raised as an exception.

If called with the callable and arguments omitted, will return a context object used like this:

with self.assertWarns(SomeWarning):
    do_something()

An optional keyword argument ‘msg’ can be provided when assertWarns is used as a context object.

The context manager keeps a reference to the first matching warning as the ‘warning’ attribute; similarly, the ‘filename’ and ‘lineno’ attributes give you information about the line of Python code from which the warning was triggered. This allows you to inspect the warning after the assertion:

with self.assertWarns(SomeWarning) as cm:
    do_something()
the_warning = cm.warning
self.assertEqual(the_warning.some_attribute, 147)

assertWarnsRegex(

expected_warning,

expected_regex,

*args,

**kwargs,

)#

Asserts that the message in a triggered warning matches a regexp. Basic functioning is similar to assertWarns() with the addition that only warnings whose messages also match the regular expression are considered successful matches.

Parameters:

expected_warning – Warning class expected to be triggered.
expected_regex – Regex (re.Pattern object or string) expected to be found in error message.
args – Function to be called and extra positional args.
kwargs – Extra kwargs.
msg – Optional message used in case of failure. Can only be used when assertWarnsRegex is used as a context manager.

countTestCases()#

debug()#: Run the test without collecting errors in a TestResult

defaultTestResult()#

classmethod doClassCleanups()#: Execute all class cleanup functions. Normally called for you after tearDownClass.

doCleanups()#: Execute all cleanup functions. Normally called for you after tearDown.

classmethod enterClassContext(cm)#: Same as enterContext, but class-wide.

enterContext(cm)#

Enters the supplied context manager.

If successful, also adds its __exit__ method as a cleanup function and returns the result of the __enter__ method.

fail(msg=None)#: Fail immediately, with the given message.

id()#

run(result=None)#

setUp()#: Hook method for setting up the test fixture before exercising it.

classmethod setUpClass()#: Hook method for setting up class fixture before running tests in the class.

shortDescription()#

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method’s docstring.

skipTest(reason)#: Skip this test.

subTest(msg=<object object>, **params)#: Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters. A failure in the subtest marks the test case as failed but resumes execution at the end of the enclosed block, allowing further test code to be executed.

tearDown()#: Hook method for deconstructing the test fixture after testing it.

classmethod tearDownClass()#: Hook method for deconstructing the class fixture after running all tests in the class.

longMessage = True#

maxDiff = 640#