File: google_docstring_mypy_plugin.py

package info (click to toggle)
ubelt 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,180 kB
  • sloc: python: 15,487; sh: 807; makefile: 24
file content (43 lines) | stat: -rw-r--r-- 1,251 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
"""
POC google docstring plugin for mypy
"""
from mypy.plugin import Plugin

from typing import Callable, Optional
from mypy.plugin import FunctionSigContext
from mypy.types import CallableType


class CustomPlugin(Plugin):
    """

    cd $HOME/code/ubelt
    mypy -m ubelt.util_dict
    stubgen -m ubelt.util_dict

    """
    # def get_type_analyze_hook(self, fullname: str):
    #     print('get_type_analyze_hook: fullname = {!r}'.format(fullname))

    def get_function_signature_hook(self, fullname: str
                                    ) -> Optional[Callable[[FunctionSigContext], CallableType]]:
        """Adjust the signature of a function.

        This method is called before type checking a function call. Plugin
        may infer a better type for the function.

            from lib import Class, do_stuff

            do_stuff(42)
            Class()

        This method will be called with 'lib.do_stuff' and then with 'lib.Class'.
        """
        if 'ubelt' in fullname or 'util_' in fullname:
            print('get_function_signature_hook: fullname = {!r}'.format(fullname))
        return None


def plugin(version: str):
    # ignore version argument if the plugin works with all mypy versions.
    return CustomPlugin