#19 Add type annotations to test_jupyter_notebook.py module.

Author: simon-ritchie

tests/test_jupyter_notebook.py

@@ -1,33 +1,36 @@
 import os
 import shutil
+from typing import List
 
 import pytest
 import six
 from voluptuous import Any, Schema
 
 from numdoclint import jupyter_notebook, py_module
 
-TMP_TEST_MODULE_DIR = './tests/tmp/'
-TMP_TEST_NOTEBOOK_PATH_1 = os.path.join(TMP_TEST_MODULE_DIR, 'tmp_1.ipynb')
-TMP_TEST_NOTEBOOK_PATH_2 = os.path.join(TMP_TEST_MODULE_DIR, 'tmp_2.ipynb')
+TMP_TEST_MODULE_DIR: str = './tests/tmp/'
+TMP_TEST_NOTEBOOK_PATH_1: str = os.path.join(
+    TMP_TEST_MODULE_DIR, 'tmp_1.ipynb')
+TMP_TEST_NOTEBOOK_PATH_2: str = os.path.join(
+    TMP_TEST_MODULE_DIR, 'tmp_2.ipynb')
 
-STR_SCHEMA = Any(*six.string_types)
+STR_SCHEMA: Any = Any(*six.string_types)
 
 
-def setup():
+def setup() -> None:
     """Function to be executed at the start of the test.
     """
     shutil.rmtree(TMP_TEST_MODULE_DIR, ignore_errors=True)
     os.makedirs(TMP_TEST_MODULE_DIR)
 
 
-def teardown():
+def teardown() -> None:
     """Function to be executed at the end of the test.
     """
     shutil.rmtree(TMP_TEST_MODULE_DIR, ignore_errors=True)
 
 
-def _delete_test_notebook():
+def _delete_test_notebook() -> None:
     """Delete notebook for testing if exists.
     """
     if os.path.exists(TMP_TEST_NOTEBOOK_PATH_1):
@@ -36,10 +39,10 @@ def _delete_test_notebook():
         os.remove(TMP_TEST_NOTEBOOK_PATH_2)
 
 
-def test__check_notebook_exists():
+def test__check_notebook_exists() -> None:
     _delete_test_notebook()
 
-    with pytest.raises(IOError):
+    with pytest.raises(IOError):  # type: ignore
         jupyter_notebook._check_notebook_exists(
             notebook_path=TMP_TEST_NOTEBOOK_PATH_1)
 
@@ -51,28 +54,28 @@ def test__check_notebook_exists():
     _delete_test_notebook()
 
 
-def test__check_notebook_extension():
-    with pytest.raises(IOError):
+def test__check_notebook_extension() -> None:
+    with pytest.raises(IOError):  # type: ignore
         jupyter_notebook._check_notebook_extension(
             notebook_path='sample/path.py')
     jupyter_notebook._check_notebook_extension(
         notebook_path='sample/path.ipynb')
 
 
-def test__read_notebook_data_dict():
-    notebook_data_dict = jupyter_notebook._read_notebook_data_dict(
+def test__read_notebook_data_dict() -> None:
+    notebook_data_dict: dict = jupyter_notebook._read_notebook_data_dict(
         notebook_path='./tests/jupyter/test_jupyter_notebook_py3.ipynb')
     assert isinstance(notebook_data_dict, dict)
-    has_key = 'cells' in notebook_data_dict
+    has_key: bool = 'cells' in notebook_data_dict
     assert has_key
 
 
-def test__get_code_cell_str_list():
-    code_str_list = jupyter_notebook._get_code_cell_str_list(
+def test__get_code_cell_str_list() -> None:
+    code_str_list: List[str] = jupyter_notebook._get_code_cell_str_list(
         notebook_data_dict={})
     assert code_str_list == []
 
-    notebook_data_dict = {
+    notebook_data_dict: dict = {
         'cells': [{
             'cell_type': 'code',
             'source': [
@@ -97,14 +100,14 @@ def test__get_code_cell_str_list():
     code_str_list = jupyter_notebook._get_code_cell_str_list(
         notebook_data_dict=notebook_data_dict)
     assert len(code_str_list) == 2
-    expected_code_str = 'import pandas as pd\nimport numpy as np'
+    expected_code_str: str = 'import pandas as pd\nimport numpy as np'
     assert code_str_list[0] == expected_code_str
     expected_code_str = 'def sample_func():\n    pass'
     assert code_str_list[1] == expected_code_str
 
 
-def test__rename_dict_key():
-    info_list = [{
+def test__rename_dict_key() -> None:
+    info_list: List[dict]= [{
         py_module.INFO_KEY_MODULE_PATH: 'sample/path.ipynb',
         py_module.INFO_KEY_FUNC_NAME: 'sample_func_1',
         py_module.INFO_KEY_INFO_ID: 1,
@@ -118,7 +121,7 @@ def test__rename_dict_key():
     info_list = jupyter_notebook._rename_dict_key(
         info_list=info_list)
     assert len(info_list) == 2
-    schema = Schema(
+    schema: Schema = Schema(
         schema={
             jupyter_notebook.INFO_KEY_NOTEBOOK_PATH: 'sample/path.ipynb',
             jupyter_notebook.INFO_KEY_FUNC_NAME: Any(
@@ -132,13 +135,13 @@ def test__rename_dict_key():
         schema(info_dict)
 
 
-def test__add_code_cell_index():
-    info_list = [{}, {}]
+def test__add_code_cell_index() -> None:
+    info_list: List[dict]= [{}, {}]
     info_list = jupyter_notebook._add_code_cell_index(
         info_list=info_list,
         code_cell_idx=5)
     assert len(info_list) == 2
-    schema = Schema(
+    schema: Schema= Schema(
         schema={
             jupyter_notebook.INFO_KEY_CODE_CELL_INDEX: 5,
         },
@@ -147,14 +150,14 @@ def test__add_code_cell_index():
         schema(info_dict)
 
 
-def test__check_unit_code_cell_str():
-    expected_notebook_path = 'sample/path.ipynb'
-    expected_code_cell_idx = 5
-    code_cell_str = """
+def test__check_unit_code_cell_str() -> None:
+    expected_notebook_path: str = 'sample/path.ipynb'
+    expected_code_cell_idx: int = 5
+    code_cell_str: str = """
 import pandas as pd
 import numpy as np
     """
-    info_list = jupyter_notebook._check_unit_code_cell_str(
+    info_list: List[dict] = jupyter_notebook._check_unit_code_cell_str(
         notebook_path=expected_notebook_path,
         code_cell_idx=expected_code_cell_idx,
         code_cell_str=code_cell_str,
@@ -163,7 +166,7 @@ def test__check_unit_code_cell_str():
         enable_default_or_optional_doc_check=False)
     assert info_list == []
 
-    schema = Schema(
+    schema: Schema= Schema(
         schema={
             jupyter_notebook.INFO_KEY_NOTEBOOK_PATH: STR_SCHEMA,
             jupyter_notebook.INFO_KEY_CODE_CELL_INDEX: int,
@@ -250,12 +253,12 @@ def sample_func(price=100):
     assert info_list
 
 
-def test__print_info_list():
-    printed_str = jupyter_notebook._print_info_list(
+def test__print_info_list() -> None:
+    printed_str: str = jupyter_notebook._print_info_list(
         info_list=[], verbose=jupyter_notebook.VERBOSE_ENABLED)
     assert printed_str == ''
 
-    info_list = [{
+    info_list: List[dict] = [{
         jupyter_notebook.INFO_KEY_NOTEBOOK_PATH: 'sample/path.ipynb',
         jupyter_notebook.INFO_KEY_CODE_CELL_INDEX: 5,
         jupyter_notebook.INFO_KEY_FUNC_NAME: 'sample_func_1',
@@ -286,7 +289,7 @@ def test__print_info_list():
     assert 'Sample infomation 2.' in printed_str
 
 
-schema = Schema(
+schema: Schema = Schema(
     schema={
         jupyter_notebook.INFO_KEY_NOTEBOOK_PATH: STR_SCHEMA,
         jupyter_notebook.INFO_KEY_CODE_CELL_INDEX: int,
@@ -296,9 +299,9 @@ def test__print_info_list():
     }, required=True)
 
 
-def test_check_jupyter_notebook():
-    notebook_path = './tests/jupyter/test_jupyter_notebook_py3.ipynb'
-    info_list = jupyter_notebook.check_jupyter_notebook(
+def test_check_jupyter_notebook() -> None:
+    notebook_path: str = './tests/jupyter/test_jupyter_notebook_py3.ipynb'
+    info_list: List[dict] = jupyter_notebook.check_jupyter_notebook(
         notebook_path=notebook_path,
         verbose=0,
         ignore_func_name_prefix_list=[],
@@ -309,7 +312,7 @@ def test_check_jupyter_notebook():
         schema(info_dict)
     assert len(info_list) >= 10
 
-    ignore_info_id_list = [
+    ignore_info_id_list: List[int]= [
         info_dict[jupyter_notebook.INFO_KEY_INFO_ID]
         for info_dict in info_list]
 
@@ -340,8 +343,8 @@ def test_check_jupyter_notebook():
     assert info_list == []
 
 
-def test_check_jupyter_notebook_recursively():
-    info_list = jupyter_notebook.check_jupyter_notebook_recursively(
+def test_check_jupyter_notebook_recursively() -> None:
+    info_list: List[dict] = jupyter_notebook.check_jupyter_notebook_recursively(
         dir_path='./numdoclint/',
         verbose=jupyter_notebook.VERBOSE_DISABLED,
         ignore_func_name_prefix_list=[],
@@ -358,13 +361,13 @@ def test_check_jupyter_notebook_recursively():
     assert info_list
     for info_dict in info_list:
         schema(info_dict)
-    notebook_path_list = [
+    notebook_path_list: List[str] = [
         info_dict[jupyter_notebook.INFO_KEY_NOTEBOOK_PATH]
         for info_dict in info_list]
-    unique_path_list = list(set(notebook_path_list))
+    unique_path_list: List[str] = list(set(notebook_path_list))
     assert len(unique_path_list) > 1
 
-    ignore_info_id_list = [
+    ignore_info_id_list: List[int] = [
         info_dict[jupyter_notebook.INFO_KEY_INFO_ID]
         for info_dict in info_list]