[doc] Add sphinx-autodoc-typehints to use Python 3 annotations for documenting argument types (#94)

Author: 2xyo

.gitignore

@@ -12,4 +12,5 @@ test.py
 examples/*.json
 examples/*.pdf
 docs/_build
-Pipfile*
+Pipfile*
+.mypy_cache/

docs/conf.py

@@ -34,7 +34,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.inheritance_diagram", "autoapi.sphinx"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.inheritance_diagram",
+    "autoapi.sphinx",
+    "sphinx_autodoc_typehints",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/requirements.txt

@@ -1 +1,3 @@
-autoapi>=2.0.1
+autoapi>=2.0.1
+sphinx_rtd_theme>=0.4.3
+sphinx-autodoc-typehints>=1.10.3

pycti/connector/opencti_connector_helper.py

@@ -8,27 +8,21 @@
 import uuid
 import os
 
-from typing import Callable, Dict, List, Union
+from typing import Callable, Dict, List, Optional, Union
 from pika.exceptions import UnroutableError, NackError
 from pycti.api.opencti_api_client import OpenCTIApiClient
 from pycti.connector.opencti_connector import OpenCTIConnector
 
 
 def get_config_variable(
-    env_var: str, yaml_path: str, config={}, isNumber=False
-) -> Union[str, int]:
+    env_var: str, yaml_path: str, config: Dict = {}, isNumber: Optional[bool] = False
+) -> Union[bool, int, None, str]:
     """[summary]
 
     :param env_var: environnement variable name
-    :type env_var: str
     :param yaml_path: path to yaml config
-    :type yaml_path: str
     :param config: client config dict, defaults to {}
-    :type config: dict, optional
     :param isNumber: specify if the variable is a number, defaults to False
-    :type isNumber: bool, optional
-    :return: either a str or a int variable value
-    :rtype: str or int
     """
 
     if os.getenv(env_var) is not None:

setup.py

@@ -62,5 +62,8 @@ def run(self):
         "python-magic-bin==0.4.14;sys.platform=='win32'",
     ],
     cmdclass={"verify": VerifyVersionCommand},
-    extras_require={"dev": ["black", "wheel"]},  # Optional
+    extras_require={
+        "dev": ["black", "wheel",],
+        "doc": ["autoapi", "sphinx_rtd_theme", "sphinx-autodoc-typehints"],
+    },  # Optional
 )