Coverage for ramose / documentation.py: 100%

1# SPDX-FileCopyrightText: 2018-2021 Silvio Peroni <silvio.peroni@unibo.it> 

2# SPDX-FileCopyrightText: 2020-2021 Marilena Daquino <marilena.daquino2@unibo.it> 

3# SPDX-FileCopyrightText: 2022 Davide Brembilla 

4# SPDX-FileCopyrightText: 2024 Ivan Heibi <ivan.heibi2@unibo.it> 

5# SPDX-FileCopyrightText: 2025 Sergei Slinkin 

6# SPDX-FileCopyrightText: 2026 Arcangelo Massari <arcangelo.massari@unibo.it> 

7# 

8# SPDX-License-Identifier: ISC 

9 

10from abc import abstractmethod 

11 

12 

13class DocumentationHandler: 

14 def __init__(self, api_manager): 

15 """This class provides the main structure for returning a human-readable documentation of all 

16 the operations described in the configuration files handled by the APIManager specified as input.""" 

17 self.conf_doc = api_manager.all_conf 

18 

19 @abstractmethod 

20 def get_documentation(self, *args, **dargs) -> tuple[int, str]: 

21 """An abstract method that returns a string defining the human-readable documentation of the operations 

22 available in the input APIManager.""" 

23 # pragma: no cover 

24 

25 @abstractmethod 

26 def store_documentation(self, file_path, *args, **dargs) -> None: 

27 """An abstract method that store in the input file path (parameter 'file_path') the human-readable 

28 documentation of the operations available in the input APIManager.""" 

29 # pragma: no cover 

30 

31 @abstractmethod 

32 def get_index(self, *args, **dargs) -> str: 

33 """An abstract method that returns a string defining the index of all the various configuration files 

34 handled by the input APIManager.""" 

35 # pragma: no cover