FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Overhaul noqa directives · Python-Repository-Hub/GitPython@41d22b2 · GitHub

  1. Python-Repository-Hub
  2. GitPython

Repository navigation

Commit 41d22b2

Browse files
EliahKagan
committed
Overhaul noqa directives
- Remove some noqa directives that are not needed at all anymore. But there may still be some others I did not find. - Fix the code and remove the noqa direcive in places where the change is very simple and does not affect the interface (e.g., what could be taken to be public or not, what symbols are available and what they refer to, etc.), the change makes the code more idiomatic or clearer, and it fixes the flake8 complaint completely. - Turn file-level noqa directives into statement-level ones. A noqa directive at file level, even if it lists one or more specific error/warning numbers, actually suppresses flake8 for the entire file. So the main benefit here is to enable other warnings. But this also makes it clear what is producing the ones we suppress, which makes it easier to know what is intentional and how it may be reasonable to change it in the future. - Move noqa directives at the end of multi-line imports to the top line, where flake8 honors them, and eliminate redundant directives that were added to work around their ineffectiveness. (This is not really separate from the above point, since this is often what allowed file-level directives to be removed.) - Specify the errors/warnings each "noqa" should suppress. That is, this turns every bare "noqa", aside from those eliminated as described above, into a "noqa" for one or more specific errors/warnings. This makes the intent clearer and avoids oversuppression. - Add missing ":" between "noqa" and error/warning numbers. When these were absent, the intention was to suppress only the specifically listed errors/warnings, but the effect was that the listed numbers were ignored and *everything* was suppressed. In a couple of cases it was necessary to change the listed numbers to correct the list to what actually needed to be suppressed. - Write every "noqa" in lower-case (not "NOQA"). There did not appear to be a systematic reason for the different casing, and having them all cased the same makes it easier to avoid mistakes when grepping for them. - Where an import is unused and does not appear intended to be accesed from other modules, and is present only to support code in the same module that is commented out, but whose removal should be considered separately, comment out the statement or part of the statement that imports it as well, rather than writing a "noqa" for the unused import. This applies to only one file, git/objects/util.py.
1 parent cf5cb84 commit 41d22b2

21 files changed

Lines changed: 75 additions & 95 deletions

‎git/__init__.py‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,27 @@
33
# This module is part of GitPython and is released under the
44
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
55

6-
# flake8: noqa
76
# @PydevCodeAnalysisIgnore
87

9-
from git.exc import * # @NoMove @IgnorePep8
10-
from typing import List, Optional, Sequence, Tuple, Union, TYPE_CHECKING
11-
from git.types import PathLike
12-
138
__version__ = "git"
149

10+
from typing import List, Optional, Sequence, Tuple, Union, TYPE_CHECKING
11+
1512
from gitdb.util import to_hex_sha
13+
from git.exc import * # noqa: F403 # @NoMove @IgnorePep8
14+
from git.types import PathLike
1615

1716
try:
1817
from git.compat import safe_decode # @NoMove @IgnorePep8
1918
from git.config import GitConfigParser # @NoMove @IgnorePep8
20-
from git.objects import * # @NoMove @IgnorePep8
21-
from git.refs import * # @NoMove @IgnorePep8
22-
from git.diff import * # @NoMove @IgnorePep8
23-
from git.db import * # @NoMove @IgnorePep8
19+
from git.objects import * # noqa: F403 # @NoMove @IgnorePep8
20+
from git.refs import * # noqa: F403 # @NoMove @IgnorePep8
21+
from git.diff import * # noqa: F403 # @NoMove @IgnorePep8
22+
from git.db import * # noqa: F403 # @NoMove @IgnorePep8
2423
from git.cmd import Git # @NoMove @IgnorePep8
2524
from git.repo import Repo # @NoMove @IgnorePep8
26-
from git.remote import * # @NoMove @IgnorePep8
27-
from git.index import * # @NoMove @IgnorePep8
25+
from git.remote import * # noqa: F403 # @NoMove @IgnorePep8
26+
from git.index import * # noqa: F403 # @NoMove @IgnorePep8
2827
from git.util import ( # @NoMove @IgnorePep8
2928
LockFile,
3029
BlockingLockFile,
@@ -33,12 +32,12 @@
3332
remove_password_if_present,
3433
rmtree,
3534
)
36-
except GitError as _exc:
35+
except GitError as _exc: # noqa: F405
3736
raise ImportError("%s: %s" % (_exc.__class__.__name__, _exc)) from _exc
3837

3938
# __all__ must be statically defined by py.typed support
4039
# __all__ = [name for name, obj in locals().items() if not (name.startswith("_") or inspect.ismodule(obj))]
41-
__all__ = [
40+
__all__ = [ # noqa: F405
4241
"Actor",
4342
"AmbiguousObjectName",
4443
"BadName",
@@ -127,7 +126,7 @@ def refresh(path: Optional[PathLike] = None) -> None:
127126

128127
if not Git.refresh(path=path):
129128
return
130-
if not FetchInfo.refresh():
129+
if not FetchInfo.refresh(): # noqa: F405
131130
return # type: ignore [unreachable]
132131

133132
GIT_OK = True

‎git/cmd.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -965,7 +965,7 @@ def execute(
965965
# Only search PATH, not CWD. This must be in the *caller* environment. The "1" can be any value.
966966
maybe_patch_caller_env = patch_env("NoDefaultCurrentDirectoryInExePath", "1")
967967
else:
968-
cmd_not_found_exception = FileNotFoundError # NOQA # exists, flake8 unknown @UndefinedVariable
968+
cmd_not_found_exception = FileNotFoundError
969969
maybe_patch_caller_env = contextlib.nullcontext()
970970
# END handle
971971

‎git/compat.py‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,15 @@
55

66
"""Utilities to help provide compatibility with Python 3."""
77

8-
# flake8: noqa
9-
108
import locale
119
import os
1210
import sys
1311

14-
from gitdb.utils.encoding import (
15-
force_bytes, # @UnusedImport
16-
force_text, # @UnusedImport
17-
)
12+
from gitdb.utils.encoding import force_bytes, force_text # noqa: F401 # @UnusedImport
1813

1914
# typing --------------------------------------------------------------------
2015

21-
from typing import (
16+
from typing import ( # noqa: F401
2217
Any,
2318
AnyStr,
2419
Dict,

‎git/index/__init__.py‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,5 @@
33

44
"""Initialize the index package."""
55

6-
# flake8: noqa
7-
8-
from .base import *
9-
from .typ import *
6+
from .base import * # noqa: F401 F403
7+
from .typ import * # noqa: F401 F403

‎git/objects/__init__.py‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,21 @@
33

44
"""Import all submodules' main classes into the package space."""
55

6-
# flake8: noqa
7-
86
import inspect
97

10-
from .base import *
11-
from .blob import *
12-
from .commit import *
8+
from .base import * # noqa: F403
9+
from .blob import * # noqa: F403
10+
from .commit import * # noqa: F403
1311
from .submodule import util as smutil
14-
from .submodule.base import *
15-
from .submodule.root import *
16-
from .tag import *
17-
from .tree import *
12+
from .submodule.base import * # noqa: F403
13+
from .submodule.root import * # noqa: F403
14+
from .tag import * # noqa: F403
15+
from .tree import * # noqa: F403
1816

1917
# Fix import dependency - add IndexObject to the util module, so that it can be
2018
# imported by the submodule.base.
21-
smutil.IndexObject = IndexObject # type: ignore[attr-defined]
22-
smutil.Object = Object # type: ignore[attr-defined]
19+
smutil.IndexObject = IndexObject # type: ignore[attr-defined] # noqa: F405
20+
smutil.Object = Object # type: ignore[attr-defined] # noqa: F405
2321
del smutil
2422

2523
# Must come after submodule was made available.

‎git/objects/util.py‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,27 @@
55

66
"""General utility functions."""
77

8-
# flake8: noqa F401
9-
10-
118
from abc import ABC, abstractmethod
12-
import warnings
13-
from git.util import IterableList, IterableObj, Actor
14-
15-
import re
9+
import calendar
1610
from collections import deque
17-
11+
from datetime import datetime, timedelta, tzinfo
1812
from string import digits
13+
import re
1914
import time
20-
import calendar
21-
from datetime import datetime, timedelta, tzinfo
15+
import warnings
16+
17+
from git.util import IterableList, IterableObj, Actor
2218

2319
# typing ------------------------------------------------------------
2420
from typing import (
2521
Any,
2622
Callable,
2723
Deque,
2824
Iterator,
29-
Generic,
25+
# Generic,
3026
NamedTuple,
3127
overload,
32-
Sequence, # NOQA: F401
28+
Sequence,
3329
TYPE_CHECKING,
3430
Tuple,
3531
Type,
@@ -38,7 +34,7 @@
3834
cast,
3935
)
4036

41-
from git.types import Has_id_attribute, Literal, _T # NOQA: F401
37+
from git.types import Has_id_attribute, Literal # , _T
4238

4339
if TYPE_CHECKING:
4440
from io import BytesIO, StringIO

‎git/refs/__init__.py‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4-
# flake8: noqa
54
# Import all modules in order, fix the names they require.
65

7-
from .symbolic import *
8-
from .reference import *
9-
from .head import *
10-
from .tag import *
11-
from .remote import *
6+
from .symbolic import * # noqa: F401 F403
7+
from .reference import * # noqa: F401 F403
8+
from .head import * # noqa: F401 F403
9+
from .tag import * # noqa: F401 F403
10+
from .remote import * # noqa: F401 F403
1211

13-
from .log import *
12+
from .log import * # noqa: F401 F403

‎git/refs/log.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
from git.types import PathLike
3232

3333
if TYPE_CHECKING:
34-
from git.refs import SymbolicReference
3534
from io import BytesIO
36-
from git.config import GitConfigParser, SectionConstraint # NOQA
35+
from git.refs import SymbolicReference
36+
from git.config import GitConfigParser, SectionConstraint
3737

3838
# ------------------------------------------------------------------------------
3939

‎git/refs/reference.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
# typing ------------------------------------------------------------------
1212

13-
from typing import Any, Callable, Iterator, Type, Union, TYPE_CHECKING # NOQA
14-
from git.types import Commit_ish, PathLike, _T # NOQA
13+
from typing import Any, Callable, Iterator, Type, Union, TYPE_CHECKING
14+
from git.types import Commit_ish, PathLike, _T
1515

1616
if TYPE_CHECKING:
1717
from git.repo import Repo

‎git/refs/symbolic.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4-
from git.types import PathLike
54
import os
65

76
from git.compat import defenc
@@ -31,8 +30,8 @@
3130
Union,
3231
TYPE_CHECKING,
3332
cast,
34-
) # NOQA
35-
from git.types import Commit_ish, PathLike # NOQA
33+
)
34+
from git.types import Commit_ish, PathLike
3635

3736
if TYPE_CHECKING:
3837
from git.repo import Repo

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL