summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* 226 railroad updates (#298)Paul McGuire2021-09-082-5/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add line separators to HowToUsePyparsing.rst to call attention to PEP-8 naming in this document * Update railroad diagram generation code, to show results names as group annotations, and break out all expressions with a name set using setName. * Revert dataclasses back to NamedTuples for 3.6-7 compat; add setName calls in simpleBool.py; add simpleBool to make_diagram.py * Remove default setName calls on delimitedList * Add setName calls to simpleSQL for better diagram * Remove hard-coded debug mode * Move setName on delimitedList into test code * Restore default setName() calls for delimitedList; set default vertical=3; update jsonParser.py and simpleSQL.py with better setName() calls (and update test_diagram.py accordingly); update test_diagram.py to move asserts after tempfiles are written, moved tempfiles to local dir instead of hard-to-find temp dir * Get proper railroad diags for infixNotation * Undo forced railroad_debug * Code cleanup from PR comments * Remove hard-coded base_expr name from infix_notation * Add special EachItem to compose DiagramItem for Group-OneOrMore-Choice; refactored tests to move duplicated code to function; added names to mozillaCalendarParser.py for better diagram * Make sure root element gets in the diagram, even if it has no custom name * Update tests to reflect diagram structure changes * Add LOOKAHEAD and LOOKBEHIND annotations for FollowedBy and PrecededBy elements, and changed the annotation on Each to [ALL]; renamed _first to _element_diagram_states; add expr.streamline() in create_diagram() to collapse nested exprs; added railroad_diagram_demo.py example general blackening; update CHANGES with latest enhancements; bump version date * Fix pip command * Update CHANGES and whats_new_in_3_0_0.rst with some features and acknowledgements * Updates from PR review: change user instructions to use pyparsing[diagrams]; consistent annotations for NotAny along with FollowedBy and PrecededBy; fixed up comments and type annotations * Remove unneeded pip installs for tox (already handled in tox.ini) * Refactor duplicate code into decorator; drop unused group_results_name argument * Add diagram handling for SkipTo, and for And's constructed using `expr*N` notation (use a OneOrMore diagram with a repeat count instead of a sequence of N exprs) * Fix parsing ambiguity in railroad_diagram_demo.py so that parser can actually parse a valid input string
* Docs cleanupptmcg2021-09-022-120/+151
|
* Update docs to use new-style snake_case names, add some missing blurbs to ↵ptmcg2021-09-021-6/+15
| | | | whats_new_in_3_0_0.rst, and reformat CloseMatch change blurb in CHANGES
* Add note about names and using 3.0 docs for 2.4.7 environments.ptmcg2021-09-021-4/+11
|
* Add identchars and identbodychars symbols to make it easier to construct ↵ptmcg2021-08-191-0/+22
| | | | identifiers
* Add note on enable/disable memoization methods in whats_new_in_3_0_0.rstptmcg2021-08-141-0/+13
|
* Add support for Suppress(...) to suppress the skipped textptmcg2021-08-121-8/+34
|
* Fix old method names in comparison (#295)Daniel Roseman2021-08-121-2/+2
| | | Looks like these got over-zealously corrected to the new versions.
* Sweep code for usage of Optional -> Opt; sweep HowToUsePyparsing.rst for ↵ptmcg2021-08-081-90/+80
| | | | legacy names
* Update docs to include `delimited_list` added argument `allow_trailing_delim`Paul McGuire2021-08-071-1/+8
|
* Added PEP-8 notes to the whats_new_in_3_0_0.rst docPaul McGuire2021-08-071-1/+113
|
* Add PEP-8 naming, with compatibility synonymsptmcg2021-08-071-105/+132
|
* Update 2020 dates to 2021, fix TravisCI badge in README.rst to use ↵ptmcg2021-08-012-2/+2
| | | | travis-ci.com instead of .org
* Rename enable_left_recursion to enableLeftRecursion for consistency with ↵ptmcg2021-08-011-0/+33
| | | | other pyparsing names (left in enable_left_recursion synonym as omen of names to come); added notes to CHANGES and whats_new_in_3_0_0.rst; added left_recursion.py to examples.
* Remove old language stating that parseString returns "a list of matched ↵ptmcg2021-05-141-3/+33
| | | | strings", and clarify use of the returned ParseResults
* Fix misc. documentation typos (#280)luzpaz2021-05-142-3/+3
| | | Found via `codespell -q 3 -L ba,fourty,halp,inout,strng`
* Update whats_new_in_3_0_0.rst (#258)retsyo2021-01-031-1/+2
| | | since `pip install railroad` install anthor package, I think it is better to point out the corrected one.
* Deprecate `locatedExpr` in favor of new `Located` classptmcg2020-12-241-1/+39
|
* Add IndentedBlock class; made vertical keyword arg more visible when ↵pyparsing_3.0.0b1ptmcg2020-11-021-7/+67
| | | | creating railroad diags; changed create_diagram from monkeypatch to included method on ParserElement; better debug exception if Dict is constructed with non-Group expression
* Updated HowToUsePyparsing.rst and whats_new_in_3_0_0.rst docsPaul McGuire2020-10-112-28/+25
|
* Convert SyntaxWarnings to ValueError and TypeError exceptions; change ↵Paul McGuire2020-08-191-2/+13
| | | | diagnostics to an enum, and add enable_diag(), disable_diag() and enable_all_warnings() methods; clean up pyparsing imports in test_unit.py
* Second markup cleanup passPaul McGuire2020-08-191-6/+6
|
* Update HowToUsePyparsing.rst to include diagnostics, and general markup cleanupPaul McGuire2020-08-191-49/+103
|
* The metod getTokensEndLoc no longer exists (#228)Juan VM2020-07-081-3/+0
| | | The metod getTokensEndLoc no longer exists
* Sphinx and docstring fixesptmcg2020-07-061-1/+1
|
* Sphinx config cleanupptmcg2020-06-252-3/+3
|
* Collapse _checkRecursion methods; moved 3.0.0 summary from CHANGES to ↵ptmcg2020-06-252-0/+303
| | | | whats_new_in_3_0_0.rst; cleaned up docstrings, Word() examples, restored setName() docstring; added example to ParseException.explain()
* Diagram improvements IV (#225)Michael Milton2020-06-243-232/+504
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add diagram documentation, add more diagram tests, allow more customization of diagrams * Remove accidental edit of unrelated documentation * Add diagram package * Add jinja file to manifest * Add to bdist also * package_data * Railroad improvements * Partial rewrite * Update * Use partials everywhere so we can edit the tree before it's constructed * Rewrite the diagram generator to not duplicate any content; use monospaced font for titles * Small documentation change * Revert back to Python 3.5 type hints, fix a small bug * More diagram fixes * Even more pruning; update docs to use SQL example * Don't check the string value of names now that we don't have to
* Railroad Diagram Improvements (#220)Michael Milton2020-06-032-0/+289
| | | | | | * Add diagram documentation, add more diagram tests, allow more customization of diagrams * Remove accidental edit of unrelated documentation
* Update HowTo doc, address comments in #213Paul McGuire2020-05-281-21/+93
|
* Blacken the project (#141)Jon Dufresne2019-10-311-25/+31
|
* Use pyupgrade to upgrade the code to use Python3 conventions (#138)Jon Dufresne2019-10-241-1/+0
| | | | | | | | | | | | The pyupgrade project is available at https://github.com/asottile/pyupgrade and can be installed through pip. The pyupgrade tool automatically upgrades syntax for newer versions of the language. As pyparsing is now Python 3 only, can apply some cleanups and simplifications. Ran the tool using the following command: $ find . -name \*.py -exec pyupgrade --py3-plus {} \; For now, pyparsing.py was skipped while it is refactored to a package.
* 3.x-ify some print statements and an except (#114)kms708472019-08-131-5/+5
| | | Thanks, and nice catch on the except statement too!
* Typo and whitespace cleanupPaul McGuire2019-08-031-1/+1
|
* Updates to prep for 2.4.2 releasePaul McGuire2019-07-281-53/+52
|
* Add unit test for #103; also make CHANGES blurb and HowToUse notes a little ↵pyparsing_2.4.2a1pyparsing_2.4.1.1Paul McGuire2019-07-241-2/+2
| | | | clearer
* Version 2.4.2a1 - changing [...] notation to ZeroOrMore, not OneOrMorePaul McGuire2019-07-231-975/+974
|
* Use HTTPS URLs where available in docs, examples, and commentsJon Dufresne2018-12-251-1/+1
|
* Remove mentions of 'psyco' from docs and examplesJon Dufresne2018-12-241-12/+2
| | | | | | | | | | | | | | | The psyco package has been declared umaintained and dead. It is no longer receiving bug fixes including for security issues. From http://psyco.sourceforge.net/ > 12 March 2012 > > Psyco is unmaintained and dead. Please look at PyPy for the > state-of-the-art in JIT compilers for Python. Avoid recommending the use of an unmaintained package (since 2012). Users can continue to use PyPy for the latest and greatest in Python JIT.
* Trim trailing white space throughout the projectJon Dufresne2018-12-221-187/+187
| | | | | | Many editors clean up trailing white space on save. By removing it all in one go, it helps keep future diffs cleaner by avoiding spurious white space changes on unrelated lines.
* Minor update to module welcome; add version to generated docsptmcg2018-11-221-0/+1
|
* Not sure how I managed to screw up building documentation again.Matěj Cepl2018-11-212-3/+3
|
* Forgot to remove docs/conf_old.pyMatěj Cepl2018-11-201-159/+0
|
* Initial conversion to Sphinx generated documentation.Matěj Cepl2018-11-2010-0/+1383
There are still many bugs in the documentation strings, but at least genration of documentaiton works.