Type annotation does not with in Python 3.5

Question

Type annotation does not with in Python 3.5

jabdoa2 opened this issue 7 years ago · comments

For some reason pyannotate with the workaround from #12 does not annotate my files:

PYTHONPATH=/usr/local/lib/python3.5/dist-packages/ pyannotate -w -v "mpf/core/data_manager.py"
Generating grammar tables from /usr/lib/python3.5/lib2to3/PatternGrammar.txt
Adding transformation: annotate_json
Refactoring mpf/core/data_manager.py
No changes in mpf/core/data_manager.py
No files need to be modified.

However, it definitely found some missing annotations in type_info.json:

    {   
        "func_name": "DataManager.__init__",
        "path": "mpf/core/data_manager.py",
        "type_comments": [
            "(mpf.tests.MpfTestCase.TestMachineController, str, int) -> None"
        ],
        "line": 18,
        "samples": 5
    },

And the code looks like this:

class DataManager(MpfController):

    """Handles key value data loading and saving for the machine."""

    def __init__(self, machine, name, min_wait_secs=1):
        [...]

Any idea what is going wrong here?

Guilherme Salgado · Answer 1 · Fri Nov 17 2017 22:59:11 GMT+0800 (China Standard Time)

I was also bit by this, but got it to work on 3.5 by dumping the type info in the same dir where my source files are located, and invoking pyannotate from there as well. e.g.

$ pyannotate -w data_manager.py

jabdoa2 · Answer 2 · Fri Nov 17 2017 23:04:08 GMT+0800 (China Standard Time)

That does not seem to help for me. Same output but no changes to the file.

Guido van Rossum · Answer 3 · Sat Nov 18 2017 02:32:01 GMT+0800 (China Standard Time)

Is there an existing type comment in the __init__ function?

jabdoa2 · Answer 4 · Sat Nov 18 2017 02:47:58 GMT+0800 (China Standard Time)

No comments. This was just one example. It did not work on any file in our code base. I verified 10 cases where it should annotate but did not.

Guido van Rossum · Answer 5 · Sat Nov 18 2017 03:12:47 GMT+0800 (China Standard Time)

I'm sorry for your experience. Since it does state that it's refactoring the file, I recommend adding some print statements to get_annotation_from_stub() (in pyannotate_tools/fixes/fix_annotate_json.py) to see where it decides that there is no applicable annotation.

Guido van Rossum · Answer 6 · Wed Nov 22 2017 03:07:42 GMT+0800 (China Standard Time)

Is your source code open source? Otherwise if you don't investigate more I have to close this as "cannot reproduce".

jabdoa2 · Answer 7 · Wed Nov 22 2017 06:42:10 GMT+0800 (China Standard Time)

https://github.com/missionpinball/mpf/

Guido van Rossum · Answer 8 · Wed Nov 22 2017 06:58:58 GMT+0800 (China Standard Time)

OK, here's the problem. Your project has an `__init__.py` file at the top level. So essentially you're running pyannotate from inside a package. That doesn't work. There's code that crawls up the directory tree until it finds a directory that's not a package, and that code lands at the parent of your repo. Why do you have it set up like that? Just deleting the toplevel `__init__.py` makes everything work.

jabdoa2 · Answer 9 · Wed Nov 22 2017 07:21:39 GMT+0800 (China Standard Time)

Good question. Probably always has been that way. Deleted it and it works fine now. Thanks!