Merge pull request #683 from Mathics3/add-isort-reformatting

Add isort as a pre-commit hook and as a CI check

Author: rocky

.github/workflows/autoblack.yml …hub/workflows/isort-and-black-checks.yml.github/workflows/autoblack.yml renamed to .github/workflows/isort-and-black-checks.yml .github/workflows/autoblack.yml renamed to .github/workflows/isort-and-black-checks.yml

@@ -3,7 +3,7 @@
 # Othewrwise, Black is run and its changes are committed back to the incoming pull request.
 # https://github.com/cclauss/autoblack
 
-name: autoblack
+name: isort and black check
 on: [pull_request]
 jobs:
   build:
@@ -14,11 +14,11 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
-      - name: Install click
-        run: pip install 'click==8.0.4'
-      - name: Install Black
-        run: pip install 'black==22.3.0'
-      - name: Run black --check .
+      - name: Install click, black and isort
+        run: pip install 'click==8.0.4' 'black==22.3.0' 'isort==5.10.1'
+      - name: Run isort --check .
+        run: isort --check .
+      - name: Run isort --check .
         run: black --check .
       - name: If needed, commit black changes to the pull request
         if: failure()

.isort.cfg

@@ -0,0 +1,10 @@
+[settings]
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True
+line_length = 88
+sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,CRUNCH,LOCALFOLDER
+default_section = THIRDPARTY
+combine_as_imports = 1
+profile = black

.pre-commit-config.yaml

@@ -9,6 +9,11 @@ repos:
       stages: [commit]
     - id: end-of-file-fixer
       stages: [commit]
+-   repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        stages: [commit]
 -   repo: https://github.com/psf/black
     rev: 22.3.0
     hooks:

admin-tools/build_and_check_manifest.py

@@ -1,8 +1,9 @@
 #!/usr/bin/env python
 
-from mathics.builtin import name_is_builtin_symbol, modules, Builtin
 import sys
 
+from mathics.builtin import Builtin, modules, name_is_builtin_symbol
+
 
 def generate_available_builtins_names():
     msg = ""

admin-tools/time-mathmp-sympy-fns.py

@@ -3,9 +3,10 @@
 Program to time mpmath pi vs sympy pi
 """
 
+import math
 from timeit import timeit
+
 import mpmath
-import math
 import sympy
 
 PRECISION = 100

mathics/__init__.py

@@ -1,10 +1,11 @@
 # -*- coding: utf-8 -*-
 
-import sys
 import platform
-import sympy
+import sys
+
 import mpmath
 import numpy
+import sympy
 
 from mathics.version import __version__
 

mathics/algorithm/clusters.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 
 
-import random
-from itertools import chain, islice
 import bisect
 import math
+import random
+from itertools import chain, islice
 
 from mpmath import fsum
 

mathics/algorithm/integrators.py

@@ -2,18 +2,11 @@
 
 import numpy as np
 
-from mathics.core.number import machine_epsilon
+from mathics.core.atoms import Integer, Integer0, Number
 from mathics.core.expression import Expression
-from mathics.core.atoms import (
-    Integer,
-    Integer0,
-    Number,
-)
-
 from mathics.core.list import ListExpression
+from mathics.core.number import machine_epsilon
 from mathics.core.symbols import Symbol, SymbolPlus, SymbolSequence, SymbolTimes
-
-
 from mathics.core.systemsymbols import (
     SymbolBlank,
     SymbolComplex,

mathics/algorithm/introselect.py

@@ -164,8 +164,8 @@ def introselect(a, k):  # changes a
 
 
 if __name__ == "__main__":
-    import random
     import itertools
+    import random
 
     def test_algorithm(l, r_max, name, f):
         a = [random.randint(-r_max, r_max) for _ in range(l)]

mathics/algorithm/optimizers.py

@@ -3,31 +3,22 @@
 from typing import Optional
 
 from mathics.builtin.scoping import dynamic_scoping
-
-
 from mathics.core.atoms import (
-    String,
     Integer,
     Integer0,
-    IntegerM1,
     Integer1,
     Integer2,
     Integer3,
     Integer10,
+    IntegerM1,
     Number,
     Real,
+    String,
 )
 from mathics.core.convert.python import from_python
 from mathics.core.evaluation import Evaluation
-from mathics.eval.nevaluator import eval_N
 from mathics.core.expression import Expression
-from mathics.core.symbols import (
-    BaseElement,
-    SymbolPlus,
-    SymbolTimes,
-    SymbolTrue,
-)
-
+from mathics.core.symbols import BaseElement, SymbolPlus, SymbolTimes, SymbolTrue
 from mathics.core.systemsymbols import (
     SymbolAutomatic,
     SymbolD,
@@ -37,6 +28,7 @@
     SymbolLog,
     SymbolNone,
 )
+from mathics.eval.nevaluator import eval_N
 
 
 def find_minimum_newton1d(f, x0, x, opts, evaluation) -> (Number, bool):