nvidia-nat 1.1.0a20251020__py3-none-any.whl

nat/utils/exception_handlers/schemas.py

@@ -0,0 +1,114 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025, 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
+#
+# http://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.
+
+import logging
+
+import yaml
+from pydantic import ValidationError
+
+logger = logging.getLogger(__name__)
+
+
+def schema_exception_handler(func, **kwargs):
+    """
+    A decorator that handles `ValidationError` exceptions for schema validation functions.
+
+    This decorator wraps a function that performs schema validation using Pydantic.
+    If a `ValidationError` is raised, it logs detailed error messages and raises a `ValueError` with the combined error
+    messages.
+
+    Parameters
+    ----------
+    func : callable
+        The function to be decorated. This function is expected to perform schema validation.
+
+    kwargs : dict
+        Additional keyword arguments to be passed to the function.
+
+    Returns
+    -------
+    callable
+        The wrapped function that executes `func` with exception handling.
+
+    Raises
+    ------
+    ValueError
+        If a `ValidationError` is caught, this decorator logs the error details and raises a `ValueError` with the
+        combined error messages.
+
+    Notes
+    -----
+    This decorator is particularly useful for functions that validate configurations or data models,
+    ensuring that any validation errors are logged and communicated clearly.
+
+    Examples
+    --------
+    >>> @schema_exception_handler
+    ... def validate_config(config_data):
+    ...     schema = MySchema(**config_data)
+    ...     return schema
+    ...
+    >>> try:
+    ...     validate_config(invalid_config)
+    ... except ValueError as e:
+    ...     logger.error("Caught error: %s", e)
+    Caught error: Invalid configuration: field1: value is not a valid integer; field2: field required
+    """
+
+    def inner_function(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except ValidationError as e:
+            error_messages = "; ".join([f"{error['loc'][0]}: {error['msg']}" for error in e.errors()])
+            log_error_message = f"Invalid configuration: {error_messages}"
+            logger.error(log_error_message)
+            raise ValueError(log_error_message) from e
+
+    return inner_function
+
+
+def yaml_exception_handler(func):
+    """
+    A decorator that handles YAML parsing exceptions.
+
+    This decorator wraps a function that performs YAML file operations.
+    If a YAML-related error occurs, it logs the error and raises a ValueError
+    with a clear error message.
+
+    Returns
+    -------
+    callable
+        The wrapped function that executes `func` with YAML exception handling.
+
+    Raises
+    ------
+    ValueError
+        If a YAML error is caught, with details about the parsing failure.
+    """
+
+    def inner_function(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except yaml.YAMLError as e:
+            log_error_message = f"Invalid YAML configuration: {str(e)}"
+            logger.error(log_error_message)
+            raise ValueError(log_error_message) from e
+
+        except Exception as e:
+            log_error_message = f"Error reading YAML file: {str(e)}"
+            logger.error(log_error_message)
+            raise ValueError(log_error_message) from e
+
+    return inner_function

nat/utils/io/model_processing.py

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, 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
+#
+# http://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.
+
+import re
+
+
+def remove_r1_think_tags(text: str):
+    pattern = r'(<think>)?.*?</think>\s*(.*)'
+
+    # Add re.DOTALL flag to make . match newlines
+    match = re.match(pattern, text, re.DOTALL)
+
+    if match:
+        return match.group(2)
+
+    return text

nat/utils/io/yaml_tools.py

@@ -0,0 +1,119 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025, 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
+#
+# http://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.
+
+import io
+import logging
+import typing
+
+import expandvars
+import yaml
+
+from nat.utils.type_utils import StrPath
+
+logger = logging.getLogger(__name__)
+
+
+def _interpolate_variables(value: str | int | float | bool | None) -> str | int | float | bool | None:
+    """
+    Interpolate variables in a string with the format ${VAR:-default_value}.
+    If the variable is not set, the default value will be used.
+    If no default value is provided, an empty string will be used.
+
+    Args:
+        value (str | int | float | bool | None): The value to interpolate variables in.
+
+    Returns:
+        str | int | float | bool | None: The value with variables interpolated.
+    """
+
+    if not isinstance(value, str):
+        return value
+
+    return expandvars.expandvars(value)
+
+
+def yaml_load(config_path: StrPath) -> dict:
+    """
+    Load a YAML file and interpolate variables in the format
+    ${VAR:-default_value}.
+
+    Args:
+        config_path (StrPath): The path to the YAML file to load.
+
+    Returns:
+        dict: The processed configuration dictionary.
+    """
+
+    # Read YAML file
+    with open(config_path, encoding="utf-8") as stream:
+        config_str = stream.read()
+
+    return yaml_loads(config_str)
+
+
+def yaml_loads(config: str) -> dict:
+    """
+    Load a YAML string and interpolate variables in the format
+    ${VAR:-default_value}.
+
+    Args:
+        config (str): The YAML string to load.
+
+    Returns:
+        dict: The processed configuration dictionary.
+    """
+
+    interpolated_config_str = _interpolate_variables(config)
+    assert isinstance(interpolated_config_str, str), "Config must be a string"
+
+    stream = io.StringIO(interpolated_config_str)
+    stream.seek(0)
+
+    # Load the YAML data
+    try:
+        config_data = yaml.safe_load(stream)
+    except yaml.YAMLError as e:
+        logger.error("Error loading YAML: %s", interpolated_config_str)
+        raise ValueError(f"Error loading YAML: {e}") from e
+
+    assert isinstance(config_data, dict)
+
+    return config_data
+
+
+def yaml_dump(config: dict, fp: typing.TextIO) -> None:
+    """
+    Dump a configuration dictionary to a YAML file.
+
+    Args:
+        config (dict): The configuration dictionary to dump.
+        fp (typing.TextIO): The file pointer to write the YAML to.
+    """
+    yaml.dump(config, stream=fp, indent=2, sort_keys=False)
+    fp.flush()
+
+
+def yaml_dumps(config: dict) -> str:
+    """
+    Dump a configuration dictionary to a YAML string.
+
+    Args:
+        config (dict): The configuration dictionary to dump.
+
+    Returns:
+        str: The YAML string.
+    """
+
+    return yaml.dump(config, indent=2)

nat/utils/log_levels.py

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, 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
+#
+# http://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.
+
+import logging
+
+# Define log level choices
+LOG_LEVELS = {
+    'DEBUG': logging.DEBUG,
+    'INFO': logging.INFO,
+    'WARNING': logging.WARNING,
+    'ERROR': logging.ERROR,
+    'CRITICAL': logging.CRITICAL
+}

nat/utils/log_utils.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, 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
+#
+# http://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.
+
+import logging
+
+
+class LogFilter(logging.Filter):
+    """
+    This class is used to filter log records based on a defined set of criteria.
+    """
+
+    def __init__(self, filter_criteria: list[str]):
+        self._filter_criteria = filter_criteria
+        super().__init__()
+
+    def filter(self, record: logging.LogRecord):
+        """
+        Evaluates whether a log record should be emitted based on the message content.
+
+        Returns:
+            False if the message content contains any of the filter criteria, True otherwise.
+        """
+        if any(match in record.getMessage() for match in self._filter_criteria):
+            return False
+        return True

nat/utils/metadata_utils.py

@@ -0,0 +1,74 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, 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
+#
+# http://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.
+
+from pydantic_core import PydanticUndefined
+
+from nat.data_models.common import TypedBaseModelT
+from nat.utils.type_utils import DecomposedType
+
+
+def generate_config_type_docs(config_type: TypedBaseModelT) -> str:
+    """Generates a docstring from configuration object to facilitate discovery.
+
+    Args:
+        config_type (TypedBaseModelT): A component configuration object.
+
+    Returns:
+        str: An enriched docstring, including model attributes and default values.
+    """
+
+    # Get the docstring
+    description_formatting = []
+    # Ensure uniform formatting of docstring
+    docstring = (config_type.__doc__ or "").strip().strip(".")
+    docstring = docstring + "." if docstring != "" else "Description unavailable."
+    description_formatting.append(docstring)
+    description_formatting.append("")
+    description_formatting.append("  Args:")
+
+    # Iterate over fields to get their documentation
+    for field_name, field_info in config_type.model_fields.items():
+
+        if (field_name == "type"):
+            field_name = "_type"
+
+        decomponsed_type = DecomposedType(field_info.annotation)
+
+        if not (decomponsed_type.is_union):
+            annotation = field_info.annotation.__name__
+        else:
+            annotation = field_info.annotation
+
+        default_string = ""
+        if ((field_info.get_default() is not PydanticUndefined) and (field_name != "_type")):
+            if issubclass(type(field_info.get_default()), str):
+                default_value = f'"{field_info.get_default()}"'
+            else:
+                default_value = field_info.get_default()
+            default_string += f" Defaults to {default_value}."
+
+        # Ensure uniform formatting of field info
+        field_info_description = (field_info.description or "").strip(".")
+        if field_info_description != "":
+            field_info_description = field_info_description + "."
+        else:
+            field_info_description = "Description unavailable."
+
+        parameter_string = f"    {field_name} ({annotation}): {field_info_description}{default_string}"
+        description_formatting.append(parameter_string)
+
+    description = "\n".join(description_formatting)
+
+    return description

nat/utils/optional_imports.py

@@ -0,0 +1,142 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025, 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
+#
+# http://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.
+
+import importlib
+import logging
+from types import ModuleType
+
+logger = logging.getLogger(__name__)
+
+
+class OptionalImportError(Exception):
+    """Raised when an optional import fails."""
+
+    def __init__(self, module_name: str, additional_message: str = ""):
+        super().__init__(f"Optional dependency '{module_name}' is not installed. {additional_message}")
+
+
+class TelemetryOptionalImportError(OptionalImportError):
+    """Raised when an optional import of telemetry dependencies fails."""
+
+    def __init__(self, module_name: str):
+        super().__init__(
+            module_name,
+            "But the configuration file contains tracing exporters. "
+            "If you want to use this feature, please install it with: uv pip install -e '.[telemetry]'",
+        )
+
+
+def optional_import(module_name: str) -> ModuleType:
+    """Attempt to import a module, raising OptionalImportError if it fails."""
+    try:
+        return importlib.import_module(module_name)
+    except ImportError as e:
+        raise OptionalImportError(module_name) from e
+
+
+def telemetry_optional_import(module_name: str) -> ModuleType:
+    """Attempt to import a module, raising TelemetryOptionalImportError if it fails."""
+    try:
+        return importlib.import_module(module_name)
+    except ImportError as e:
+        raise TelemetryOptionalImportError(module_name) from e
+
+
+def try_import_opentelemetry() -> ModuleType:
+    """Get the opentelemetry module if available."""
+    return telemetry_optional_import("opentelemetry")
+
+
+def try_import_phoenix() -> ModuleType:
+    """Get the phoenix module if available."""
+    return telemetry_optional_import("phoenix")
+
+
+# Dummy OpenTelemetry classes for when the package is not available
+class DummySpan:
+    """Dummy span class that does nothing when OpenTelemetry is not available."""
+
+    def __init__(self, *args, **kwargs):
+        pass
+
+    def end(self, *args, **kwargs):
+        pass
+
+    def set_attribute(self, *args, **kwargs):
+        pass
+
+
+class DummyTracer:
+    """Dummy tracer class that returns dummy spans."""
+
+    def start_span(self, *args, **kwargs):
+        return DummySpan()
+
+
+class DummyTracerProvider:
+    """Dummy tracer provider that returns dummy tracers."""
+
+    @staticmethod
+    def get_tracer(*args, **kwargs):
+        return DummyTracer()
+
+    @staticmethod
+    def add_span_processor(*args, **kwargs):
+        pass
+
+
+class DummyTrace:
+    """Dummy trace module that returns dummy tracer providers."""
+
+    @staticmethod
+    def get_tracer_provider():
+        return DummyTracerProvider()
+
+    @staticmethod
+    def set_tracer_provider(*args, **kwargs):
+        pass
+
+    @staticmethod
+    def get_tracer(*args, **kwargs):
+        return DummyTracer()
+
+
+class DummySpanExporter:
+    """Dummy span exporter that does nothing."""
+
+    @staticmethod
+    def export(*args, **kwargs):
+        pass
+
+    @staticmethod
+    def shutdown(*args, **kwargs):
+        pass
+
+
+class DummyBatchSpanProcessor:
+    """Dummy implementation of BatchSpanProcessor for when OpenTelemetry is not available."""
+
+    def __init__(self, *args, **kwargs):
+        pass
+
+    @staticmethod
+    def shutdown(*args, **kwargs):
+        pass
+
+
+# Dummy functions for when OpenTelemetry is not available
+def dummy_set_span_in_context(*args, **kwargs) -> None:
+    """Dummy function that does nothing."""
+    return None