Replace flake8 with ruff (#2617)

Borda · EnricoMi · web-flow · commit 42c3b47c851c · 2023-07-19T09:39:21.000+02:00
Co-authored-by: Enrico Minack &lt;github@enrico.minack.dev&gt;
diff --git a/.isort.cfg b/.isort.cfg
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -11,14 +11,7 @@ repos:
     rev: 22.10.0
     hooks:
       - id: black
-  - repo: https://github.com/asottile/seed-isort-config
-    rev: v2.2.0
-    hooks:
-      - id: seed-isort-config
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.10.1
-    hooks:
-      - id: isort
+
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.1
     hooks:
@@ -33,7 +26,9 @@ repos:
       - id: pyupgrade
         args:
           - --py37-plus
-  - repo: https://github.com/pycqa/flake8
-    rev: 3.9.2
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.0.278'
     hooks:
-      - id: flake8
+      - id: ruff
+        args: ["--fix"]
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -25,7 +25,7 @@ Ideally, changes should be made in logical commits and tests added to improve th
 
 ## Coding style
 
-PyGithub adopts the black coding style and uses isort to sort imports.
+PyGithub adopts the black coding style.
 
 To manually format the code:
 ```bash
diff --git a/doc/conf.py b/doc/conf.py
@@ -35,7 +35,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath(".."))
-from importlib.metadata import version  # noqa: E402, isort:skip
+from importlib.metadata import version  # noqa: E402
 
 setupVersion = version("pygithub")
 
diff --git a/github/GitReleaseAsset.pyi b/github/GitReleaseAsset.pyi
@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Any, Dict, Union
+from typing import Any, Dict
 
 from github.GithubObject import CompletableGithubObject
 from github.NamedUser import NamedUser
diff --git a/github/GithubApp.pyi b/github/GithubApp.pyi
@@ -1,6 +1,6 @@
+from datetime import datetime
 from typing import Any, Dict, List
 
-from datetime import datetime
 from github.GithubObject import CompletableGithubObject
 from github.NamedUser import NamedUser
 
diff --git a/github/GithubIntegration.pyi b/github/GithubIntegration.pyi
@@ -1,4 +1,4 @@
-from typing import Union, Optional, Dict
+from typing import Dict, Optional, Union
 
 from urllib3 import Retry
 
diff --git a/github/MainClass.pyi b/github/MainClass.pyi
@@ -2,9 +2,11 @@ from datetime import datetime
 from io import BytesIO
 from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar, Union, overload
 
-from github.Auth import Auth
+from urllib3.util import Retry
+
 from github.AppAuthentication import AppAuthentication
 from github.ApplicationOAuth import ApplicationOAuth
+from github.Auth import Auth
 from github.AuthenticatedUser import AuthenticatedUser
 from github.Commit import Commit
 from github.ContentFile import ContentFile
@@ -25,8 +27,6 @@ from github.RateLimit import RateLimit
 from github.Repository import Repository
 from github.Topic import Topic
 
-from urllib3.util import Retry
-
 TGithubObject = TypeVar("TGithubObject", bound=GithubObject)
 
 DEFAULT_BASE_URL: str
diff --git a/github/Migration.pyi b/github/Migration.pyi
@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List
 
 from github.GithubObject import CompletableGithubObject
 from github.NamedUser import NamedUser
diff --git a/github/Plan.pyi b/github/Plan.pyi
@@ -1,4 +1,4 @@
-from typing import Any, Dict, Union
+from typing import Any, Dict
 
 from github.GithubObject import NonCompletableGithubObject
 
diff --git a/github/Repository.pyi b/github/Repository.pyi
@@ -54,7 +54,6 @@ from github.RepositoryAdvisory import RepositoryAdvisory
 from github.RepositoryAdvisoryCredit import RepositoryAdvisoryCredit
 from github.RepositoryAdvisoryVulnerability import (
     AdvisoryVulnerability,
-    RepositoryAdvisoryVulnerability,
 )
 from github.RepositoryKey import RepositoryKey
 from github.RepositoryPreferences import RepositoryPreferences
diff --git a/github/SourceImport.pyi b/github/SourceImport.pyi
@@ -1,4 +1,4 @@
-from typing import Any, Dict, Optional
+from typing import Any, Dict
 
 from github.GithubObject import CompletableGithubObject
 
diff --git a/github/StatsContributor.pyi b/github/StatsContributor.pyi
@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List
 
 from github.GithubObject import NonCompletableGithubObject
 from github.NamedUser import NamedUser
diff --git a/github/Team.pyi b/github/Team.pyi
@@ -1,9 +1,9 @@
 from typing import Any, Dict, Union
 
 from github.GithubObject import CompletableGithubObject, _NotSetType
+from github.Membership import Membership
 from github.NamedUser import NamedUser
 from github.Organization import Organization
-from github.Membership import Membership
 from github.PaginatedList import PaginatedList
 from github.Permissions import Permissions
 from github.Repository import Repository
diff --git a/github/Topic.pyi b/github/Topic.pyi
@@ -1,5 +1,4 @@
 from datetime import datetime
-
 from typing import Any, Dict
 
 from github.GithubObject import NonCompletableGithubObject
diff --git a/manage.sh b/manage.sh
@@ -9,10 +9,6 @@ function publish {
     push
 }
 
-function check {
-    flake8
-}
-
 function fix_headers {
     python scripts/fix_headers.py
 }
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,25 @@ module = ["github.*"]
 check_untyped_defs = true
 disallow_untyped_defs = true
 
+
 [tool.black]
 # https://github.com/psf/black
 line-length = 120
 target-version = ['py37']
+
+
+[tool.ruff]
+line-length = 120
+target-version = "py37"
+# Enable Pyflakes `E` and `F` codes by default.
+select = [
+    "E", "W",  # see: https://pypi.org/project/pycodestyle
+    "F",  # see: https://pypi.org/project/pyflakes
+    "I",  # see: isort
+]
+ignore = [
+    "E501",
+    "E741",
+]
+ignore-init-module-imports = true
+unfixable = ["F401"]
diff --git a/tox.ini b/tox.ini
@@ -35,8 +35,3 @@ basepython = python3.8
 skip_install = true
 deps = -rrequirements.txt
 commands = sphinx-build doc build
-
-[flake8]
-max-line-length = 120
-select = C,E,F,W
-ignore = E266, E501, W503

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from typing import Union, Optional, Dict`
	`1`	`+from typing import Dict, Optional, Union`
`2`	`2`
`3`	`3`	`from urllib3 import Retry`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from typing import Any, Dict, Union`
	`1`	`+from typing import Any, Dict`
`2`	`2`
`3`	`3`	`from github.GithubObject import NonCompletableGithubObject`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,6 @@ from github.RepositoryAdvisory import RepositoryAdvisory`
`54`	`54`	`from github.RepositoryAdvisoryCredit import RepositoryAdvisoryCredit`
`55`	`55`	`from github.RepositoryAdvisoryVulnerability import (`
`56`	`56`	`AdvisoryVulnerability,`
`57`		`- RepositoryAdvisoryVulnerability,`
`58`	`57`	`)`
`59`	`58`	`from github.RepositoryKey import RepositoryKey`
`60`	`59`	`from github.RepositoryPreferences import RepositoryPreferences`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from typing import Any, Dict, Optional`
	`1`	`+from typing import Any, Dict`
`2`	`2`
`3`	`3`	`from github.GithubObject import CompletableGithubObject`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`from datetime import datetime`
`2`		`-`
`3`	`2`	`from typing import Any, Dict`
`4`	`3`
`5`	`4`	`from github.GithubObject import NonCompletableGithubObject`
Original file line number	Diff line number	Diff line change
`@@ -9,10 +9,6 @@ function publish {`
`9`	`9`	`push`
`10`	`10`	`}`
`11`	`11`
`12`		`-function check {`
`13`		`- flake8`
`14`		`-}`
`15`		`-`
`16`	`12`	`function fix_headers {`
`17`	`13`	`python scripts/fix_headers.py`
`18`	`14`	`}`