Merge pull request #5 from Mathics3/project-administion

The usual sanity checking stuff

Author: rocky

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = tab
+indent_size = 4
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace: true

.github/workflows/autoblack.yml

@@ -0,0 +1,32 @@
+# GitHub Action that uses Black to reformat the Python code in an incoming pull request.
+# If all Python code in the pull request is compliant with Black then this Action does nothing.
+# Othewrwise, Black is run and its changes are committed back to the incoming pull request.
+# https://github.com/cclauss/autoblack
+
+name: autoblack
+on: [pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.9
+        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 .
+        run: black --check .
+      - name: If needed, commit black changes to the pull request
+        if: failure()
+        run: |
+          black .
+          git config --global user.name 'autoblack'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
+          git checkout $GITHUB_HEAD_REF
+          git commit -am "fixup: Format Python code with Black"
+          git push

.gitignore

@@ -4,4 +4,5 @@
 /build
 /dist
 /pymathics_natlang.egg-info
+/tmp
 __pycache__

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+default_language_version:
+  python: python
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+    - id: check-merge-conflict
+    - id: debug-statements
+      stages: [commit]
+    - id: end-of-file-fixer
+      stages: [commit]
+    - id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    - id: black
+      language_version: python3
+      exclude: 'mathicsscript/version.py'
+-   repo: https://github.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        stages: [commit]

pymathics/natlang/__main__.py

@@ -389,9 +389,7 @@ def apply_n(self, text, n, evaluation, options):
         doc = self._nlp(text.value, evaluation, options)
         if doc:
             return ListExpression(
-                itertools.islice(
-                    (String(sent.text) for sent in doc.sents), n.value
-                ),
+                itertools.islice((String(sent.text) for sent in doc.sents), n.value),
             )
 
 
@@ -974,9 +972,7 @@ def apply(self, word, evaluation, options):
             evaluation, self._language_name(evaluation, options)
         )
         if wordnet:
-            senses = self._senses(
-                word.value.lower(), wordnet, language_code
-            )
+            senses = self._senses(word.value.lower(), wordnet, language_code)
             if senses:
                 return ListExpression([String(syn.definition()) for syn, _ in senses])
             else:
@@ -1284,9 +1280,7 @@ def apply(self, word, evaluation, options):
             evaluation, self._language_name(evaluation, options)
         )
         if wordnet:
-            if list(
-                wordnet.synsets(word.value.lower(), None, language_code)
-            ):
+            if list(wordnet.synsets(word.value.lower(), None, language_code)):
                 return SymbolTrue
             else:
                 return SymbolFalse
@@ -1512,9 +1506,7 @@ def apply(self, word, evaluation, options):
         language_name = self.get_option(options, "Language", evaluation)
         if not isinstance(language_name, String):
             return
-        language_code = SpellingCorrectionList._languages.get(
-            language_name.value, None
-        )
+        language_code = SpellingCorrectionList._languages.get(language_name.value, None)
         if not language_code:
             return evaluation.message("SpellingCorrectionList", "lang", language_name)
 

pymathics/natlang/version.py

@@ -4,4 +4,5 @@
 # This file is suitable for sourcing inside POSIX shell as
 # well as importing into Python. That's why there is no
 # space around "=" below.
+# fmt: off
 __version__="5.0.0.dev0"

test/helper.py

@@ -2,6 +2,7 @@
 
 session = MathicsSession(add_builtin=True, catch_interrupt=False)
 
+
 def check_evaluation(str_expr: str, str_expected: str, message=""):
     """Helper function to test that a WL expression against
     its results"""

test/test_natlang.py

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 from .helper import session, check_evaluation
 
+
 def test_natlang():
 
     session.evaluate(
         """
         LoadModule["pymathics.natlang"]
         """
-        )
+    )
 
     for str_expr, str_expected, message in (
         (