ats_utilities.generator.ischeme_loader module

Module

ischeme_loader.py

Copyright

Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com> ats_utilities is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. ats_utilities is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Info

Defines abstract class ISchemeLoader with method(s). Interface for loading/resolving generation scheme.

class ats_utilities.generator.ischeme_loader.ISchemeLoader

Bases: ABC

Defines abstract class ISchemeLoader with method(s). Interface for loading/resolving generation scheme.

It defines:

attributes:

None.

methods:

load - Loads and resolves the scheme from dict or path.

is_initialized - Checks if the loader is initialized.

__str__ - Returns the loader as string representation.

_abc_impl = <_abc._abc_data object>

abstractmethod is_initialized() → bool

Checks if component is initialized.

Returns:

True (success) | False (fail).

Return type:

<bool>

Exceptions:

None.

abstractmethod load(scheme: dict[str, Any] | str) → dict[str, Any]

Loads and resolves the scheme.

Parameters:

scheme (<dict[str, Any] | str>) – Generation scheme mapping or file path.

Returns:

The resolved scheme dictionary.

Return type:

<dict[str, Any]>

Exceptions:

None.