Use pyproject.toml for tooling, add isort management of imports

.git-blame-ignore-revs

@@ -2,3 +2,5 @@
 e116d26eeca0891c31b689e43db5bb60b62f73f6
 # Commit that fixed a bunch of uneeded '...' '...' string joins from ^
 fa4225b625654c51c7b0be6efcfd6a1109768a72
+# Commit that added in isort formatting support
+6be0a8133a4fd9e12e6ac3affbdd69555b6c2503

octodns/cmds/args.py

@@ -7,6 +7,7 @@
 from logging.config import dictConfig
 from logging.handlers import SysLogHandler
 from sys import stderr, stdout
+
 from yaml import safe_load
 
 from octodns import __VERSION__

octodns/cmds/compare.py

@@ -3,8 +3,8 @@
 Octo-DNS Comparator
 '''
 
-from pprint import pprint
 import sys
+from pprint import pprint
 
 from octodns.cmds.args import ArgumentParser
 from octodns.manager import Manager

octodns/cmds/report.py

@@ -3,12 +3,13 @@
 Octo-DNS Reporter
 '''
 
+import re
 from concurrent.futures import ThreadPoolExecutor
-from dns.exception import Timeout
-from dns.resolver import NXDOMAIN, NoAnswer, NoNameservers, Resolver, query
 from logging import getLogger
 from sys import stdout
-import re
+
+from dns.exception import Timeout
+from dns.resolver import NXDOMAIN, NoAnswer, NoNameservers, Resolver, query
 
 from octodns.cmds.args import ArgumentParser
 from octodns.manager import Manager

octodns/idna.py

@@ -4,7 +4,9 @@
 
 from collections.abc import MutableMapping
 
-from idna import IDNAError as _IDNAError, decode as _decode, encode as _encode
+from idna import IDNAError as _IDNAError
+from idna import decode as _decode
+from idna import encode as _encode
 
 # Providers will need to to make calls to these at the appropriate points,
 # generally right before they pass names off to api calls. For an example of

octodns/manager.py

@@ -18,13 +18,10 @@
 from .yaml import safe_load
 from .zone import Zone
 
-
 # TODO: this can go away once we no longer support python 3.7
-try:
-    from importlib.metadata import (
-        PackageNotFoundError,
-        version as module_version,
-    )
+try:  # pragma: no cover
+    from importlib.metadata import PackageNotFoundError
+    from importlib.metadata import version as module_version
 except ModuleNotFoundError:  # pragma: no cover
 
     class PackageNotFoundError(Exception):

octodns/processor/ownership.py

@@ -6,7 +6,6 @@
 
 from ..provider.plan import Plan
 from ..record import Record
-
 from .base import BaseProcessor
 
 

octodns/provider/base.py

@@ -4,8 +4,8 @@
 
 from ..source.base import BaseSource
 from ..zone import Zone
-from .plan import Plan
 from . import SupportsException
+from .plan import Plan
 
 
 class BaseProvider(BaseSource):

octodns/provider/plan.py

@@ -2,11 +2,10 @@
 #
 #
 
+from io import StringIO
 from logging import DEBUG, ERROR, INFO, WARN, getLogger
 from sys import stdout
 
-from io import StringIO
-
 
 class UnsafePlan(Exception):
     pass

octodns/provider/yaml.py

@@ -2,15 +2,15 @@
 #
 #
 
+import logging
 from collections import defaultdict
 from os import listdir, makedirs
 from os.path import isdir, isfile, join
-import logging
 
 from ..record import Record
-from ..yaml import safe_load, safe_dump
-from .base import BaseProvider
+from ..yaml import safe_dump, safe_load
 from . import ProviderException
+from .base import BaseProvider
 
 
 class YamlProvider(BaseProvider):

octodns/record/__init__.py

@@ -17,14 +17,14 @@
 from .loc import LocRecord, LocValue
 from .mx import MxRecord, MxValue
 from .naptr import NaptrRecord, NaptrValue
-from .ns import NsValue, NsRecord
-from .ptr import PtrValue, PtrRecord
+from .ns import NsRecord, NsValue
+from .ptr import PtrRecord, PtrValue
 from .rr import Rr, RrParseError
 from .spf import SpfRecord
 from .srv import SrvRecord, SrvValue
 from .sshfp import SshfpRecord, SshfpValue
 from .tlsa import TlsaRecord, TlsaValue
-from .txt import TxtValue, TxtRecord
+from .txt import TxtRecord, TxtValue
 from .urlfwd import UrlfwdRecord, UrlfwdValue
 
 # quell warnings

octodns/record/chunked.py

@@ -2,9 +2,10 @@
 #
 #
 
-from .base import ValuesMixin
 import re
 
+from .base import ValuesMixin
+
 
 class _ChunkedValuesMixin(ValuesMixin):
     CHUNK_SIZE = 255

octodns/record/dynamic.py

@@ -2,8 +2,8 @@
 #
 #
 
-from logging import getLogger
 import re
+from logging import getLogger
 
 from .change import Update
 from .geo import GeoCodes

octodns/record/geo.py

@@ -2,8 +2,8 @@
 #
 #
 
-from logging import getLogger
 import re
+from logging import getLogger
 
 from ..equality import EqualityTupleMixin
 from .base import ValuesMixin

octodns/record/srv.py

@@ -2,9 +2,10 @@
 #
 #
 
-from fqdn import FQDN
 import re
 
+from fqdn import FQDN
+
 from ..equality import EqualityTupleMixin
 from ..idna import idna_encode
 from .base import Record, ValuesMixin

octodns/source/tinydns.py

@@ -2,13 +2,13 @@
 #
 #
 
+import logging
+import re
+import textwrap
 from collections import defaultdict
 from ipaddress import ip_address
 from os import listdir
 from os.path import join
-import logging
-import re
-import textwrap
 
 from ..record import Record
 from ..zone import DuplicateRecordException, SubzoneRecordException

octodns/yaml.py

@@ -3,10 +3,9 @@
 #
 
 from natsort import natsort_keygen
-from yaml import SafeDumper, SafeLoader, load, dump
-from yaml.representer import SafeRepresenter
+from yaml import SafeDumper, SafeLoader, dump, load
 from yaml.constructor import ConstructorError
-
+from yaml.representer import SafeRepresenter
 
 _natsort_key = natsort_keygen()
 

octodns/zone.py

@@ -2,9 +2,9 @@
 #
 #
 
+import re
 from collections import defaultdict
 from logging import getLogger
-import re
 
 from .idna import idna_decode, idna_encode
 from .record import Create, Delete

pyproject.toml

@@ -0,0 +1,12 @@
+[tool.black]
+line-length=80
+skip-string-normalization=true
+skip-magic-trailing-comma=true
+
+[tool.isort]
+profile = "black"
+known_first_party="octodns"
+line_length=80
+
+[tool.pytest.ini_options]
+pythonpath = "."

requirements-dev.txt

@@ -14,6 +14,7 @@ docutils==0.19
 exceptiongroup==1.0.0
 importlib-metadata==5.0.0
 iniconfig==1.1.1
+isort==5.11.4
 jaraco.classes==3.2.3
 keyring==23.9.3
 more-itertools==9.0.0

script/coverage

@@ -38,8 +38,6 @@ grep -r -I --line-number "# pragma: +no.*cover" $SOURCE_DIR && {
     exit 1
 }
 
-export PYTHONPATH=.:$PYTHONPATH
-
 pytest \
   --disable-network \
   --cov-reset \

script/format

@@ -6,4 +6,5 @@ SOURCES=$(find *.py octodns tests -name "*.py")
 
 . env/bin/activate
 
-black --line-length=80 --skip-string-normalization --skip-magic-trailing-comma "$@" $SOURCES
+isort "$@" $SOURCES
+black "$@" $SOURCES

script/test

@@ -30,6 +30,4 @@ export ARM_CLIENT_SECRET=
 export ARM_TENANT_ID=
 export ARM_SUBSCRIPTION_ID=
 
-export PYTHONPATH=.:$PYTHONPATH
-
 pytest --disable-network "$@"

setup.py

@@ -4,6 +4,7 @@
 from os import environ
 from os.path import dirname, join
 from subprocess import CalledProcessError, check_output
+
 import octodns
 
 try:
@@ -73,6 +74,7 @@ def version():
         + (
             'black>=22.3.0',
             'build>=0.7.0',
+            'isort>=5.11.4',
             'pycountry>=19.8.18',
             'pycountry-convert>=0.7.2',
             'pyflakes>=2.2.0',

tests/helpers.py

@@ -2,9 +2,9 @@
 #
 #
 
+from logging import getLogger
 from shutil import rmtree
 from tempfile import mkdtemp
-from logging import getLogger
 
 from octodns.processor.base import BaseProcessor
 from octodns.provider.base import BaseProvider

tests/test_octodns_manager.py

@@ -4,32 +4,31 @@
 
 from os import environ
 from os.path import dirname, isfile, join
+from unittest import TestCase
+from unittest.mock import MagicMock, patch
+
+from helpers import (
+    DynamicProvider,
+    GeoProvider,
+    NoSshFpProvider,
+    PlannableProvider,
+    SimpleProvider,
+    TemporaryDirectory,
+)
 
 from octodns import __VERSION__
 from octodns.idna import IdnaDict, idna_encode
 from octodns.manager import (
-    _AggregateTarget,
     MainThreadExecutor,
     Manager,
     ManagerException,
+    _AggregateTarget,
 )
 from octodns.processor.base import BaseProcessor
 from octodns.record import Create, Delete, Record
 from octodns.yaml import safe_load
 from octodns.zone import Zone
 
-from unittest import TestCase
-from unittest.mock import MagicMock, patch
-
-from helpers import (
-    DynamicProvider,
-    GeoProvider,
-    NoSshFpProvider,
-    PlannableProvider,
-    SimpleProvider,
-    TemporaryDirectory,
-)
-
 config_dir = join(dirname(__file__), 'config')
 
 

tests/test_octodns_plan.py

@@ -6,6 +6,8 @@
 from logging import getLogger
 from unittest import TestCase
 
+from helpers import SimpleProvider
+
 from octodns.provider.plan import (
     Plan,
     PlanHtml,
@@ -17,9 +19,6 @@
 from octodns.record import Create, Delete, Record, Update
 from octodns.zone import Zone
 
-from helpers import SimpleProvider
-
-
 simple = SimpleProvider()
 zone = Zone('unit.tests.', [])
 existing = Record.new(

tests/test_octodns_processor_ownership.py

@@ -4,13 +4,12 @@
 
 from unittest import TestCase
 
+from helpers import PlannableProvider
+
 from octodns.processor.ownership import OwnershipProcessor
 from octodns.record import Delete, Record
 from octodns.zone import Zone
 
-from helpers import PlannableProvider
-
-
 zone = Zone('unit.tests.', [])
 records = {}
 for record in [

tests/test_octodns_provider_yaml.py

@@ -5,22 +5,22 @@
 from os import makedirs
 from os.path import basename, dirname, isdir, isfile, join
 from unittest import TestCase
+
+from helpers import TemporaryDirectory
 from yaml import safe_load
 from yaml.constructor import ConstructorError
 
 from octodns.idna import idna_encode
-from octodns.record import NsValue, Create, Record, ValuesMixin
 from octodns.provider import ProviderException
 from octodns.provider.base import Plan
 from octodns.provider.yaml import (
-    _list_all_yaml_files,
     SplitYamlProvider,
     YamlProvider,
+    _list_all_yaml_files,
 )
+from octodns.record import Create, NsValue, Record, ValuesMixin
 from octodns.zone import SubzoneRecordException, Zone
 
-from helpers import TemporaryDirectory
-
 
 class TestYamlProvider(TestCase):
     def test_provider(self):