Configure and use isort 😍

This should, eventually (with e.g. instructions in the contribution section, CI, etc.) make it easier to contribute to refex without breaking any style things. It also resolves a bunch of bad imports that are bad for various reasons (e.g. not moving the raw_ast import when it was renamed to ast_matchers, or stuff about whether typing is a third-party library, or...)

Pretty much everything looks good. Humongous thanks to @timothycrosley and everyone on [isort issue #1486](PyCQA/isort#1486).

This also lets me ignore the internal linter that keeps bugging me about where refex imports go. One would imagine they should go in the first-party section -- internal linter doesn't agree (for reasons described in that issue), but it's hard to standardize on a lint-unfriendly order without some tool like isort to help back me up.

PiperOrigin-RevId: 332093853

docs/conf.py

@@ -16,6 +16,7 @@
 
 import os
 import sys
+
 sys.path.insert(0, os.path.abspath('..'))
 
 # -- Project information -----------------------------------------------------

pyproject.toml

@@ -39,6 +39,16 @@ pytest = "^6"
 [tool.poetry.extras]
 docs = ["m2r", "sphinx"]
 
+[tool.isort]
+profile = "google"
+# Upstream version within Google actually uses contextlib2 and mock for Python 2
+# compatibility, and this is transformed away by copybara.
+# Adding contextlib2 to the stdlib makes the sorting correct in the canonical
+# github version even when run on the upstream version pre-copybara. Adding
+# mock... doesn't help as much (sorts as "mock", not "unittest").
+# These can both go away starting in 2021.
+extra_standard_library = ["contextlib2", "mock"]
+
 # https://tox.readthedocs.io/
 [tool.tox]
 legacy_tox_ini = """

refex/cli.py

@@ -36,22 +36,23 @@
 import io
 import json
 import os
-import pkg_resources
 import re
 import sys
 import tempfile
 import textwrap
 import traceback
-from typing import Dict, List, Iterable, Optional, Text, Tuple, Union
+from typing import Dict, Iterable, List, Optional, Text, Tuple, Union
 
 from absl import app
 import attr
 import colorama
+import pkg_resources
+import six
+
 from refex import formatting
 from refex import search
 from refex.fix import find_fixer
 from refex.python import syntactic_template
-import six
 
 _IGNORABLE_ERRNO = frozenset([
     errno.ENOENT,  # file was removed after we went looking

refex/fix/fixer.py

@@ -20,16 +20,17 @@
 
 import abc
 import operator
+from typing import Callable, List, Mapping, Optional, Text, TypeVar
 
 import attr
+import six
+
 from refex import formatting
 from refex import future_string
 from refex import search
 from refex import substitution
 from refex.python import matcher
 from refex.python.matchers import syntax_matchers
-import six
-from typing import Callable, List, Mapping, Optional, Text, TypeVar
 
 
 class ParsedPythonFixer(

refex/fix/fixers/correctness_fixers.py

@@ -25,14 +25,14 @@
 from __future__ import print_function
 from __future__ import unicode_literals  # for convenience
 
+import six
+
 from refex import formatting
 from refex.fix import fixer
 from refex.python import syntactic_template
 from refex.python.matchers import ast_matchers
 from refex.python.matchers import base_matchers
 from refex.python.matchers import syntax_matchers
-import six
-
 
 # Python 2 compatibility hack to be able to get b'...' and '...'.
 if six.PY2:

refex/fix/fixers/idiom_fixers.py

@@ -22,6 +22,7 @@
 from __future__ import unicode_literals  # for convenience
 
 import textwrap
+
 from refex import formatting
 from refex import future_string
 from refex.fix import fixer

refex/fix/fixers/modern_python_fixers.py

@@ -17,14 +17,15 @@
 from __future__ import division
 from __future__ import print_function
 from __future__ import unicode_literals  # for convenience
+
+import six
+
 from refex import formatting
 from refex.fix import fixer
 from refex.python import syntactic_template
 from refex.python.matchers import ast_matchers
 from refex.python.matchers import base_matchers
 from refex.python.matchers import syntax_matchers
-import six
-
 
 SIMPLE_PYTHON_FIXERS = []  # Disabled except when running in Python 2.
 

refex/fix/fixers/test_correctness_fixers.py

@@ -22,6 +22,7 @@
 
 from absl.testing import absltest
 from absl.testing import parameterized
+
 from refex import search
 from refex.fix import fixer
 from refex.fix.fixers import correctness_fixers

refex/fix/fixers/test_idiom_fixers.py

@@ -23,10 +23,11 @@
 
 from absl.testing import absltest
 from absl.testing import parameterized
+import six
+
 from refex import search
 from refex.fix import fixer
 from refex.fix.fixers import idiom_fixers
-import six
 
 
 def _rewrite(fixer_, code):

refex/fix/fixers/test_modern_python_fixers.py

@@ -19,6 +19,7 @@
 
 from absl.testing import absltest
 from absl.testing import parameterized
+
 from refex import search
 from refex.fix.fixers import modern_python_fixers
 

refex/fix/fixers/unittest_fixers.py

@@ -24,6 +24,7 @@
 from __future__ import division
 from __future__ import print_function
 from __future__ import unicode_literals  # for convenience
+
 from refex import future_string
 from refex.fix import fixer
 from refex.python import syntactic_template

refex/fix/test_fixer.py

@@ -18,23 +18,23 @@
 from __future__ import print_function
 from __future__ import unicode_literals  # for convenience.
 
-import re
 from unittest import mock
+import re
 
 from absl.testing import absltest
 from absl.testing import parameterized
 import attr
+
 from refex import formatting
 from refex import future_string
 from refex import search
 from refex import substitution
+from refex.fix import find_fixer
+from refex.fix import fixer
 from refex.python import syntactic_template
 from refex.python.matchers import ast_matchers
 from refex.python.matchers import syntax_matchers
 
-from refex.fix import find_fixer
-from refex.fix import fixer
-
 
 def _search_replace_fixer(search_expr, replace, message=None, url='', **kwargs):
   return fixer.SimplePythonFixer(

refex/fix/test_generate_example.py

@@ -20,6 +20,7 @@
 import ast
 
 from absl.testing import absltest
+
 from refex.fix import generate_example
 
 

refex/formatting.py

@@ -75,7 +75,6 @@
 import subprocess
 import sys
 import tempfile
-
 import typing
 from typing import Any, Iterable, Mapping, Optional, Text, Tuple
 
@@ -89,7 +88,6 @@
 from refex import parsed_file
 from refex import substitution
 
-
 _DEFAULT_STYLES = (
     colorama.Style.BRIGHT + colorama.Fore.YELLOW,
     colorama.Style.BRIGHT + colorama.Fore.BLUE,

refex/future_string.py

@@ -49,10 +49,9 @@
 
 import collections
 import string
+from typing import Any, Mapping, Text
 
 import six
-from typing import Any, Text, Mapping
-
 
 # For refex_doctest.py
 # The examples are specific to Python 2.

refex/match.py

@@ -59,10 +59,10 @@
 # from __future__ import google_type_annotations
 from __future__ import print_function
 
-import attr
-
 from typing import Any, Tuple
 
+import attr
+
 
 @attr.s(frozen=True)
 class Match(object):

refex/parsed_file.py

@@ -16,21 +16,20 @@
 ------------------------
 """
 
+# No portable raw unicode literal exists without unicode_literals.
+# see https://stackoverflow.com/questions/33027281
 from __future__ import absolute_import
 from __future__ import division
 # from __future__ import google_type_annotations
 from __future__ import print_function
-
-# No portable raw unicode literal exists without unicode_literals.
-# see https://stackoverflow.com/questions/33027281
 from __future__ import unicode_literals
 
 import re
+from typing import Iterable, Mapping, Optional, Text
 
 import asttokens
 import attr
 import cached_property
-from typing import Mapping, Optional, Iterable, Text
 
 
 @attr.s(frozen=True, eq=True, order=False)

refex/python/evaluate.py

@@ -30,19 +30,17 @@
 # from __future__ import google_type_annotations
 from __future__ import print_function
 
-
 import textwrap
 
 from refex.python import error_strings
 from refex.python import matcher
 from refex.python import matchers
 from refex.python import semiliteral_eval
-
 # Actually collect all the matchers into the matchers module, so they can be
 # enumerated.
+import refex.python.matchers.ast_matchers  # pylint: disable=unused-import
 import refex.python.matchers.base_matchers  # pylint: disable=unused-import
 import refex.python.matchers.lexical_matchers  # pylint: disable=unused-import
-import refex.python.matchers.ast_matchers  # pylint: disable=unused-import
 import refex.python.matchers.syntax_matchers  # pylint: disable=unused-import
 
 

refex/python/matcher.py

@@ -80,21 +80,22 @@
 import collections
 import contextlib
 import copy
+import enum
 import functools
 import sys
 import tokenize
+from typing import Any, Dict, Iterator, Optional, Text
 import weakref
 
 from absl import logging
 import asttokens
 import attr
 import cached_property
-import enum
-from refex import match
-from refex import parsed_file
 import six
 from six.moves import reprlib
-from typing import Any, Dict, Iterator, Text, Optional
+
+from refex import match
+from refex import parsed_file
 
 _match = match  # when `match` is shadowed, e.g. class attributes.
 

refex/python/matcher_test_util.py

@@ -18,6 +18,7 @@
 from __future__ import print_function
 
 from absl.testing import absltest
+
 from refex.python import matcher
 
 

refex/python/matchers/base_matchers.py

@@ -70,13 +70,14 @@
 from __future__ import print_function
 
 import re
+from typing import Container, List
 import weakref
 
 import attr
 import cached_property
+
 from refex import match
 from refex.python import matcher
-from typing import Container, List
 
 
 @matcher.safe_to_eval

refex/python/matchers/syntax_matchers.py

@@ -91,11 +91,12 @@
 
 import attr
 import cached_property
+import six
+
 from refex.python import matcher
 from refex.python import python_pattern
 from refex.python.matchers import ast_matchers
 from refex.python.matchers import base_matchers
-import six
 
 
 def _remap_macro_variables(pattern):

refex/python/matchers/test_ast_matchers.py

@@ -21,11 +21,12 @@
 
 from absl.testing import absltest
 from absl.testing import parameterized
+import six
+
 from refex import match
 from refex.python import matcher
 from refex.python.matchers import ast_matchers
 from refex.python.matchers import base_matchers
-import six
 
 
 def expression(e):

refex/python/matchers/test_base_matchers.py

@@ -26,11 +26,11 @@
 from absl.testing import parameterized
 
 from refex import match
+from refex.python import evaluate
 from refex.python import matcher
 from refex.python import matcher_test_util
-from refex.python.matchers import base_matchers
 from refex.python.matchers import ast_matchers
-from refex.python import evaluate
+from refex.python.matchers import base_matchers
 
 _NOTHING = base_matchers.Unless(base_matchers.Anything())
 _FAKE_CONTEXT = matcher.MatchContext(matcher.parse_ast('', 'foo.py'))

refex/python/matchers/test_lexical_matchers.py

@@ -18,6 +18,7 @@
 from __future__ import print_function
 
 from absl.testing import absltest
+
 from refex.python import matcher_test_util
 from refex.python.matchers import ast_matchers
 from refex.python.matchers import lexical_matchers

refex/python/matchers/test_syntax_matchers.py

@@ -19,21 +19,20 @@
 from __future__ import division
 from __future__ import print_function
 
+from unittest import mock
 import textwrap
 import unittest
-from unittest import mock
 
 from absl.testing import absltest
 from absl.testing import parameterized
 import six
 
 from refex.python import matcher
 from refex.python import matcher_test_util
-from refex.python.matchers import base_matchers
 from refex.python.matchers import ast_matchers
+from refex.python.matchers import base_matchers
 from refex.python.matchers import syntax_matchers
 
-
 _FAKE_CONTEXT = matcher.MatchContext(matcher.parse_ast('', 'foo.py'))