python / python/mypy

Refurb crashes on Mypy 1.7.0

Open
#16,497 18 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug question topic-mypyc
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Bug Report

Refurb is a project that depends on Mypy internals to work properly. Since v1.7.0 of Mypy (specifically since https://github.com/python/mypy/pull/15770 was merged), Refurb no longer works, and instead emits the following error:

$ refurb file.py
interpreted classes cannot inherit from compiled traits

See also: https://github.com/dosisod/refurb/issues/305

To Reproduce

$ pip install refurb==1.22.2 mypy==1.7.0
$ touch file.py
$ refurb file.py
interpreted classes cannot inherit from compiled traits

Expected Behavior

Refurb doesn't crash.

Actual Behavior

Refurb is crashing.

Your Environment

  • Mypy version used: 1.7.0
  • Python version used: 3.11.5

Background

#15770 added a @trait decorator to TraverserVisitor, meaning 3rd party (interpreted) programs can no longer inherit from TraverserVisitor:

https://github.com/python/mypy/blob/c6cb3c6282003dd3dadcf028735f9ba6190a0c84/mypy/traverser.py#L97-L99

I tried a bunch of different workarounds including making a custom __new__ method, copy-and-pasting TraverserVisitor into my code and removing the @trait, but alas nothing is working, and so I had to pin Mypy to <= v1.6.1 in Refurb, which will prevent users from using the newest version of Mypy with Refurb. Using the non-compiled version of Mypy doesn't have this issue, but doing so would be far too slow, especially since Refurb parses/walks the full, fine-grained AST tree (similar to mypyd).

My question: How should I get around this? Is there anything I can do on my end, or does something in Mypy have to change? I would think that allow_interpreted_subclasses=True would nullify the inheritance restriction imposed by @trait, but that doesn't seem to be the case.

There is also the bigger question of how 3rd parties should safely use Mypy internals (or if they even should in the first place). Currently Mypy internals are not versioned and can change with any release. In addition, certain parts of Mypy are hard/impossible to use outside of Mypy itself, whether that's because they don't work, crash, or require lots of moving parts because they weren't meant to be used in a stand-alone environment. I know that standardizing/stabilizing Mypy's internals so that 3rd parties can use them is probably not a major priority, but I thought I would bring it up to gauge how you all feel about it. I could elaborate more but I want to keep this short. I can open a separate issue for this if need be.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the crash with refurb 1.22.2, mypy 1.7.0, and an empty file as shown. Read mypy/traverser.py around lines 97-99 and inspect PR #15770, then compare the compiled and non-compiled behavior. Done means Refurb no longer crashes with Mypy 1.7.0 while retaining the required AST-walking behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.