Add methods to skip lint check and fix typehint regex

packages/python-packages/api-stub-generator/apistub/_stub_generator.py

@@ -31,7 +31,7 @@
 
 INIT_PY_FILE = "__init__.py"
 
-logging.getLogger().setLevel(logging.INFO)
+logging.getLogger().setLevel(logging.ERROR)
 
 
 class StubGenerator:
@@ -87,7 +87,7 @@ def generate_tokens(self):
             pkg_root_path = self.pkg_path
             pkg_name, version, namespace = parse_setup_py(pkg_root_path)
 
-        logging.debug("package name: {0}, version:{1}".format(pkg_name, version))
+        logging.debug("package name: {0}, version:{1}, namespace:{2}".format(pkg_name, version, namespace))
 
         logging.debug("Installing package from {}".format(self.pkg_path))
         self._install_package(pkg_name)
@@ -156,8 +156,18 @@ def _generate_tokens(self, pkg_root_path, package_name, version, namespace):
         apiview = ApiView(nodeindex, package_name, 0, version, namespace)
         modules = self._find_modules(pkg_root_path)
         logging.debug("Modules to generate tokens: {}".format(modules))
+
+        # find root module name
+        root_module = ""
+        if namespace:
+            root_module = namespace.split(".")[0]
+
         # load all modules and parse them recursively
         for m in modules:
+            if not m.startswith(root_module):
+                logging.debug("Skipping module {0}. Module should start with {1}".format(m, root_module))
+                continue
+
             logging.debug("Importing module {}".format(m))
             try:
                 module_obj = importlib.import_module(m)

packages/python-packages/api-stub-generator/apistub/_version.py

@@ -1,4 +1,4 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-VERSION = "0.1.1"
+VERSION = "0.1.2"

packages/python-packages/api-stub-generator/apistub/nodes/_docstring_parser.py

@@ -17,7 +17,7 @@
 find_docstring_return_type = "(?<!:):rtype\s?:\s+([^:\n]+)(?!:)"
 
 # Regex to parse type hints
-find_type_hint_ret_type = "(?<!#)#\stype:[\s\S]*->\s?([^\n]*)"
+find_type_hint_ret_type = "(?<!#)#\s+type:[^\n]*->\s+([^\n]*)"
 
 docstring_types = ["param", "type", "paramtype", "keyword", "rtype"]
 

packages/python-packages/api-stub-generator/apistub/nodes/_function_node.py

@@ -12,9 +12,20 @@
 KW_ARG_NAME = "**kwargs"
 VALIDATION_REQUIRED_DUNDER = ["__init__",]
 KWARG_NOT_REQUIRED_METHODS = ["close",]
-TYPEHINT_NOT_REQUIRED_METHODS = ["close",]
-REGEX_ITEM_PAGED = "~[\w.]*\.([\w]*)\s?[\[\(][\w]*[\]\)]"
+TYPEHINT_NOT_REQUIRED_METHODS = ["close", "__init__"]
+REGEX_ITEM_PAGED = "~[\w.]*\.([\w]*)\s?[\[\(][^\n]*[\]\)]"
 PAGED_TYPES = ["ItemPaged", "AsyncItemPaged",]
+# Methods that are implementation of known interface should be excluded from lint check
+# for e.g. get, update, keys
+LINT_EXCLUSION_METHODS = [
+    "get",
+    "has_key",
+    "items",
+    "keys",
+    "update",
+    "values",
+    "close",    
+]
 
 
 def is_kwarg_mandatory(func_name):
@@ -75,7 +86,7 @@ def _inspect(self):
             error_message = "Error in parsing decorators for function {}".format(
                 self.name
             )
-            self.errors.append(error_message)
+            self.add_error(error_message)
             logging.error(error_message)
 
         self.is_class_method = "@classmethod" in self.annotations
@@ -125,7 +136,7 @@ def _parse_function(self):
         self._copy_kw_args()
 
         if not self.return_type and is_typehint_mandatory(self.name):
-            self.errors.append("Return type is missing in both typehint and docstring")
+            self.add_error("Return type is missing in both typehint and docstring")
         # Validate return type
         self._validate_pageable_api()
 
@@ -194,7 +205,8 @@ def _parse_docstring(self):
     def _parse_typehint(self):
 
         # Skip parsing typehint if typehint is not expected for e.g dunder or async methods
-        if not is_typehint_mandatory(self.name) or self.is_async:
+        # and if return type is already found
+        if self.return_type and not is_typehint_mandatory(self.name) or self.is_async:
             return
 
         # Parse type hint to get return type and types for positional args
@@ -203,7 +215,7 @@ def _parse_typehint(self):
         type_hint_ret_type = typehint_parser.find_return_type()
         # Type hint must be present for all APIs. Flag it as an error if typehint is missing
         if  not type_hint_ret_type:
-            self.errors.append("Typehint is missing for method {}".format(self.name))
+            self.add_error("Typehint is missing for method {}".format(self.name))
             return
 
         if not self.return_type:
@@ -214,7 +226,7 @@ def _parse_typehint(self):
             long_ret_type = self.return_type
             if long_ret_type != type_hint_ret_type and short_return_type != type_hint_ret_type:
                 error_message = "Return type in type hint is not matching return type in docstring"
-                self.errors.append(error_message)
+                self.add_error(error_message)
 
 
     def _generate_signature_token(self, apiview):
@@ -287,6 +299,10 @@ def generate_tokens(self, apiview):
 
 
     def add_error(self, error_msg):
+        # Ignore errors for lint check excluded methods
+        if self.name in LINT_EXCLUSION_METHODS:
+            return
+
         # Hide all diagnostics for now for dunder methods
         # These are well known protocol implementation
         if not self.name.startswith("_") or self.name in VALIDATION_REQUIRED_DUNDER:
@@ -303,7 +319,7 @@ def _validate_pageable_api(self):
                 if ret_short_type in PAGED_TYPES:
                     logging.debug("list API returns valid paged return type")
                     return
-            error_msg = "list API {0} should return ItemPaged or AsyncItemPaged".format(self.name)
+            error_msg = "list API {0} should return ItemPaged or AsyncItemPaged instead of {1}".format(self.name, self.return_type)
             logging.error(error_msg)
             self.add_error(error_msg)