Add isort (#1689)

* add: isort configure file

* fix: isort

$ isort .

* add: isort to dev deps

* add: isort to CI

* fix: move .isort.cfg into setup.cfg

* fix: re-formatted

* fix: isort target path

* Use pre-commit to check isort

pre-commit CI can auto fix this, and this way we can idenpendently evaluate
the formatting of the code from the validity of the code.

Co-authored-by: Iwan Aucamp <aucampia@gmail.com>

.github/workflows/validate.yaml

@@ -88,6 +88,7 @@ jobs:
             test_harness+="./with-fuseki.sh"
           fi
           black --config black.toml --check --diff ./rdflib || true
+          isort --check-only --diff . || true
           flake8 --exit-zero rdflib
           mypy --show-error-context --show-error-codes
           "${test_harness[@]}" pytest -ra --cov

.pre-commit-config.yaml

@@ -5,6 +5,15 @@ ci:
   autofix_prs: false
 
 repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+    - id: isort
+      # This is here to defer file selection to isort which will do it based on
+      # black config.
+      pass_filenames: false
+      require_serial: true
+      args: ["."]
   - repo: local
     hooks:
     # using a local hook for black because of an issue that arises when using

examples/film.py

@@ -22,17 +22,17 @@
 """
 import datetime
 import os
-import sys
 import re
+import sys
 import time
 
 try:
     import imdb
 except ImportError:
     imdb = None
 
-from rdflib import BNode, ConjunctiveGraph, URIRef, Literal, Namespace
-from rdflib.namespace import FOAF, DC, RDF
+from rdflib import BNode, ConjunctiveGraph, Literal, Namespace, URIRef
+from rdflib.namespace import DC, FOAF, RDF
 
 storefn = os.path.expanduser("~/movies.n3")
 # storefn = '/home/simon/codes/film.dev/movies.n3'

rdflib/extras/describer.py

@@ -106,12 +106,10 @@
 """
 
 from contextlib import contextmanager
+
 from rdflib.graph import Graph
 from rdflib.namespace import RDF
-from rdflib.term import BNode
-from rdflib.term import Identifier
-from rdflib.term import Literal
-from rdflib.term import URIRef
+from rdflib.term import BNode, Identifier, Literal, URIRef
 
 
 class Describer(object):

rdflib/extras/infixowl.py

@@ -109,17 +109,15 @@
 """
 
 import itertools
+import logging
 
-from rdflib import BNode, Literal, Namespace, RDF, RDFS, URIRef, Variable
-from rdflib.graph import Graph
+from rdflib import RDF, RDFS, BNode, Literal, Namespace, URIRef, Variable
 from rdflib.collection import Collection
-from rdflib.namespace import OWL, XSD
-from rdflib.namespace import NamespaceManager
+from rdflib.graph import Graph
+from rdflib.namespace import OWL, XSD, NamespaceManager
 from rdflib.term import Identifier
 from rdflib.util import first
 
-import logging
-
 logger = logging.getLogger(__name__)
 
 

rdflib/plugins/parsers/notation3.py

@@ -27,32 +27,30 @@
 Copyright 2010, Gunnar A. Grimnes
 
 """
-import sys
+import codecs
 import os
 import re
-import codecs
-from typing import IO, TYPE_CHECKING, Any, Callable, Dict, Optional, TypeVar, Union
+import sys
 
 # importing typing for `typing.List` because `List`` is used for something else
 import typing
-
 from decimal import Decimal
-
+from typing import IO, TYPE_CHECKING, Any, Callable, Dict, Optional, TypeVar, Union
 from uuid import uuid4
 
+from rdflib.compat import long_type
 from rdflib.exceptions import ParserError
+from rdflib.graph import ConjunctiveGraph, Graph, QuotedGraph
 from rdflib.term import (
+    _XSD_PFX,
+    BNode,
     Identifier,
+    Literal,
     Node,
     URIRef,
-    BNode,
-    Literal,
     Variable,
-    _XSD_PFX,
     _unique_id,
 )
-from rdflib.graph import QuotedGraph, ConjunctiveGraph, Graph
-from rdflib.compat import long_type
 
 __all__ = [
     "BadSyntax",

rdflib/plugins/parsers/ntriples.py

@@ -6,18 +6,17 @@
 Author: Sean B. Palmer, inamidst.com
 """
 
-import re
 import codecs
+import re
+from io import BytesIO, StringIO, TextIOBase
 from typing import IO, TYPE_CHECKING, Optional, Pattern, TextIO, Union
 
-from rdflib.term import Node, URIRef as URI
-from rdflib.term import BNode as bNode
-from rdflib.term import Literal
-from rdflib.compat import decodeUnicodeEscape, _string_escape_map
+from rdflib.compat import _string_escape_map, decodeUnicodeEscape
 from rdflib.exceptions import ParserError as ParseError
 from rdflib.parser import InputSource, Parser
-
-from io import StringIO, TextIOBase, BytesIO
+from rdflib.term import BNode as bNode
+from rdflib.term import Literal, Node
+from rdflib.term import URIRef as URI
 
 if TYPE_CHECKING:
     from rdflib.graph import Graph

rdflib/tools/rdfpipe.py

@@ -5,20 +5,18 @@
 resulting graph to a chosen format.
 """
 
+import logging
 import sys
 from optparse import OptionParser
-import logging
 
 import rdflib
 from rdflib import plugin
-from rdflib.store import Store
 from rdflib.graph import ConjunctiveGraph
 from rdflib.parser import Parser
 from rdflib.serializer import Serializer
-
+from rdflib.store import Store
 from rdflib.util import guess_format
 
-
 DEFAULT_INPUT_FORMAT = "xml"
 DEFAULT_OUTPUT_FORMAT = "n3"
 

requirements.dev.txt

@@ -9,6 +9,7 @@ myst-parser
 pytest
 pytest-cov
 pytest-subtests
+isort
 sphinx
 sphinxcontrib-apidoc
 sphinxcontrib-kroki

setup.cfg

@@ -36,6 +36,34 @@ exclude = (?x)(
     ^.*test/plugins/.*/setup.py$
   )
 
+[isort]
+profile = black
+py_version = 37
+line_length = 88
+supported_extensions =
+    pyw
+    pyi
+skip =
+    .eggs         # exclude a few common directories in the
+    .git          # root of the project
+    .hg
+    .mypy_cache
+    .pytest_cache
+    .tox
+    .venv
+    .github
+    _build
+    htmlcov
+    benchmarks
+    examples       # No need to Black examples
+    test           # Tests are a mess, don't black them
+    test_reports
+    rdflib.egg-info
+    buck-out
+    build
+    dist
+    venv
+
 [tool:pytest]
 addopts =
    --doctest-modules

setup.py

@@ -1,9 +1,10 @@
 #!/usr/bin/env python
 
+import codecs
 import os
 import re
-import codecs
-from setuptools import setup, find_packages
+
+from setuptools import find_packages, setup
 
 kwargs = {}
 kwargs["install_requires"] = [

test/test_issue200.py

@@ -1,10 +1,11 @@
 #!/usr/bin/env python
 
 import os
-import rdflib
 import unittest
+
 import pytest
 
+import rdflib
 
 if os.name == "nt":
     pytestmark = pytest.mark.skip(

test/test_serializer_trix.py

@@ -1,12 +1,11 @@
 #!/usr/bin/env python
 
 import unittest
-
-from rdflib.graph import ConjunctiveGraph
-from rdflib.term import URIRef, Literal
-from rdflib.graph import Graph
 from io import BytesIO
 
+from rdflib.graph import ConjunctiveGraph, Graph
+from rdflib.term import Literal, URIRef
+
 
 class TestTrixSerialize(unittest.TestCase):
     def setUp(self):

test/test_trix_parse.py

@@ -1,11 +1,10 @@
 #!/usr/bin/env python
 import os
-
-from rdflib.graph import ConjunctiveGraph
 import unittest
-
 from test import TEST_DIR
 
+from rdflib.graph import ConjunctiveGraph
+
 
 class TestTrixParse(unittest.TestCase):
     def setUp(self):