stubgen: Add --verbose and --quiet flags

python · JukkaL · Nov 14, 2019 · Apr 11, 2019 · Apr 11, 2019 · Apr 12, 2019
commit e1de86673011fb23df88c06ea091e7f554f9b47b
diff --git a/mypy/stubgen.py b/mypy/stubgen.py
@@ -76,7 +76,7 @@
 from mypy.stubutil import (
     write_header, default_py2_interpreter, CantImport, generate_guarded,
     walk_packages, find_module_path_and_all_py2, find_module_path_and_all_py3,
-    report_missing, fail_missing, remove_misplaced_type_comments
+    report_missing, fail_missing, remove_misplaced_type_comments, common_dir_prefix
 )
 from mypy.stubdoc imp
8000
ort parse_all_signatures, find_unique_signatures, Sig
 from mypy.options import Options as MypyOptions
@@ -96,10 +96,21 @@ class Options:
 
     This class is mutable to simplify testing.
     """
-    def __init__(self, pyversion: Tuple[int, int], no_import: bool, doc_dir: str,
-                 search_path: List[str], interpreter: str, parse_only: bool, ignore_errors: bool,
-                 include_private: bool, output_dir: str, modules: List[str], packages: List[str],
-                 files: List[str]) -> None:
+    def __init__(self,
+                 pyversion: Tuple[int, int],
+                 no_import: bool,
+                 doc_dir: str,
+                 search_path: List[str],
+                 interpreter: str,
+                 parse_only: bool,
+                 ignore_errors: bool,
+                 include_private: bool,
+                 output_dir: str,
+                 modules: List[str],
+                 packages: List[str],
+                 files: List[str],
+                 verbose: bool,
+                 quiet: bool) -> None:
         # See parse_options for descriptions of the flags.
         self.pyversion = pyversion
         self.no_import = no_import
@@ -114,6 +125,8 @@ def __init__(self, pyversion: Tuple[int, int], no_import: bool, doc_dir: str,
         self.modules = modules
         self.packages = packages
         self.files = files
+        self.verbose = verbose
+        self.quiet = quiet
 
 
 class StubSource(BuildSource):
@@ -904,7 +917,9 @@ def collect_build_targets(options: Options, mypy_opts: MypyOptions) -> Tuple[Lis
             py_modules, c_modules = find_module_paths_using_imports(options.modules,
                                                                     options.packages,
                                                                     options.interpreter,
-                                                                    options.pyversion)
+                                                                    options.pyversion,
+                                                                    options.verbose,
+                                                                        options.quiet)
     else:
         # Use mypy native source collection for files and directories.
         try:
@@ -917,10 +932,12 @@ def collect_build_targets(options: Options, mypy_opts: MypyOptions) -> Tuple[Lis
     return py_modules, c_modules
 
 
-def find_module_paths_using_imports(modules: List[str], packages: List[str],
+def find_module_paths_using_imports(modules: List[str],
+                                    packages: List[str],
                                     interpreter: str,
                                     pyversion: Tuple[int, int],
-                                    quiet: bool = True) -> Tuple[List[StubSource],
+                                    verbose: bool,
+                                    quiet: bool) -> Tuple[List[StubSource],
                                                                  List[StubSource]]:
     """Find path and runtime value of __all__ (if possible) for modules and packages.
 
@@ -936,9 +953,10 @@ def find_module_paths_using_imports(modules: List[str], packages: List[str],
             else:
                 result = find_module_path_and_all_py3(mod)
         except CantImport as e:
-            if not quiet:
+            if verbose:
                 traceback.print_exc()
-            report_missing(mod, e.message)
+            if not quiet:
+                report_missing(mod, e.message)
             continue
         if not result:
             c_modules.append(StubSource(mod))
@@ -1074,9 +1092,7 @@ def collect_docs_signatures(doc_dir: str) -> Tuple[Dict[str, str], Dict[str, str
     return sigs, class_sigs
 
 
-def generate_stubs(options: Options,
-                   # additional args for testing
-                   quiet: bool = False, add_header: bool = True) -> None:
+def generate_stubs(options: Options) -> None:
     """Main entry point for the program."""
     mypy_opts = mypy_options(options)
     py_modules, c_modules = collect_build_targets(options, mypy_opts)
@@ -1088,6 +1104,7 @@ def generate_stubs(options: Options,
 
     # Use parsed sources to generate stubs for Python modules.
     generate_asts_for_modules(py_modules, options.parse_only, mypy_opts)
+    files = []
     for mod in py_modules:
         assert mod.path is not None, "Not found module was not skipped"
         target = mod.module.replace('.', '/')
@@ -1096,7 +1113,8 @@ def generate_stubs(options: Options,
         else:
             target += '.pyi'
         target = os.path.join(options.output_dir, target)
-        with generate_guarded(mod.module, target, options.ignore_errors, quiet):
+        files.append(target)
+        with generate_guarded(mod.module, target, options.ignore_errors, options.verbose):
             generate_stub_from_ast(mod, target,
                                    options.parse_only, options.pyversion,
                                    options.include_private, add_header)
@@ -1105,9 +1123,16 @@ def generate_stubs(options: Options,
     for mod in c_modules:
         target = mod.module.replace('.', '/') + '.pyi'
         target = os.path.join(options.output_dir, target)
-        with generate_guarded(mod.module, target, options.ignore_errors, quiet):
-            generate_stub_for_c_module(mod.module, target, sigs=sigs, class_sigs=class_sigs,
-                                       add_header=add_header)
+        files.append(target)
+        with generate_guarded(mod.module, target, options.ignore_errors, options.verbose):
+            generate_stub_for_c_module(mod.module, target, sigs=sigs, class_sigs=class_sigs, add_header=add_header)
+    num_modules = len(py_modules) + len(c_modules)
+    if not options.quiet and num_modules > 0:
+        print('Processed %d modules' % num_modules)
+        if len(files) == 1:
+            print('Generated %s' % files[0])
+        else:
+            print('Generated files under %s' % common_dir_prefix(files) + os.sep)
 
 
 HEADER = """%(prog)s [-h] [--py2] [more options, see -h]
@@ -1140,6 +1165,10 @@ def parse_options(args: List[str]) -> Options:
     parser.add_argument('--include-private', action='store_true',
                         help="generate stubs for objects and members considered private "
                              "(single leading underscore and no trailing underscores)")
+    parser.add_argument('-v', '--verbose', action='store_true',
+                        help="show more verbose messages")
+    parser.add_argument('-q', '--quiet', action='store_true',
+                        help="show fewer messages")
     parser.add_argument('--doc-dir', metavar='PATH', default='',
                         help="use .rst documentation in PATH (this may result in "
                              "better stubs in some cases; consider setting this to "
@@ -1168,6 +1197,8 @@ def parse_options(args: List[str]) -> Options:
         ns.interpreter = sys.executable if pyversion[0] == 3 else default_py2_interpreter()
     if ns.modules + ns.packages and ns.files:
         parser.error("May only specify one of: modules/packages or files.")
+    if ns.quiet and ns.verbose:
+        parser.error('Cannot specify both quiet and verbose messages')
 
     # Create the output folder if it doesn't already exist.
     if not os.path.exists(ns.output_dir):
@@ -1184,7 +1215,9 @@ def parse_options(args: List[str]) -> Options:
                    output_dir=ns.output_dir,
                    modules=ns.modules,
                    packages=ns.packages,
-                   files=ns.files)
+                   files=ns.files,
+                   verbose=ns.verbose,
+                   quiet=ns.quiet)
 
 
 def main() -> None:

diff --git a/mypy/stubutil.py b/mypy/stubutil.py
@@ -143,11 +143,13 @@ def find_module_path_and_all_py3(module: str) -> Optional[Tuple[str, Optional[Li
 
 @contextmanager
 def generate_guarded(mod: str, target: str,
-                     ignore_errors: bool = True, quiet: bool = False) -> Iterator[None]:
+                     ignore_errors: bool = True, verbose: bool = False) -> Iterator[None]:
     """Ignore or report errors during stub generation.
 
     Optionally report success.
     """
+    if verbose:
+        print('Processing %s' % mod)
     try:
         yield
     except Exception as e:
@@ -157,7 +159,7 @@ def generate_guarded(mod: str, target: str,
             # --ignore-errors was passed
             print("Stub generation failed for", mod, file=sys.stderr)
     else:
-        if not quiet:
+        if verbose:
             print('Created %s' % target)
 
 
@@ -191,3 +193,16 @@ def remove_misplaced_type_comments(source: AnyStr) -> AnyStr:
         return text.encode('latin1')
     else:
         return text
+
+
+def common_dir_prefix(paths: List[str]) -> str:
+    if not paths:
+        return '.'
+    cur = os.path.dirname(paths[0])
+    for path in paths[1:]:
+        while True:
+            path = os.path.dirname(path)
+            if (cur + '/').startswith(path + '/'):
+                cur = path
+                break
+    return cur or '.'
diff --git a/mypy/test/teststubgen.py b/mypy/test/teststubgen.py
@@ -17,7 +17,7 @@
     generate_stubs, parse_options, Options, collect_build_targets,
     mypy_options
 )
-from mypy.stubutil import walk_packages, remove_misplaced_type_comments
+from mypy.stubutil import walk_packages, remove_misplaced_type_comments, common_dir_prefix
 from mypy.stubgenc import generate_c_type_stub, infer_method_sig, generate_c_function_stub
 from mypy.stubdoc import (
     parse_signature, parse_all_signatures, build_signature, find_unique_signatures,
@@ -400,6 +400,20 @@ def h():
 
         assert_equal(remove_misplaced_type_comments(original), dest)
 
+    def test_common_dir_prefix(self) -> None:
+        assert common_dir_prefix([]) == '.'
+        assert common_dir_prefix(['x.pyi']) == '.'
+        assert common_dir_prefix(['./x.pyi']) == '.'
+        assert common_dir_prefix(['foo/bar/x.pyi']) == 'foo/bar'
+        assert common_dir_prefix(['foo/bar/x.pyi',
+                                  'foo/bar/y.pyi']) == 'foo/bar'
+        assert common_dir_prefix(['foo/bar/x.pyi', 'foo/y.pyi']) == 'foo'
+        assert common_dir_prefix(['foo/x.pyi', 'foo/bar/y.pyi']) == 'foo'
+        assert common_dir_prefix(['foo/bar/zar/x.pyi', 'foo/y.pyi']) == 'foo'
+        assert common_dir_prefix(['foo/x.pyi', 'foo/bar/zar/y.pyi']) == 'foo'
+        assert common_dir_prefix(['foo/bar/zar/x.pyi', 'foo/bar/y.pyi']) == 'foo/bar'
+        assert common_dir_prefix(['foo/bar/x.pyi', 'foo/bar/zar/y.pyi']) == 'foo/bar'
+
 
 class StubgenPythonSuite(DataSuite):
     required_out_section = True
@@ -429,7 +443,7 @@ def run_case_inner(self, testcase: DataDrivenTestCase) -> None:
                     options.no_import = True
                 if not testcase.name.endswith('_semanal'):
                     options.parse_only = True
-                generate_stubs(options, quiet=True, add_header=False)
+                generate_stubs(options, add_header=False)
                 a = []  # type: List[str]
                 self.add_file(os.path.join(out_dir, 'main.pyi'), a)
             except CompileError as e:
@@ -449,7 +463,10 @@ def parse_flags(self, program_text: str, extra: List[str]) -> Options:
             flag_list = flags.group(1).split()
         else:
             flag_list = []
-        return parse_options(flag_list + extra)
+        options = parse_options(flag_list + extra)
+        if '--verbose' not in flag_list:
+            options.quiet = True
+        return options
 
     def add_file(self, path: str, result: List[str]) -> None:
         with open(path, encoding='utf8') as file: