ats_utilities.checker.icontext_provider module

Module

icontext_provider.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 IContextProvider with method(s). Creates an interface for getting context for method(s) and function(s).

class ats_utilities.checker.icontext_provider.IContextProvider

Bases: ABC

Defines abstract class IContextProvider with method(s). Creates an interface for getting context for method(s) and function(s).

It defines:

attributes:

None

methods:

set_stack_index_caller - Sets the index in the call stack to identify the caller.

get_context - Returns a string representing the calling context.

__str__ - Returns the context provider as string representation.

_abc_impl = <_abc._abc_data object>

abstractmethod get_context() → str

Returns a string representing the calling context.

Returns:

Context information string

Return type:

<str>

Exceptions:

NotImplementedError.

abstractmethod set_stack_index_caller(stack_index_caller: int) → None

Sets the index in the call stack to identify the caller.

Parameters:

stack_index_caller (<int>) – Index in the call stack to identify the caller.

Exceptions:

NotImplementedError.