Metadata-Version: 2.1
Name: mypy-runner
Version: 0.1.1
Summary: Run mypy with options to filter errors and colorize output
Home-page: https://github.com/chadrik/mypy-runner
Author: Chad Dombrova
License: MIT
Description: mypy-runner
        ===========
        
        Features
        --------
        
        Adds the following features to ``mypy``:
        
        - Display colorized output
        - Convert errors to warnings
        - Filter errors and warnings
        
        
        Options
        -------
        
        ::
        
            usage: mypyrun [-h] [--list] [--daemon] [--select SELECT] [--ignore IGNORE]
                           [--warn WARN] [--no-color] [--show-ignored] [--show-error-keys]
                           [--options OPTIONS]
                           [files [files ...]]
        
            positional arguments:
              files                 Files to isolate (triggers use of 'active'options for
                                    these files)
        
            optional arguments:
              -h, --help            show this help message and exit
              --list                list error codes
              --daemon, -d          run in daemon mode (dmypy run)
              --select SELECT, -s SELECT
                                    Errors to check (comma separated)
              --ignore IGNORE, -i IGNORE
                                    Errors to skip (comma separated)
              --warn WARN, -w WARN  Errors to convert into warnings (comma separated)
              --no-color            do not colorize output
              --show-ignored, -x    Show errors that have been ignored (darker if using
                                    color)
              --show-error-keys     Show error key for each line
              --options OPTIONS, -o OPTIONS
                                    Override the default options to use the
                                    namedconfiguration section (e.g. pass --options=foo to
                                    use the [mypyrun-foo] section)
        
        As with tools like ``flake8``, you use specific error codes to enable or disable error output.
        Errors that are ignored or converted into warnings will not trigger a non-zero exit status.
        To see the list of error codes and their regex pattern, run ``mypyrun --list``.
        
        Configuration
        -------------
        
        ``mypyrun`` looks for a ``[mypyrun]`` section in either ``mypy.ini`` or ``mypyrun.ini``.
        
        Here's an example configuration file:
        
        .. code-block:: ini
        
            [mypyrun]
        
            # run dmypy instead of mypy
            daemon = true
        
            # only display these errors
            select =
                not_defined,
                return_expected,
                return_not_expected,
                incompatible_subclass_attr,
        
            # all other errors are warnings
            warn = *
        
            # filter errors generated from these paths:
            exclude =
                thirdparty/*,
        
            # pass these paths to mypy
            paths =
                arnold/python,
                houdini/python,
                katana/python,
                mari/python,
                maya/python,
                nuke/python,
                python/packages,
        
Keywords: mypy,typing,pep484,annotations
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Provides-Extra: tests
