omni.flux.validator.mass.core

• Overview
• Changelog

• 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.

• 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.

class omni.flux.validator.mass.core.data_models.enums.Executors(value)

An enumeration.

• 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.mass.core.data_models.models.MassValidationResponseModel

Show JSON schema

{
   "title": "MassValidationResponseModel",
   "type": "object",
   "properties": {
      "completed_schemas": {
         "items": {
            "additionalProperties": true,
            "type": "object"
         },
         "title": "Completed Schemas",
         "type": "array"
      }
   },
   "required": [
      "completed_schemas"
   ]
}

Config:

• extra: str = ignore

Fields:

• completed_schemas (list[dict])

field completed_schemas: list[dict] [Required]

• 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.

• 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.

class omni.flux.validator.mass.core.schema_tree.model.Item(data)

Item of the model

async build_ui()

Build the Mass UI. For each plugin, run the mass_build_ui() function if the plugin exposes it.

can_item_have_children(

item: Item,

) → bool

Define if the item can have children or not

Parameters:

item – the item itself

Returns:

If the item can has a children or not

async cook_template_no_exception() → List[Dict[Any, Any]]

Cook template: meaning that from some input template(s), we can generate others templates. The idea of “cooking” is that a plugin can “edit” template(s) and give back edited template(s).

The algo is: if a plugin return a list of templates during the cooking, the input template will be replaced by this list like: [template01] -> [cooked_template01_01, cooked_template01_02, cooked_template01_03…].

For example, imagine a template where a plugin has a list of files as a data attribute. Cooking can be that the plugin generates 1 new template for each file. From here, the Validator can process each template one by one, and not all files in one process.

Returns:

List of new/cooked template

property model: ManagerCore

The model

show(value: bool)

Called whenever the item is show or hidden in the UI.

subscribe_mass_cook_template(

callback: Callable[[Any], Any],

)

Return the object that will automatically unsubscribe when destroyed.

subscribe_mouse_released(

function: Callable[[Item], Any],

)

Subscribe to the on_value_changed_callback event.

Parameters:

function – the callback to execute when the event is triggered

Returns:

An object that will automatically unsubscribe when destroyed.

property title: str

The title that will be showed on the tree

class omni.flux.validator.mass.core.schema_tree.model.Model

Basic list model

add_schemas(

datas: List[Dict[Any, Any]],

)

Set the items to show

get_item_children(

item: Item | None,

)

Returns all the children when the widget asks it.

get_item_value_model(item, column_id)

Return value model. It’s the object that tracks the specific value. In our case we use ui.SimpleStringModel.

get_item_value_model_count(

item: Item,

)

The number of columns

subscribe_mass_cook_template(

callback: Callable[[Any], Any],

)

Return the object that will automatically unsubscribe when destroyed.