omni.graph.tools#

Submodules Summary:

omni.graph.tools.ogn

Tools that support interacting with the .ogn format, including parsing and creation.

Classes Summary:

DeprecateMessage

Manager for deprecation messages, to make it efficient to prevent multiple logging of the same

DeprecatedDictConstant

Class that lets you show a warning or error when attempting to use a deprecated dict constant value.

DeprecatedStringConstant

Class that lets you show a warning or error when attempting to use a deprecated string constant value.

DeprecationError

Exception to raise when a hard-deprecated import, class, or function is attempted to be used.

DeprecationLevel

Enum describing how deprecations should be treated

ExtensionContentsBase

Base class for the management of the OmniGraph Python content of an extension.

ExtensionContentsStandalone

Variation of the ExtensionContents class that handles the case of node types not being part of a build.

ExtensionContentsV118

Variation of the ExtensionContents class that handles the case of node types that were generated in version

IndentedOutput

Helper class that provides output capabilities to messages with preserved indentation levels

OmniGraphExtensionError

Exception raised when there was an error in the extension’s node type analysis process

Settings

Manage the build settings that can be used for tuning the code generation. The settings are all available

Functions Summary:

DeprecatedClass

Decorator to deprecate a class.

DeprecatedImport

Decorator to deprecate a specific file or module import. Usually the functionality has been deprecated and

RenamedClass

Syntactic sugar to provide a class deprecation that is a simple renaming, where all of the functions in

autonode_developer_mode

Returns True if the developer mode of the AutoNode feature has been enabled. This can only be correctly done at

build_directory_metadata

Find all of the node type metadata that can be found in the given directory.

deprecated_constant_object

Class that lets you show a warning or error when attempting to use a deprecated constant object.

deprecated_function

Decorator to deprecate a function.

destroy_property

Call the destroy method on a property and set it to None - helps with garbage collection

function_trace

Debugging decorator that adds function call tracing, potentially gated by an environment variable.

get_node_type_names_from_metadata

Extract the list of fully qualified node type names from the generated metadata

import_tests_in_directory

Find all of the .ogn-generated tests in a module’s directory and import them into that module.

python_name_to_ui_name

Extract a readable name from a python function name.

set_registration_logging

Redefine the registration logging location.

shorten_string_lines_to

Convert a single long line into a list of shorter lines

supported_attribute_type_names

walk_with_excludes

Same usage as os.walk: