style: pre-commit basic config

.github/ISSUE_TEMPLATE/other.md

@@ -6,5 +6,3 @@ labels: ''
 assignees: ''
 
 ---
-
-

.github/workflows/mypy.yml

@@ -1,11 +1,19 @@
 name: Python type check
 on: [push, pull_request]
 jobs:
-  build:
+  type:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
       - name: Lint with mypy
         run: pipx run tox -e type
+
+  pre-commit:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/action@v2.0.3

.gitignore

@@ -11,4 +11,4 @@ tags
 /dist
 /build
 docs/_build
-docs/examples
+docs/examples

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# To use:
+#
+#     pre-commit run -a
+#
+# Or:
+#
+#     pre-commit install  # (runs every time you commit in git)
+#
+# To update this file:
+#
+#     pre-commit autoupdate
+#
+# See https://github.com/pre-commit/pre-commit
+
+repos:
+# Standard hooks
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: "v4.2.0"
+  hooks:
+    - id: check-added-large-files
+    - id: check-case-conflict
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: check-toml
+    - id: check-yaml
+    - id: debug-statements
+    - id: end-of-file-fixer
+      exclude: '(^tests/.*\.lark|\.svg)$'
+    - id: mixed-line-ending
+    - id: requirements-txt-fixer
+    - id: trailing-whitespace
+      exclude: '(^tests/.*\.lark|\.svg)$'

CHANGELOG.md

@@ -10,4 +10,4 @@ v1.0
 
 - `use_accepts` in `UnexpectedInput.match_examples()` is now True by default
 
-- `v_args(meta=True)` now gives meta as the first argument. i.e. `(meta, children)`
+- `v_args(meta=True)` now gives meta as the first argument. i.e. `(meta, children)`

LICENSE

@@ -16,4 +16,3 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

README.md

@@ -105,7 +105,7 @@ Lark is great at handling ambiguity. Here is the result of parsing the phrase "f
  - Grammar composition - Import terminals and rules from other grammars
  - Standard library of terminals (strings, numbers, names, etc.)
  - Import grammars from Nearley.js ([read more](/docs/tools.md#importing-grammars-from-nearleyjs))
- - Extensive test suite [![codecov](https://codecov.io/gh/lark-parser/lark/branch/master/graph/badge.svg?token=lPxgVhCVPK)](https://codecov.io/gh/lark-parser/lark) 
+ - Extensive test suite [![codecov](https://codecov.io/gh/lark-parser/lark/branch/master/graph/badge.svg?token=lPxgVhCVPK)](https://codecov.io/gh/lark-parser/lark)
  - Type annotations (MyPy support)
  - And much more!
 
@@ -193,4 +193,3 @@ Questions about code are best asked on [gitter](https://gitter.im/lark-parser/Lo
 For anything else, I can be reached by email at erezshin at gmail com.
 
  -- [Erez](https://github.com/erezsh)
-

docs/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/sppf/sppf.html

@@ -209,4 +209,4 @@ <h2 id="transformation-to-an-abstract-syntax-tree">Transformation to an abstract
   </div>
 
 </footer>
-</body>
+</body>

docs/classes.rst

@@ -81,12 +81,12 @@ InteractiveParser
 ast_utils
 ---------
 
-For an example of using ``ast_utils``, see `/examples/advanced/create_ast.py`_ 
+For an example of using ``ast_utils``, see `/examples/advanced/create_ast.py`_
 
 .. autoclass:: lark.ast_utils.Ast
 
 .. autoclass:: lark.ast_utils.AsList
 
 .. autofunction:: lark.ast_utils.create_transformer
 
-.. _/examples/advanced/create_ast.py: examples/advanced/create_ast.html
+.. _/examples/advanced/create_ast.py: examples/advanced/create_ast.html

docs/conf.py

@@ -182,4 +182,4 @@
 sphinx_gallery_conf = {
     'examples_dirs': ['../examples'],
     'gallery_dirs': ['examples'],
-}
+}

docs/features.md

@@ -29,4 +29,3 @@
   - Visualize your parse trees as dot or png files ([see_example](https://github.com/lark-parser/lark/blob/master/examples/fruitflies.py))
   - Automatic reconstruction of input from parse-tree (see examples)
   - Use Lark grammars in Julia and Javascript.
-

docs/how_to_develop.md

@@ -63,5 +63,5 @@ pytest tests
 Another way to run the tests is using setup.py:
 
 ```bash
-python setup.py test 
+python setup.py test
 ```

docs/ide/app/app.py

@@ -80,4 +80,3 @@ def start():
 	html5.Body().appendChild(
 		App()
 	)
-

docs/ide/app/examples.py

@@ -147,4 +147,4 @@
     "favoriteFruit": "strawberry"
   }
 ]""")
-}
+}

docs/ide/app/files.json

@@ -6,4 +6,4 @@
   "ext.py",
   "ignite.py",
   "utils.py"
-]
+]

docs/ide/app/html5.py

@@ -2,5 +2,3 @@
 
 from .core import *
 from . import ext, utils, ignite
-
-

docs/philosophy.md

@@ -62,4 +62,3 @@ In short, "Premature optimization is the root of all evil."
 - Automatically resolve terminal collisions whenever possible
 
 - Automatically keep track of line & column numbers
-

docs/recipes.md

@@ -171,4 +171,4 @@ try:
     print( t.transform(tree))
 except VisitError as e:
     raise e.orig_exc
-```
+```

docs/requirements.txt

@@ -1,6 +1,6 @@
 # https://docs.readthedocs.io/en/stable/guides/specifying-dependencies.html#specifying-a-requirements-file
+pillow
+recommonmark
 sphinx-gallery
 sphinx_markdown_tables
-recommonmark
 sphinx_rtd_theme
-pillow

docs/tools.md

@@ -68,4 +68,3 @@ python -m lark.tools.nearley nearley/examples/calculator/arithmetic.ne main near
 - Lark currently cannot export grammars to Nearley
 
 These might get added in the future, if enough users ask for them.
-

docs/visitors.rst

@@ -119,4 +119,4 @@ Discard
 VisitError
 ----------
 
-.. autoclass:: lark.exceptions.VisitError
+.. autoclass:: lark.exceptions.VisitError

examples/advanced/error_handling.py

@@ -34,4 +34,3 @@ def main():
     print(res)      # prints [0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0]
 
 main()
-

examples/advanced/error_reporting_earley.py

@@ -75,5 +75,3 @@ def test():
 
 if __name__ == '__main__':
     test()
-
-

examples/advanced/error_reporting_lalr.py

@@ -75,5 +75,3 @@ def test():
 
 if __name__ == '__main__':
     test()
-
-

examples/advanced/py3to2.py

@@ -45,12 +45,12 @@ def parse_code(s):
 
 #
 # 2. Define translations using templates (each template code is parsed to a template tree)
-# 
+#
 
 pytemplate = TemplateConf(parse=parse_template)
 
 translations_3to2 = {
-    'yield from $a': 
+    'yield from $a':
 	    'for _tmp in $a: yield _tmp',
 
     'raise $e from $x':
@@ -63,7 +63,7 @@ def parse_code(s):
 
 #
 # 3. Translate and reconstruct Python 3 code into valid Python 2 code
-# 
+#
 
 python_reconstruct = PythonReconstructor(parser)
 
@@ -91,4 +91,4 @@ def test():
 	print(translate_py3to2(_TEST_CODE))
 
 if __name__ == '__main__':
-	test()
+	test()

examples/advanced/python2.lark

@@ -165,4 +165,3 @@ IMAG_NUMBER: (_INT | FLOAT) ("j"|"J")
 %ignore /\\[\t \f]*\r?\n/   // LINE_CONT
 %ignore COMMENT
 %declare _INDENT _DEDENT
-

examples/advanced/python_parser.py

@@ -76,4 +76,4 @@ def test_earley_equals_lalr():
 if __name__ == '__main__':
     test_python_lib()
     # test_earley_equals_lalr()
-    # python_parser3.parse(_read(sys.argv[1]) + '\n')
+    # python_parser3.parse(_read(sys.argv[1]) + '\n')

examples/advanced/reconstruct_python.py

@@ -83,4 +83,4 @@ def test():
 
 
 if __name__ == '__main__':
-    test()
+    test()

examples/advanced/templates.py

@@ -26,4 +26,4 @@
 parser = Lark(grammar)
 
 print(parser.parse('[1, "a", 2]'))
-print(parser.parse('{"a": 2, "b": 6}'))
+print(parser.parse('{"a": 2, "b": 6}'))

examples/composition/README.md

@@ -7,4 +7,4 @@ file format that allows both CSV and JSON to co-exist.
 We show how, by using namespaces, Lark grammars and their transformers can be fully reused -
 they don't need to care if their grammar is used directly, or being imported, or who is doing the importing.
 
-See [``main.py``](main.py) for more details.
+See [``main.py``](main.py) for more details.

examples/composition/main.py

@@ -48,4 +48,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()

examples/composition/storage.lark

@@ -6,4 +6,3 @@ start: (csv__start | json__start _NL?)+
 %import .json.start -> json__start
 
 %import .csv._NL -> _NL
-

examples/grammars/README.md

@@ -2,4 +2,4 @@
 
 This directory is a collection of lark grammars, taken from real world projects.
 
-- [Verilog](verilog.lark) - Taken from https://github.com/circuitgraph/circuitgraph/blob/master/circuitgraph/parsing/verilog.lark
+- [Verilog](verilog.lark) - Taken from https://github.com/circuitgraph/circuitgraph/blob/master/circuitgraph/parsing/verilog.lark

examples/grammars/verilog.lark

@@ -3,17 +3,17 @@
 
 // 1. Source Text
 start: description*
-    
+
 ?description: module
-    
+
 module: "module" name_of_module list_of_ports? ";" module_item* "endmodule"
 
 ?name_of_module: IDENTIFIER
 
 list_of_ports: "(" port ("," port)* ")"
 
 ?port: IDENTIFIER
-    
+
 ?module_item: input_declaration
             | output_declaration
             | net_declaration

examples/indented_tree.py

@@ -52,4 +52,3 @@ def test():
 
 if __name__ == '__main__':
     test()
-

examples/standalone/README.md

@@ -17,4 +17,3 @@ Then run using:
 ```bash
 python json_parser_main.py <path-to.json>
 ```
-

examples/standalone/json_parser_main.py

@@ -34,4 +34,3 @@ def string(self, s):
 if __name__ == '__main__':
     with open(sys.argv[1]) as f:
         print(parser.parse(f.read()))
-

examples/tests/no_newline_at_end.lark

@@ -1 +1 @@
-start: "a"
+start: "a"

lark/__pyinstaller/__init__.py

@@ -3,4 +3,4 @@
 import os
 
 def get_hook_dirs():
-    return [os.path.dirname(__file__)]
+    return [os.path.dirname(__file__)]

lark/ast_utils.py

@@ -44,7 +44,7 @@ def create_transformer(ast_module: types.ModuleType,
     Parameters:
         ast_module: A Python module containing all the subclasses of ``ast_utils.Ast``
         transformer (Optional[Transformer]): An initial transformer. Its attributes may be overwritten.
-        decorator_factory (Callable): An optional callable accepting two booleans, inline, and meta, 
+        decorator_factory (Callable): An optional callable accepting two booleans, inline, and meta,
             and returning a decorator for the methods of ``transformer``. (default: ``v_args``).
     """
     t = transformer or Transformer()

lark/exceptions.py

@@ -72,7 +72,7 @@ def get_context(self, text: str, span: int=40) -> str:
             after = text[pos:end].split(b'\n', 1)[0]
             return (before + after + b'\n' + b' ' * len(before.expandtabs()) + b'^\n').decode("ascii", "backslashreplace")
 
-    def match_examples(self, parse_fn: 'Callable[[str], Tree]', 
+    def match_examples(self, parse_fn: 'Callable[[str], Tree]',
                              examples: Union[Mapping[T, Iterable[str]], Iterable[Tuple[T, Iterable[str]]]],
                              token_type_match_fallback: bool=False,
                              use_accepts: bool=True
@@ -168,7 +168,7 @@ def __str__(self):
 
 
 class UnexpectedCharacters(LexError, UnexpectedInput):
-    """An exception that is raised by the lexer, when it cannot match the next 
+    """An exception that is raised by the lexer, when it cannot match the next
     string of characters to any of its terminals.
     """
 
@@ -229,7 +229,7 @@ class UnexpectedToken(ParseError, UnexpectedInput):
 
     def __init__(self, token, expected, considered_rules=None, state=None, interactive_parser=None, terminals_by_name=None, token_history=None):
         super(UnexpectedToken, self).__init__()
-        
+
         # TODO considered_rules and expected can be figured out using state
         self.line = getattr(token, 'line', '?')
         self.column = getattr(token, 'column', '?')