velis velis - 1 year ago 202
Python Question

Python type hinting without cyclic imports

I'm trying to split my huge class into two; well, basically into the "main" class and a mixin with additional functions, like so:


class Main(object, MyMixin):
def func1(self, xxx):

class MyMixin(object):
def func2(self: Main, xxx): # <--- note the type hint

Now, while this works just fine, the type hint in MyMixin.func2 of course can't work. I can't import, because I'd get a cyclic import and without the hint, my editor (PyCharm) can't tell what

Using Python 3.4, willing to move to 3.5 if a solution is available there.

Is there any way I can split my class into two files and keep all the "connections" so that my IDE still offers me auto completion & all the other goodies that come from it knowing the types?

Answer Source

There isn't a hugely elegant way to handle import cycles in general, I'm afraid. Your choices are to either redesign your code to remove the cyclic dependency, or if it isn't feasible, do something like this:


from typing import TYPE_CHECKING
    from main import Main

class MyObject(object):
    def func2(self, some_param: 'Main'):

The TYPE_CHECKING constant is always False at runtime, so the import won't be evaluated, but mypy (and other type-checking tools) will evaluate the contents of that block.

We also need to make the Main type annotation into a string, effectively forward declaring it since the Main symbol isn't available at runtime.

All that said, using mixins with mypy will likely require a bit more structure then you currently have. Mypy recommends an approach that's basically what deceze is describing -- to create an ABC that both your Main and MyMixin classes inherit. I wouldn't be surprised if you ended up needing to do something similar in order to make Pycharm's checker happy.

Recommended from our users: Dynamic Network Monitoring from WhatsUp Gold from IPSwitch. Free Download