How to ignore Pyflakes errors ‘imported but unused’ in ‘init.py’ files?

Question

I split my tests across multiple Python files:

tests
├── __init__.py
├── test_apples.py
└── test_bananas.py.py

I import the tests in the ‘__init__.py’ file:

from test_apples import ApplesTest
from test_bananas import BananasTest

However running Pyflakes on the command-line:

pyflakes .

outputs the following errors:

tests/__init__.py:1: [E] PYFLAKES:'ApplesTest' imported but unused
tests/__init__.py:2: [E] PYFLAKES:'BananasTest' imported but unused

It isn't an error, it's just information that you have unused imports. There isn't any problem with it. — DrTyrsa, Dec 08 '11 at 07:49

Géry Ogam · Answer 1 · 2022-04-23T16:43:22.417

109

To ignore all errors F401 (‘imported but unused’) in ‘__init__.py’ files, the option ‘per-file-ignores’ which has been available since version 3.7.0 of Flake8 (a better Pyflakes) is very convenient. It can be used on the command-line:

flake8 --per-file-ignores="__init__.py:F401" .

or in a configuration file (‘.flake8’, ‘setup.cfg’ or ‘tox.ini’):

[flake8]
per-file-ignores = __init__.py:F401

edited Apr 23 '22 at 16:43

answered Sep 20 '19 at 13:21

Géry Ogam

6,336
4
38
67

11

This solution deserves some love as it is perfectly scoped: one issue in one file type. Added the following code snippet to `.flake8rc` and it works like a champ. ``` [flake8] per-file-ignores = __init__.py:F401 ``` – Nomen Nescio Dec 10 '19 at 18:04
1

I had some quotation issues in VS Code settings. Just in case, the quotes need to be escaped, as so: "python.linting.flake8Args": [ "--per-file-ignores=\"__init__.py:F401\"" ], – Rafael Zayas Apr 11 '20 at 16:47
3

Works beautifully in VSCode's Flake Args, just pasted `--per-file-ignores="__init__.py:F401"` there and voila. – Julio Cezar Silva Aug 27 '20 at 22:44
How would one use this with pylama / pyflakes in the `pyalama.ini` config file. All the flavors I tried did not work. I would like to ignore all unused imports in `__init__.py` files. The only thing that worked was adding `# noqa` to each line I would like to ignore. – Zach Apr 09 '21 at 21:07
1

python > linting > flake8 args > add item `per-file-ignores = __init__.py:F401` without quotes works fine in vscode :) – David Mendes Sep 19 '22 at 09:27
2

years after first upvoting this reply, I wish i could do it again. – Rafael Zayas Feb 09 '23 at 15:20
I'd previously upvoted @David Mendes response, but as of March 2023, i believe the quotes are required in the VS Code settings, as Julio Silva's comment indicates. – Rafael Zayas Mar 07 '23 at 22:28

score 17 · Answer 2 · answered Jul 01 '15 at 14:43

17

Sometimes you have to skip a line. According to the current versions docs (flake8 2.4.1) The files that contain

# flake8: noqa

are skipped. This works, and # noga, # pyflakes.ignore not.

answered Jul 01 '15 at 14:43

horbor

609
7
13

score 12 · Answer 3 · answered Sep 30 '13 at 01:34

12

In my version of PyFlakes (0.7.3), using __all__ works.

Additionally, to skip a line, you should add # noqa.

answered Sep 30 '13 at 01:34

dustinfarris

1,340
12
15

4

If you are not sure what `__all__` means, see this thread: https://stackoverflow.com/questions/31079047/python-pep8-class-in-init-imported-but-not-used/49266468 – Chris Feb 10 '20 at 13:58
1

Does using `__all__` make sense when I do only explicit imports inside `__init__.py`? – pabouk - Ukraine stay strong Feb 14 '22 at 08:31

score 3 · Answer 4 · answered Sep 20 '22 at 12:53

3

add # noqa: F401 to the end of your line (F401 is a code of this error)

Example: from django.utils import http # noqa: F401

answered Sep 20 '22 at 12:53

Sinisa Rudan

561
8
10

score 2 · Answer 5 · answered Jun 16 '22 at 13:28

The imports are interpreted as being unused because your linting tool doesn't understand how it's being used.

The most comprehensive fix is to ensure that these names are clearly exported from your module. Either by setting __all__, which is a mechanism for exhaustively enumerating the exported names, or by giving the imports explicit exported names using as.

from test_apples import ApplesTest as ApplesTest

However, I would generally recommend using a test runner that scans for test cases rather than importing them all, as that gives you more confidence that you're definitely running all of your tests.

The redundant `from foo import x as x` import is the recommended solution in PEP 484 and [`pyright`](https://github.com/microsoft/pylance-release/issues/856#issuecomment-763793949). — Janosh, Nov 17 '22 at 00:06

score -7 · Accepted Answer · edited Oct 24 '18 at 15:13

-7

Add # pyflakes.ignore comment on every line you want to ignore (in your case import statements).

edited Oct 24 '18 at 15:13

Neil G

32,138
39
156
257

answered Dec 08 '11 at 07:47

ILYA Khlopotov

705
3
5

@user1004669 And it shouldn't. You have imports in `__init__.py`. You don't use them in `__init__.py`. That's what PYFLAKES is telling you. Now it's up to you to decide what to do with it. There is no problem here. So you should do nothing. If you still have some doubts check any well-known project and I sure you will get the same message. – DrTyrsa Dec 08 '11 at 08:31
12

@DrTysa - The messages are annoying and distract from writing good code. They also make it more difficult to see actual useful messages from pyflakes. – Juan Enrique Muñoz Zolotoochin Aug 24 '12 at 22:06
14

Not sure why this is marked as a correct answer, the statement `# pyflakes.ignore` isn't working. – maksimov Mar 12 '13 at 15:12

How to ignore Pyflakes errors ‘imported but unused’ in ‘init.py’ files?

6 Answers6

Linked

How to ignore Pyflakes errors ‘imported but unused’ in ‘__init__.py’ files?

6 Answers6

Linked

How to ignore Pyflakes errors ‘imported but unused’ in ‘init.py’ files?