ats_utilities.option.ioption_command module

Module

ioption_command.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 IOptionCommand with method(s). Creates an interface for ATS command with options.

class ats_utilities.option.ioption_command.IOptionCommand

Bases: ABC

Defines abstract class IOptionCommand with method(s). Creates an interface for ATS command with options.

It defines:

attributes:

None

methods:

name - Returns the name of the command.

help_text - Returns the help text of the command.

options - Returns the list of options for the command.

__str__ - Returns the string representation of IOptionCommand.

_abc_impl = <_abc._abc_data object>

abstract property help_text: str

Returns the help text of the command.

Returns:

Help text of the command.

Return type:

<str>

Exceptions:

NotImplementedError.

abstract property name: str

Returns the name of the command.

Returns:

Name of the command.

Return type:

<str>

Exceptions:

None.

abstract property options: list[CommandOption]

Returns the list of options for the command.

Returns:

List of options for the command.

Return type:

<list[CommandOption]>

Exceptions:

NotImplementedError.