Fix module import error and add detailed error message.

Author: simon-ritchie

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "stubdoc"
-version = "0.1.5"
+version = "0.1.6"
 description = ""
 authors = ["simon-ritchie"]
 license = "MIT LICENSE"

stubdoc/__init__.py

@@ -1,2 +1,2 @@
-__version__: str = '0.1.5'
+__version__: str = '0.1.6'
 from stubdoc.stubdoc import add_docstring_to_stubfile

stubdoc/stubdoc.py

@@ -1,6 +1,8 @@
 """The module that implements core functions.
 """
 
+import sys
+import os
 import re
 import inspect
 import importlib
@@ -401,12 +403,21 @@ def _read_module(module_path: str) -> ModuleType:
     module : ModuleType
         Read module.
     """
-    name: str = module_path.replace('.py', '')
-    name = name.replace('/', '.')
-    name = name.replace('\\', '.')
-    while name.startswith('.'):
-        name = name.replace('.', '', 1)
-    module: ModuleType = importlib.import_module(name)
+    file_name: str = os.path.basename(module_path)
+    dir_path: str = module_path.replace(file_name, '', 1)
+    sys.path.append(dir_path)
+    package_name: str = module_path.replace('.py', '')
+    package_name = package_name.replace('/', '.')
+    package_name = package_name.replace('\\', '.')
+    while package_name.startswith('.'):
+        package_name = package_name.replace('.', '', 1)
+    try:
+        module: ModuleType = importlib.import_module(package_name)
+    except Exception:
+        raise Exception(
+            'Specified module import failed. Please check specified path'
+            ' is not a upper level directory or root directory (need to be'
+            f' able to import by package path style): {package_name}')
     return module
 
 

tests/test_stubdoc.py

@@ -46,6 +46,10 @@ def test__read_module() -> None:
         module_path='.\\stubdoc\\stubdoc.py')
     assert module == stubdoc
 
+    with pytest.raises(Exception):  # type: ignore
+        module = stubdoc._read_module(
+            './not_existing_module.py')
+
 
 class _TestClass1: