omni.flux.validator.manager.core#

SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

pydantic model omni.flux.validator.manager.core.manager.ValidationSchema#

Show JSON schema

{
   "title": "ValidationSchema",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_finished_callback": {
         "default": null,
         "title": "On Finished Callback"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Uuid"
      },
      "data": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data"
      },
      "progress": {
         "default": 0.0,
         "title": "Progress",
         "type": "number"
      },
      "send_request": {
         "default": false,
         "title": "Send Request",
         "type": "boolean"
      },
      "context_plugin": {
         "$ref": "#/$defs/omni__flux__validator__factory__plugins__context_base__Schema"
      },
      "check_plugins": {
         "items": {
            "$ref": "#/$defs/omni__flux__validator__factory__plugins__check_base__Schema"
         },
         "title": "Check Plugins",
         "type": "array"
      },
      "resultor_plugins": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/omni__flux__validator__factory__plugins__resultor_base__Schema"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Resultor Plugins"
      },
      "validation_passed": {
         "default": false,
         "title": "Validation Passed",
         "type": "boolean"
      },
      "finished": {
         "default": [
            false,
            "Nothing"
         ],
         "maxItems": 2,
         "minItems": 2,
         "prefixItems": [
            {
               "type": "boolean"
            },
            {
               "type": "string"
            }
         ],
         "title": "Finished",
         "type": "array"
      }
   },
   "$defs": {
      "Data": {
         "properties": {},
         "title": "Data",
         "type": "object"
      },
      "omni__flux__validator__factory__plugins__check_base__Schema": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "enabled": {
               "default": true,
               "title": "Enabled",
               "type": "boolean"
            },
            "data": {
               "$ref": "#/$defs/Data"
            },
            "context_plugin": {
               "$ref": "#/$defs/omni__flux__validator__factory__plugins__context_base__Schema"
            },
            "selector_plugins": {
               "items": {
                  "$ref": "#/$defs/omni__flux__validator__factory__plugins__selector_base__Schema"
               },
               "title": "Selector Plugins",
               "type": "array"
            },
            "resultor_plugins": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/omni__flux__validator__factory__plugins__resultor_base__Schema"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resultor Plugins"
            },
            "stop_if_fix_failed": {
               "default": false,
               "title": "Stop If Fix Failed",
               "type": "boolean"
            },
            "pause_if_fix_failed": {
               "default": true,
               "title": "Pause If Fix Failed",
               "type": "boolean"
            }
         },
         "required": [
            "name",
            "data",
            "context_plugin",
            "selector_plugins"
         ],
         "title": "Schema",
         "type": "object"
      },
      "omni__flux__validator__factory__plugins__context_base__Schema": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "enabled": {
               "default": true,
               "title": "Enabled",
               "type": "boolean"
            },
            "data": {
               "$ref": "#/$defs/Data"
            },
            "resultor_plugins": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/omni__flux__validator__factory__plugins__resultor_base__Schema"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resultor Plugins"
            }
         },
         "required": [
            "name",
            "data"
         ],
         "title": "Schema",
         "type": "object"
      },
      "omni__flux__validator__factory__plugins__resultor_base__Schema": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "enabled": {
               "default": true,
               "title": "Enabled",
               "type": "boolean"
            },
            "data": {
               "$ref": "#/$defs/Data"
            }
         },
         "required": [
            "name",
            "data"
         ],
         "title": "Schema",
         "type": "object"
      },
      "omni__flux__validator__factory__plugins__selector_base__Schema": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "enabled": {
               "default": true,
               "title": "Enabled",
               "type": "boolean"
            },
            "data": {
               "$ref": "#/$defs/Data"
            }
         },
         "required": [
            "name",
            "data"
         ],
         "title": "Schema",
         "type": "object"
      }
   },
   "required": [
      "name",
      "context_plugin",
      "check_plugins"
   ]
}

Config:

validate_assignment: bool = True

Fields:

check_plugins (list[omni.flux.validator.factory.plugins.check_base.Schema])
context_plugin (omni.flux.validator.factory.plugins.context_base.Schema)
data (dict[Any, Any] | None)
finished (tuple[bool, str])
name (str)
on_finished_callback (Callable[[bool, str, bool], None] | None)
on_progress_callback (Callable[[float, bool], None] | None)
progress (float)
resultor_plugins (list[omni.flux.validator.factory.plugins.resultor_base.Schema] | None)
send_request (bool)
uuid (str | None)
validation_passed (bool)

Validators:

_fire_finished_callback » finished
_fire_progress_callback » progress
at_least_one » check_plugins
sanitize_uuid » uuid

field check_plugins: list[Schema] [Required]#

Validated by:

at_least_one

field context_plugin: Schema [Required]#

field data: dict[Any, Any] | None = None#

field finished: tuple[bool, str] = (False, 'Nothing')#

Validated by:

_fire_finished_callback

field name: str [Required]#

field on_finished_callback: Callable[[bool, str, bool], None] | None = None#

field on_progress_callback: Callable[[float, bool], None] | None = None#

field progress: float = 0.0#

Validated by:

_fire_progress_callback

field resultor_plugins: list[Schema] | None = None#

field send_request: bool = False#

field uuid: str | None = None#

Validated by:

sanitize_uuid

field validation_passed: bool = False#

validator at_least_one » check_plugins#

validator sanitize_uuid » uuid#

update( data: dict, ) → ValidationSchema#: This function updates the attributes of a ValidationSchema instance with new values provided in a dictionary. The update is performed recursively for nested models and lists within the model.

omni.flux.validator.manager.core.manager.disable_exception_traceback()#: All traceback information is suppressed and only the exception type and value are printed