adopt flake8-tidy-imports to enforce O.1.5 (#223)

* make it show which rule is failing more clearly

* add tool and update config and convention docs

* add tool to lock file

* add example import that doesn't use from

* update own code to match

* format

* unformat

* format

* remove the exception note

* add another ok example

* try disabling mac testing for now

* try byte comparison

* ok, let's use an rstrip

Author: mshafer-NI

docs/Coding-Conventions.md

@@ -802,20 +802,21 @@ from collections import defaultdict
 from contextlib import contextmanager
 ```
 
-### [O.1.5] ✔️ **DO** Use absolute imports
+### [O.1.5] ✔️ **DO** Use absolute imports 💻
 
 > 🐍 This rule stems from [PEP 8](https://www.python.org/dev/peps/pep-0008)
 
-ℹ️ An exception can be made for `__init__.py` files republishing child module declarations
+> 💻 This rule is enforced by error code I252
 
 ```python
-# Bad
+# Bad - will produce I252
 from . import sibling
 from .sibling import rivalry
 ```
 
 ```python
 # Good
+import my_app.relationships.parents
 from my_app.relationships.sibling import rivalry
 ```
 
@@ -869,8 +870,9 @@ import os  # Assuming os is never used
 ```
 
 ```python
-# Good - assuming we are in a __init__.py file
-from .mysubmodule import spam, eggs  # OK even if neither are used in this module
+# Good - assuming we are in a monty/__init__.py file
+from monty import sandwich_shop
+from monty.mysubmodule import spam, eggs  # OK even if neither are used in this module
 ```
 
 

ni_python_styleguide/_utils/__init__.py

@@ -1,6 +1,6 @@
-from . import code_analysis  # noqa: F401
-from . import lint  # noqa: F401
-from . import string_helpers  # noqa: F401
-from . import temp_file  # noqa: F401
+from ni_python_styleguide._utils import code_analysis  # noqa: F401
+from ni_python_styleguide._utils import lint  # noqa: F401
+from ni_python_styleguide._utils import string_helpers  # noqa: F401
+from ni_python_styleguide._utils import temp_file  # noqa: F401
 
 DEFAULT_ENCODING = "UTF-8"

ni_python_styleguide/config.ini

@@ -129,3 +129,5 @@ docstring-convention=all
 
 # flake8-import-order
 import-order-style=smarkets
+
+ban-relative-imports = True

poetry.lock

@@ -38,6 +38,10 @@ isort = ">=5.10"
 flake8-black = ">=0.2.1"
 flake8-docstrings = ">=1.5.0"
 flake8-import-order = ">=0.18.1"
+flake8-tidy-imports = [
+    {version = ">=4.4.1", python = ">=3.7,<3.9"},
+    {version=">=4.11.0", python="^3.9"},
+]
 pep8-naming = ">=0.11.1"
 
 # Rejected flake8 plugins should be listed here (in alphabetical order)

pyproject.toml

@@ -1 +0,0 @@
-

tests/test_cli/format_test_cases__snapshots/blank_file/output.diff

@@ -13,5 +13,4 @@
 
 -x = 5
 ?     ^
-+x = 5
-
++x = 5

tests/test_cli/format_test_cases__snapshots/file_with_hanging_whitespace/output.diff

@@ -16,5 +16,4 @@
 +
 
  @click.command()
- def _main():
-
+ def _main():

tests/test_cli/format_test_cases__snapshots/file_with_malsorted_imports/output.diff

@@ -24,7 +24,7 @@ def test_given_input_file__produces_expected_output_simple(
     output = styleguide_command(command="format")
 
     assert output.exit_code in (True, 0), f"Error in running:\n{output}"
-    result = test_file.read_text(encoding="UTF-8")
+    result = test_file.read_text()
     snapshot.snapshot_dir = test_dir
     snapshot.assert_match(result, "output.py")
 
@@ -44,6 +44,8 @@ def test_given_input_file__produces_expected_output_diff(
 
     assert output.exception is None
     result = output.stdout.replace(str(test_file), in_file.relative_to(TEST_CASE_DIR).as_posix())
+    # to make line endings on different platforms consistent
+    result = result.rstrip()
     snapshot.snapshot_dir = test_dir
     snapshot.assert_match(result, "output.diff")
 

tests/test_cli/test_format.py

@@ -53,4 +53,6 @@ def test_rule_documents_enforcement_codes(rule):
     if rule.is_automatically_enforced:
         assert rule.error_codes is not None
     else:
-        assert rule.error_codes is None
+        assert (
+            rule.error_codes is None
+        ), f"Rule ({rule.identifier}) is not marked as automatically enforced, but lists an error code {rule.error_codes}"