ats_utilities.config_io.iwrite module

Module

iwrite.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 IWrite with method(s). Creates an interface for writing to configuration files.

class ats_utilities.config_io.iwrite.IWrite[source]

Bases: ABC

Defines abstract class IWrite with method(s). Creates an interface for writing to configuration files.

It defines:

attributes:

None

methods:
write_configuration - Write configuration to file.
__str__ - Returns the IWrite as string representation.
_abc_impl = <_abc._abc_data object>
abstractmethod write_configuration(config: Any) bool[source]

Write configuration to file.

Parameters:

config (<Any>) – Configuration object | None.

Returns:

True (success) | False (fail).

Return type:

<bool>

Exceptions:

NotImplementedError..