python / python/mypy

False positive [attr-defined] when using namespace_packages

Open
#13,663 3 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Bug Report

When using namespace_packages = true, if it happens that a directory with the same name as a module exists, mypy will not recognize names from the module.

To Reproduce

This is a minimal example, tested with python 3.8 and mypy 0.971:

.
├── mypkg
│   ├── foo  # empty directory
│   ├── foo.py
│   └── bar.py
└── mypy.ini
# mypy.ini
[mypy]
namespace_packages = true
show_error_codes = true
# mypkg/bar.py
from mypkg.foo import func
# mypkg/foo.py
def func():
    pass

While python correctly ignores the empty directory mypkg/foo, mypy does not:

# All these are successful
$ python -c 'import mypkg.bar'
$ python -c 'import mypkg.foo'
$ python -c 'from mypkg.foo import func'

# These calls to mypy fail
$ mypy -p mypkg
mypkg/bar.py:1: error: Module "mypkg.foo" has no attribute "func"  [attr-defined]
Found 1 error in 1 file (checked 3 source files)
$ mypy mypkg/bar.py 
mypkg/bar.py:1: error: Module "mypkg.foo" has no attribute "func"  [attr-defined]
Found 1 error in 1 file (checked 1 source file)

Expected Behavior

Mypy should ignore the empty directory and run successfully on this package. According to the docs, a package should be found (and have precedence over a module) if a directory has __init__.py or __init__.pyi in it.

In the case of namespace_packages = true, it seems that mypy is satisfied with a directory missing an __init__.py file and does not look for the module of the same name. This differs from the python search order specified in PEP-420, where the following are searched in turn: <directory>/foo/__init__.py, <directory>/foo.{py,pyc,so,pyd}, <directory>/foo, meaning that a namespace package is the last priority.

Actual Behavior

Mypy detects mypkg/foo as a package before module mypkg/foo.py and does not recognize the names in mypkg/foo.py, resulting in false positive [attr-defined] errors.

Your Environment

  • Mypy version used: 0.971
  • Mypy command-line flags: -p mypkg or mypkg/bar.py
  • Mypy configuration options from mypy.ini (and other config files): namespace_packages = true
  • Python version used: 3.8.5
  • Operating system and version: Linux (Ubuntu 18.04)

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

Recreate the minimal mypkg/foo directory and foo.py layout from the report, with namespace_packages = true in mypy.ini, then run mypy -p mypkg and mypy mypkg/bar.py. Trace how mypy resolves the import in mypkg/bar.py when both mypkg/foo and mypkg/foo.py exist; done means the module's func is recognized and both checks pass without [attr-defined].

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.