textparser 0.23.0__tar.gz → 0.26__tar.gz

textparser-0.26/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: eerimoq

textparser-0.26/.github/workflows/pythonpackage.yml

@@ -0,0 +1,58 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ['3.10', '3.14']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install textparser development and testing dependencies
+      run: |
+        pip install --upgrade pip
+        pip install .
+        pip install .[test]
+    - name: Test
+      run: |
+        python -m unittest
+    - name: Static type checking (mypy)
+      run: |
+        python -m mypy --strict textparser tests
+    - name: Linting (ruff)
+      run: |
+        ruff check textparser tests
+
+  release:
+    needs: [test]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags')
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Set up Python 3.14
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.14
+    - name: Install pypa/build
+      run: |
+        python -m pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: |
+        git clean -dfx
+        python -m build --sdist --wheel --outdir dist/ .
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        skip_existing: true
+        password: ${{ secrets.pypi_password }}

textparser-0.26/.gitignore

@@ -0,0 +1,57 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/

textparser-0.26/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: textparser
+Version: 0.26
+Summary: A text parser library for python.
+Author: Erik Moqvist
+License-Expression: MIT
+Project-URL: homepage, https://github.com/cantools/textparser
+Project-URL: documentation, https://textparser.readthedocs.io/
+Project-URL: repository, https://github.com/cantools/textparser
+Keywords: parser,parsing
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Provides-Extra: examples
+Requires-Dist: lark-parser; extra == "examples"
+Requires-Dist: pyparsing; extra == "examples"
+Requires-Dist: parsita; extra == "examples"
+Requires-Dist: funcparserlib; extra == "examples"
+Requires-Dist: parsy; extra == "examples"
+Requires-Dist: parsimonious; extra == "examples"
+Requires-Dist: textx; extra == "examples"
+Provides-Extra: test
+Requires-Dist: mypy>=2.1; extra == "test"
+Requires-Dist: ruff>=0.15.16; extra == "test"
+Requires-Dist: pytest>=9.0; extra == "test"
+Requires-Dist: coverage>=7.14; extra == "test"
+Dynamic: license-file
+
+About
+=====
+
+A text parser written in the Python language.
+
+The project has one goal, speed! See the benchmark below more details.
+
+Project homepage: https://github.com/eerimoq/textparser
+
+Documentation: http://textparser.readthedocs.org/en/latest
+
+Credits
+=======
+
+- Thanks `PyParsing`_ for a user friendly interface. Many of
+  ``textparser``'s class names are taken from this project.
+
+Installation
+============
+
+.. code-block:: python
+
+    pip install textparser
+
+Example usage
+=============
+
+The `Hello World`_ example parses the string ``Hello, World!`` and
+outputs its parse tree ``['Hello', ',', 'World', '!']``.
+
+The script:
+
+.. code-block:: python
+
+   import textparser
+   from textparser import Sequence
+
+
+   class Parser(textparser.Parser):
+
+       def token_specs(self):
+           return [
+               ('SKIP',          r'[ \r\n\t]+'),
+               ('WORD',          r'\w+'),
+               ('EMARK',    '!', r'!'),
+               ('COMMA',    ',', r','),
+               ('MISMATCH',      r'.')
+           ]
+
+       def grammar(self):
+           return Sequence('WORD', ',', 'WORD', '!')
+
+
+   tree = Parser().parse('Hello, World!')
+
+   print('Tree:', tree)
+
+Script execution:
+
+.. code-block:: text
+
+   $ env PYTHONPATH=. python3 examples/hello_world.py
+   Tree: ['Hello', ',', 'World', '!']
+
+Benchmark
+=========
+
+A `benchmark`_ comparing the speed of 10 JSON parsers, parsing a `276
+kb file`_.
+
+.. code-block:: text
+
+   $ env PYTHONPATH=. python3 examples/benchmarks/json/speed.py
+
+   Parsed 'examples/benchmarks/json/data.json' 1 time(s) in:
+
+   PACKAGE         SECONDS   RATIO  VERSION
+   textparser         0.10    100%  0.21.1
+   parsimonious       0.17    169%  unknown
+   lark (LALR)        0.27    267%  0.7.0
+   funcparserlib      0.34    340%  unknown
+   textx              0.54    546%  1.8.0
+   pyparsing          0.68    684%  2.4.0
+   pyleri             0.88    886%  1.2.2
+   parsy              0.92    925%  1.2.0
+   parsita            2.28   2286%  unknown
+   lark (Earley)      2.34   2348%  0.7.0
+
+*NOTE 1: The parsers are not necessarily optimized for
+speed. Optimizing them will likely affect the measurements.*
+
+*NOTE 2: The structure of the resulting parse trees varies and
+additional processing may be required to make them fit the user
+application.*
+
+*NOTE 3: Only JSON parsers are compared. Parsing other languages may
+give vastly different results.*
+
+Contributing
+============
+
+#. Fork the repository.
+
+#. Implement the new feature or bug fix.
+
+#. Implement test case(s) to ensure that future changes do not break
+   legacy.
+
+#. Run the tests.
+
+   .. code-block:: text
+
+      python3 -m unittest
+
+#. Create a pull request.
+
+.. _PyParsing: https://github.com/pyparsing/pyparsing
+.. _Hello World: https://github.com/eerimoq/textparser/blob/master/examples/hello_world.py
+.. _benchmark: https://github.com/eerimoq/textparser/blob/master/examples/benchmarks/json/speed.py
+.. _276 kb file: https://github.com/eerimoq/textparser/blob/master/examples/benchmarks/json/data.json

{textparser-0.23.0 → textparser-0.26}/README.rst

@@ -1,6 +1,3 @@
-|buildstatus|_
-|coverage|_
-
 About
 =====
 
@@ -104,12 +101,6 @@ Contributing
 
 #. Fork the repository.
 
-#. Install prerequisites.
-
-   .. code-block:: text
-
-      pip install -r requirements.txt
-
 #. Implement the new feature or bug fix.
 
 #. Implement test case(s) to ensure that future changes do not break
@@ -119,16 +110,10 @@ Contributing
 
    .. code-block:: text
 
-      make test
+      python3 -m unittest
 
 #. Create a pull request.
 
-.. |buildstatus| image:: https://travis-ci.org/eerimoq/textparser.svg?branch=master
-.. _buildstatus: https://travis-ci.org/eerimoq/textparser
-
-.. |coverage| image:: https://coveralls.io/repos/github/eerimoq/textparser/badge.svg?branch=master
-.. _coverage: https://coveralls.io/github/eerimoq/textparser
-
 .. _PyParsing: https://github.com/pyparsing/pyparsing
 .. _Hello World: https://github.com/eerimoq/textparser/blob/master/examples/hello_world.py
 .. _benchmark: https://github.com/eerimoq/textparser/blob/master/examples/benchmarks/json/speed.py

textparser-0.26/docs/Makefile

@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/textparser.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/textparser.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/textparser"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/textparser"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."