Use isort instead of reorder-python-imports.

psf/black#4175

.pre-commit-config.yaml

@@ -2,13 +2,10 @@ exclude: ^src/reader/_vendor/.*$
 
 repos:
 
-  - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.12.0
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
     hooks:
-      - id: reorder-python-imports
-        name: Reorder Python imports (src, tests)
-        files: "^(?!examples/)"
-        args: ["--application-directories", ".:src"]
+      - id: isort
 
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.15.0

docs/conf.py

@@ -6,6 +6,7 @@
 import packaging.version
 from setuptools.config.pyprojecttoml import read_configuration
 
+
 sys.path.insert(0, os.path.abspath('../src'))
 
 # mock some things "by hand", so we can import reader below without any dependencies
@@ -23,6 +24,7 @@
 
 import reader
 
+
 extensions = [
     'sphinx_rtd_theme',
     'sphinx.ext.autodoc',
@@ -155,6 +157,7 @@
 
 
 import pkgutil
+
 from docutils import nodes
 from sphinx.util.docutils import SphinxDirective
 

pyproject.toml

@@ -179,3 +179,14 @@ module = [
     "reader._vendor.feedparser.*",
 ]
 ignore_errors = true
+
+[tool.isort]
+profile = "black"
+py_version = 310
+src_paths = ["src", "tests"]
+extend_skip = ["examples", "src/reader/_vendor"]
+skip_gitignore = true
+filter_files = true
+force_single_line = true
+order_by_type = false
+lines_after_imports = 2

scripts/bench.py

@@ -14,14 +14,15 @@
 
 import click
 
+
 root_dir = os.path.dirname(__file__)
 sys.path.insert(0, os.path.join(root_dir, '../src'))
 sys.path.insert(0, os.path.join(root_dir, '../tests'))
 
 from fakeparser import Parser
-
 from reader import make_reader
-from reader._app import create_app, get_reader
+from reader._app import create_app
+from reader._app import get_reader
 from reader._config import make_reader_config
 
 

scripts/generate_import_all.py

@@ -1,6 +1,7 @@
 import inspect
 import random
 
+
 context = {}
 exec('from reader import *', context)
 context.pop('__builtins__')

scripts/jscontrols.py

@@ -8,10 +8,12 @@
 from flask import redirect
 from flask import request
 
+
 root_dir = os.path.dirname(__file__)
 sys.path.insert(0, os.path.join(root_dir, '../src'))
 
-from reader._app.api_thing import APIThing, APIError
+from reader._app.api_thing import APIError
+from reader._app.api_thing import APIThing
 
 
 app = Flask(

src/reader/__init__.py

@@ -39,6 +39,8 @@
 
 __version__ = '3.13.dev0'
 
+# isort: off
+
 from .core import (
     Reader as Reader,
     make_reader as make_reader,

src/reader/__main__.py

@@ -1,5 +1,6 @@
 import sys
 
+
 CANNOT_IMPORT = """\
 Error: cannot import reader._cli
 

src/reader/_app/__init__.py

@@ -28,8 +28,6 @@
 from flask import url_for
 
 import reader
-from .api_thing import APIError
-from .api_thing import APIThing
 from reader import Content
 from reader import Entry
 from reader import EntrySearchResult
@@ -40,6 +38,9 @@
 from reader.types import _get_entry_content
 from reader.types import TristateFilterInput
 
+from .api_thing import APIError
+from .api_thing import APIThing
+
 
 blueprint = Blueprint('reader', __name__)
 

src/reader/_app/cli.py

@@ -30,6 +30,7 @@ def serve(config, host, port, plugin, verbose):
     """Start a local HTTP reader server."""
     setup_logging(verbose)
     from werkzeug.serving import run_simple
+
     from . import create_app
 
     if plugin:

src/reader/_cli.py

@@ -11,6 +11,7 @@
 import yaml
 
 import reader
+
 from . import StorageError
 from ._config import make_reader_config
 from ._config import make_reader_from_config

src/reader/_config.py

@@ -9,10 +9,11 @@
 from dataclasses import dataclass
 from dataclasses import field
 
-from .plugins import DEFAULT_PLUGINS
 from reader import make_reader
 from reader._plugins import Loader
 
+from .plugins import DEFAULT_PLUGINS
+
 
 MAKE_READER_IMPORT_KWARGS = ('storage_cls', 'search_cls')
 

src/reader/_parser/__init__.py

@@ -30,6 +30,7 @@
 from .requests import SessionFactory
 from .requests import TimeoutType
 
+
 if TYPE_CHECKING:  # pragma: no cover
     from ._lazy import Parser as Parser
 
@@ -66,8 +67,8 @@ def default_parser(
         file_retriever = FileRetriever(feed_root)
 
     def post_init(parser: Parser) -> None:
-        from .http import HTTPRetriever
         from .feedparser import FeedparserParser
+        from .http import HTTPRetriever
         from .jsonfeed import JSONFeedParser
 
         parser.session_factory.timeout = session_timeout

src/reader/_parser/_http_utils.py

@@ -6,6 +6,7 @@
 
 import werkzeug.http
 
+
 parse_options_header = werkzeug.http.parse_options_header
 parse_accept_header = werkzeug.http.parse_accept_header
 

src/reader/_parser/_lazy.py

@@ -11,6 +11,11 @@
 from typing import Any
 from typing import ContextManager
 
+from .._types import FeedForUpdate
+from .._types import ParsedFeed
+from .._utils import MapFunction
+from ..exceptions import InvalidFeedURLError
+from ..exceptions import ParseError
 from . import EntryPair
 from . import EntryPairsParserType
 from . import FeedArgument
@@ -22,11 +27,6 @@
 from . import RetrieverType
 from . import wrap_cm_exceptions
 from . import wrap_exceptions
-from .._types import FeedForUpdate
-from .._types import ParsedFeed
-from .._utils import MapFunction
-from ..exceptions import InvalidFeedURLError
-from ..exceptions import ParseError
 from ._http_utils import parse_accept_header
 from ._http_utils import unparse_accept_header
 from ._url_utils import normalize_url

src/reader/_parser/file.py

@@ -7,9 +7,9 @@
 from typing import Any
 from typing import IO
 
+from ..exceptions import ParseError
 from . import RetrieveResult
 from . import wrap_exceptions
-from ..exceptions import ParseError
 from ._url_utils import extract_path
 from ._url_utils import resolve_root
 

src/reader/_parser/http.py

@@ -9,9 +9,9 @@
 
 import requests
 
+from ..exceptions import ParseError
 from . import RetrieveResult
 from . import wrap_exceptions
-from ..exceptions import ParseError
 from ._http_utils import parse_options_header
 from .requests import SessionWrapper
 

src/reader/_parser/jsonfeed.py

@@ -18,6 +18,7 @@
 from ..types import Content
 from ..types import Enclosure
 
+
 if TYPE_CHECKING:  # pragma: no cover
     from . import FeedAndEntries
     from .requests import Headers

src/reader/_parser/requests/__init__.py

@@ -20,8 +20,10 @@
 
 from ..._utils import lazy_import
 
+
 if TYPE_CHECKING:  # pragma: no cover
     import requests
+
     from ._lazy import SessionWrapper as SessionWrapper
 
 __getattr__ = lazy_import(__name__, ['SessionWrapper', 'TimeoutHTTPAdapter'])
@@ -115,7 +117,8 @@ def __call__(self) -> SessionWrapper:
             SessionWrapper:
 
         """
-        from . import SessionWrapper, TimeoutHTTPAdapter
+        from . import SessionWrapper
+        from . import TimeoutHTTPAdapter
 
         session = SessionWrapper(
             request_hooks=list(self.request_hooks),

src/reader/_parser/requests/_lazy.py

@@ -11,8 +11,10 @@
 
 from . import TimeoutType
 
+
 if TYPE_CHECKING:  # pragma: no cover
     from typing_extensions import Self
+
     from . import Headers
     from . import RequestHook
     from . import ResponseHook

src/reader/_plugins/enclosure_tags.py

@@ -37,6 +37,7 @@
 from flask import stream_with_context
 from flask import url_for
 
+
 blueprint = Blueprint('enclosure_tags', __name__)
 
 

src/reader/_plugins/sqlite_releases.py

@@ -34,6 +34,7 @@
 from reader._types import EntryData
 from reader._types import FeedData
 
+
 warnings.filterwarnings(
     'ignore',
     message='No parser was explicitly specified',

src/reader/_plugins/timer.py

@@ -200,7 +200,7 @@ def init_reader(reader):
         pass
     end = perf_counter()
 
-    print(f"{end-start:1.6f}")
+    print(f"{end - start:1.6f}")
     print(f"{reader.timer.total('Reader.'):1.6f}")
     print(reader.timer.format_stats())
     print(reader.make_reader_reserved_name('ok'))

src/reader/_storage/_base.py

@@ -10,8 +10,8 @@
 from typing import Any
 from typing import TypeVar
 
-from . import _sqlite_utils
 from ..exceptions import StorageError
+from . import _sqlite_utils
 from ._sql_utils import paginated_query
 from ._sql_utils import Query
 
@@ -70,8 +70,9 @@ def get_db(self) -> sqlite3.Connection:
     def setup_db(db: sqlite3.Connection) -> None:
         # Private API, used by tests.
 
+        from . import MINIMUM_SQLITE_VERSION
+        from . import REQUIRED_SQLITE_FUNCTIONS
         from ._schema import MIGRATION
-        from . import MINIMUM_SQLITE_VERSION, REQUIRED_SQLITE_FUNCTIONS
 
         return _sqlite_utils.setup_db(
             db,

src/reader/_storage/_changes.py

@@ -12,6 +12,7 @@
 from ._sql_utils import Query
 from ._sqlite_utils import ddl_transaction
 
+
 if TYPE_CHECKING:  # pragma: no cover
     from ._base import StorageBase
 

src/reader/_storage/_entries.py

@@ -36,6 +36,7 @@
 from ._tags import entry_tags_filter
 from ._tags import feed_tags_filter
 
+
 if TYPE_CHECKING:  # pragma: no cover
     from ._base import StorageBase
 else:

src/reader/_storage/_feeds.py

@@ -27,6 +27,7 @@
 from ._sqlite_utils import rowcount_exactly_one
 from ._tags import feed_tags_filter
 
+
 if TYPE_CHECKING:  # pragma: no cover
     from ._base import StorageBase
 else:

src/reader/_storage/_html_utils.py

@@ -7,6 +7,7 @@
 import warnings
 from typing import TYPE_CHECKING
 
+
 if TYPE_CHECKING:  # pragma: no cover
     import bs4
 

src/reader/_storage/_schema.py

@@ -230,8 +230,8 @@ def update_from_37_to_38(db: sqlite3.Connection, /) -> None:  # pragma: no cover
 def update_from_38_to_39(db: sqlite3.Connection, /) -> None:  # pragma: no cover
     # https://github.com/lemon24/reader/issues/323
 
-    from ._search import Search
     from ._changes import Changes
+    from ._search import Search
 
     db.execute("ALTER TABLE entries ADD COLUMN sequence BLOB;")
 

src/reader/_storage/_search.py

@@ -15,10 +15,6 @@
 from typing import Any
 from typing import TypeVar
 
-from . import _entries
-from . import _html_utils
-from . import _sqlite_utils
-from . import Storage
 from .._types import Action
 from .._types import Change
 from .._types import EntryFilter
@@ -33,6 +29,10 @@
 from ..types import EntrySearchResult
 from ..types import HighlightedString
 from ..types import SearchSortOrder
+from . import _entries
+from . import _html_utils
+from . import _sqlite_utils
+from . import Storage
 from ._sql_utils import paginated_query
 from ._sql_utils import Query
 from ._sqlite_utils import ddl_transaction

src/reader/_storage/_sql_utils.py

@@ -37,8 +37,10 @@
 from typing import TypeVar
 from typing import Union
 
+
 if TYPE_CHECKING:  # pragma: no cover
     import sqlite3
+
     from typing_extensions import Self