TestPopulator

class omni.kit.test.TestPopulator(name: str, description: str)

Bases: ABC

Base class for the objects used to populate the initial list of tests, before filtering.

Parameters:

• name (str) – Name of the populator, which can be used for a menu

• description (str) – Verbose description of the populator, which can be used for the tooltip of the menu item

Methods

__init__(name, description)	Initializes the TestPopulator with a name and description for setup.
destroy()	Opportunity to clean up any allocated resources.
get_tests(call_when_done)	Populate the internal list of raw tests and then call the provided function when it has been done.

__init__(name: str, description: str)

Initializes the TestPopulator with a name and description for setup.

destroy()

Opportunity to clean up any allocated resources.

abstract get_tests(call_when_done: callable)

Populate the internal list of raw tests and then call the provided function when it has been done. The callable takes one optional boolean ‘canceled’ that is only True if the test retrieval was not done.

Parameters:

call_when_done (callable) – Function to call when test retrieval completes; accepts an optional boolean canceled flag.