Add support for configure with pyproject.toml

Support for TOML configuration files with sections like
[tool.mypy] and [tool.mypy-mypackage.*].

Signed-off-by: Pedro Lacerda <[email protected]>

Author: pslacerda

mypy/defaults.py

@@ -5,4 +5,5 @@
 CONFIG_FILE = 'mypy.ini'
 SHARED_CONFIG_FILES = ('setup.cfg',)
 USER_CONFIG_FILES = ('~/.mypy.ini',)
-CONFIG_FILES = (CONFIG_FILE,) + SHARED_CONFIG_FILES + USER_CONFIG_FILES
+PYPROJECT_CONFIG_FILES = ('pyproject.toml',)
+CONFIG_FILES = (CONFIG_FILE,) + SHARED_CONFIG_FILES + USER_CONFIG_FILES + PYPROJECT_CONFIG_FILES

mypy/main.py

@@ -9,7 +9,9 @@
 import sys
 import time
 
-from typing import Any, Dict, List, Mapping, Optional, Tuple, Callable
+from typing import Any, Dict, List, Mapping, Optional, Tuple, Callable, Type
+
+import toml  # type: ignore
 
 from mypy import build
 from mypy import defaults
@@ -892,35 +894,54 @@ def parse_config_file(options: Options, filename: Optional[str]) -> None:
     else:
         config_files = tuple(map(os.path.expanduser, defaults.CONFIG_FILES))
 
-    parser = configparser.RawConfigParser()
-
     for config_file in config_files:
         if not os.path.exists(config_file):
             continue
-        try:
-            parser.read(config_file)
-        except configparser.Error as err:
-            print("%s: %s" % (config_file, err), file=sys.stderr)
+        if config_file.endswith('.toml'):
+            try:
+                config = toml.load(config_file)
+            except Exception as err:
+                print("%s: %s" % (config_file, err), file=sys.stderr)
+            else:
+                section_title = 'tool.mypy'
+                file_read = config_file
+
+                plain_config = {}
+                for name, section in config.get('tool', {}).items():
+                    if name == 'mypy' or name.startswith('mypy-'):
+                        plain_config['tool.%s' % name] = section
+                config = plain_config
+                break
         else:
-            file_read = config_file
-            options.config_file = file_read
-            break
+            try:
+                config = configparser.RawConfigParser()
+                config.read(config_file)
+            except configparser.Error as err:
+                print("%s: %s" % (config_file, err), file=sys.stderr)
+            else:
+                file_read = config_file
+                options.config_file = file_read
+                section_title = 'mypy'
+                break
     else:
         return
 
-    if 'mypy' not in parser:
+    config  # type: Dict[str, Any]
+
+    if section_title not in config:
         if filename or file_read not in defaults.SHARED_CONFIG_FILES:
-            print("%s: No [mypy] section in config file" % file_read, file=sys.stderr)
+            print("%s: No [%s] section in config file" % (file_read, section_title),
+                  file=sys.stderr)
     else:
-        section = parser['mypy']
-        prefix = '%s: [%s]' % (file_read, 'mypy')
+        section = config[section_title]
+        prefix = '%s: [%s]' % (file_read, section_title)
         updates, report_dirs = parse_section(prefix, options, section)
         for k, v in updates.items():
             setattr(options, k, v)
         options.report_dirs.update(report_dirs)
 
-    for name, section in parser.items():
-        if name.startswith('mypy-'):
+    for name, section in config.items():
+        if name.startswith(section_title + '-'):
             prefix = '%s: [%s]' % (file_read, name)
             updates, report_dirs = parse_section(prefix, options, section)
             if report_dirs:
@@ -932,7 +953,7 @@ def parse_config_file(options: Options, filename: Optional[str]) -> None:
                       (prefix, ', '.join(sorted(set(updates) - Options.PER_MODULE_OPTIONS))),
                       file=sys.stderr)
                 updates = {k: v for k, v in updates.items() if k in Options.PER_MODULE_OPTIONS}
-            globs = name[5:]
+            globs = name[len(section_title) + 1:]
             for glob in globs.split(','):
                 # For backwards compatibility, replace (back)slashes with dots.
                 glob = glob.replace(os.sep, '.')
@@ -984,18 +1005,24 @@ def parse_section(prefix: str, template: Options,
             ct = type(dv)
         v = None  # type: Any
         try:
-            if ct is bool:
-                v = section.getboolean(key)  # type: ignore  # Until better stub
-            elif callable(ct):
-                try:
-                    v = ct(section.get(key))
-                except argparse.ArgumentTypeError as err:
-                    print("%s: %s: %s" % (prefix, key, err), file=sys.stderr)
+            if isinstance(section, configparser.SectionProxy):
+                if ct is bool:
+                    v = section.getboolean(key)  # type: ignore  # Until better stub
+                elif callable(ct):
+                    try:
+                        v = ct(section.get(key))
+                    except argparse.ArgumentTypeError as err:  # XXX ct raises ArgumentTypeError?
+                        print("%s: %s: %s" % (prefix, key, err), file=sys.stderr)
+                        continue
+                else:
+                    print("%s: Don't know what type %s should have" % (prefix, key),
+                          file=sys.stderr)
                     continue
             else:
-                print("%s: Don't know what type %s should have" % (prefix, key), file=sys.stderr)
-                continue
-        except ValueError as err:
+                v = section[key]
+                if not isinstance(v, ct):  # type: ignore  # No idea
+                    raise ValueError(f"{v} is not an instance of {ct}")
+        except (ValueError, KeyError) as err:
             print("%s: %s: %s" % (prefix, key, err), file=sys.stderr)
             continue
         if key == 'silent_imports':

mypy/test/testfinegrained.py

@@ -172,7 +172,7 @@ def get_options(self,
             options.follow_imports = 'error'
 
         for name, _ in testcase.files:
-            if 'mypy.ini' in name:
+            if os.path.basename(name) in ['mypy.ini', 'pyproject.toml']:
                 parse_config_file(options, name)
                 break
 

setup.py

@@ -104,6 +104,7 @@ def run(self):
       classifiers=classifiers,
       cmdclass={'build_py': CustomPythonBuild},
       install_requires = ['typed-ast >= 1.1.0, < 1.2.0',
+                          'toml >= 0.7.0, < 0.8.0'
                           ],
       extras_require = {
           ':python_version < "3.5"': 'typing >= 3.5.3',

test-data/unit/check-custom-plugin.test

@@ -12,28 +12,28 @@ reveal_type(f())  # E: Revealed type is 'builtins.int'
 plugins=<ROOT>/test-data/unit/plugins/fnplugin.py
 
 [case testFunctionPluginFullnameIsNotNone]
-# flags: --config-file tmp/mypy.ini
+# flags: --config-file tmp/mypy.toml
 from typing import Callable, TypeVar
 f: Callable[[], None]
 T = TypeVar('T')
 def g(x: T) -> T: return x  # This strips out the name of a callable
 g(f)()
-[file mypy.ini]
-[[mypy]
-plugins=<ROOT>/test-data/unit/plugins/fnplugin.py
+[file mypy.toml]
+[[tool.mypy]
+plugins=<ROOT>/test-data/unit/plugins/fnplugin.py"
 
 [case testTwoPlugins]
-# flags: --config-file tmp/mypy.ini
+# flags: --config-file tmp/mypy.toml
 def f(): ...
 def g(): ...
 def h(): ...
 reveal_type(f())  # E: Revealed type is 'builtins.int'
 reveal_type(g())  # E: Revealed type is 'builtins.str'
 reveal_type(h())  # E: Revealed type is 'Any'
-[file mypy.ini]
-[[mypy]
-plugins=<ROOT>/test-data/unit/plugins/fnplugin.py,
-  <ROOT>/test-data/unit/plugins/plugin2.py
+[file mypy.toml]
+[[tool.mypy]
+plugins=["<ROOT>/test-data/unit/plugins/fnplugin.py",
+  "<ROOT>/test-data/unit/plugins/plugin2.py"]
 
 [case testMissingPlugin]
 # flags: --config-file tmp/mypy.ini

test-data/unit/check-flags.test

@@ -472,7 +472,7 @@ if z:  # E: Condition must be a boolean
 
 
 [case testPerFileStrictOptionalBasic]
-# flags: --config-file tmp/mypy.ini
+# flags: --config-file tmp/pyproject.toml
 import standard, optional
 
 [file standard.py]
@@ -482,11 +482,11 @@ x = None
 x = 0
 x = None  # E: Incompatible types in assignment (expression has type "None", variable has type "int")
 
-[file mypy.ini]
-[[mypy]
-strict_optional = False
-[[mypy-optional]
-strict_optional = True
+[file pyproject.toml]
+[[tool.mypy]
+strict_optional = false
+[[tool.mypy-optional]
+strict_optional = true
 
 
 [case testPerFileStrictOptionalBasicImportStandard]

test-data/unit/cmdline.test

@@ -1257,6 +1257,6 @@ import d
 [case testCacheMap]
 -- This just checks that a valid --cache-map triple is accepted.
 -- (Errors are too verbose to check.)
-# cmd: mypy a.py --cache-map a.py a.meta.json a.data.json 
+# cmd: mypy a.py --cache-map a.py a.meta.json a.data.json
 [file a.py]
 [out]

test-data/unit/fine-grained.test

@@ -7141,10 +7141,10 @@ def f() -> str: return '0'
 ==
 
 [case testRefreshIgnoreErrors1]
-[file mypy.ini]
-[[mypy]
-[[mypy-b]
-ignore_errors = True
+[file pyproject.toml]
+[[tool.mypy]
+[[tool.mypy-b]
+ignore_errors = true
 [file a.py]
 y = '1'
 [file a.py.2]