diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..49f64d0 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +stringdatadeque/_version.py export-subst diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..718572b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +version: 2 + +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/black.yaml b/.github/workflows/black.yaml new file mode 100644 index 0000000..adc6081 --- /dev/null +++ b/.github/workflows/black.yaml @@ -0,0 +1,24 @@ +name: Black Formatting + +"on": + push: + pull_request: + +jobs: + black: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Formatting + run: just ruff_format_fixes diff --git a/.github/workflows/dapperdata.yaml b/.github/workflows/dapperdata.yaml new file mode 100644 index 0000000..f8c2a7f --- /dev/null +++ b/.github/workflows/dapperdata.yaml @@ -0,0 +1,24 @@ +name: Configuration File Formatting + +"on": + push: + pull_request: + +jobs: + dapperdata: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Formatting + run: just dapperdata_check diff --git a/.github/workflows/gh_pages.yaml b/.github/workflows/gh_pages.yaml new file mode 100644 index 0000000..1a755b2 --- /dev/null +++ b/.github/workflows/gh_pages.yaml @@ -0,0 +1,18 @@ +name: Deploy Sphinx documentation to Pages + +"on": + push: + branches: [master] # branch to trigger deployment + +jobs: + pages: + runs-on: ubuntu-20.04 + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + pages: write + id-token: write + steps: + - id: deployment + uses: sphinx-notes/pages@v3 diff --git a/.github/workflows/mypy.yaml b/.github/workflows/mypy.yaml new file mode 100644 index 0000000..a2ed158 --- /dev/null +++ b/.github/workflows/mypy.yaml @@ -0,0 +1,24 @@ +name: Mypy testing + +"on": + push: + pull_request: + +jobs: + mypy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Typing + run: just mypy diff --git a/.github/workflows/pip-audit.yaml b/.github/workflows/pip-audit.yaml new file mode 100644 index 0000000..4c9bfb2 --- /dev/null +++ b/.github/workflows/pip-audit.yaml @@ -0,0 +1,23 @@ +name: Pip-Audit + +"on": + push: + pull_request: + +jobs: + selftest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - uses: pypa/gh-action-pip-audit@v1.0.8 diff --git a/.github/workflows/pypi.yaml b/.github/workflows/pypi.yaml new file mode 100644 index 0000000..0332979 --- /dev/null +++ b/.github/workflows/pypi.yaml @@ -0,0 +1,93 @@ +name: Publish Python distribution to PyPI and TestPyPI + +"on": push + +jobs: + build: + name: Build distribution + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + - name: Install pypa/build + run: >- + python3 -m + pip install + build + --user + - name: Build a binary wheel and a source tarball + run: python3 -m build + - name: Store the distribution packages + uses: actions/upload-artifact@v4 + with: + name: python-package-distributions + path: dist/ + + publish-to-pypi: + name: >- + Publish Python distribution to PyPI + if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes + needs: + - build + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/project/Verbex/ # Replace with your PyPI project name + permissions: + id-token: write # IMPORTANT: mandatory for trusted publishing + + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Publish distribution to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + + github-release: + name: >- + Sign the Python distribution with Sigstore + and upload them to GitHub Release + needs: + - publish-to-pypi + runs-on: ubuntu-latest + + permissions: + contents: write # IMPORTANT: mandatory for making GitHub Releases + id-token: write # IMPORTANT: mandatory for sigstore + + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@v2.1.1 + with: + inputs: >- + ./dist/*.tar.gz + ./dist/*.whl + - name: Create GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + run: >- + gh release create + '${{ github.ref_name }}' + --repo '${{ github.repository }}' + --notes "" + - name: Upload artifact signatures to GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + # Upload to GitHub Release using the `gh` CLI. + # `dist/` contains the built packages, and the + # sigstore-produced signatures and certificates. + run: >- + gh release upload + '${{ github.ref_name }}' dist/** + --repo '${{ github.repository }}' diff --git a/.github/workflows/pytest.yaml b/.github/workflows/pytest.yaml new file mode 100644 index 0000000..fc12c26 --- /dev/null +++ b/.github/workflows/pytest.yaml @@ -0,0 +1,27 @@ +name: PyTest + +"on": + push: + pull_request: + +env: + COLUMNS: 120 + +jobs: + pytest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Run Tests + run: just pytest diff --git a/.github/workflows/ruff.yaml b/.github/workflows/ruff.yaml new file mode 100644 index 0000000..72009ea --- /dev/null +++ b/.github/workflows/ruff.yaml @@ -0,0 +1,24 @@ +name: Ruff Linting + +"on": + push: + pull_request: + +jobs: + black: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Formatting + run: just ruff_check diff --git a/.github/workflows/tomlsort.yaml b/.github/workflows/tomlsort.yaml new file mode 100644 index 0000000..bf63104 --- /dev/null +++ b/.github/workflows/tomlsort.yaml @@ -0,0 +1,27 @@ +name: TOML Formatting + +"on": + push: + pull_request: + +jobs: + tomlsort: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Install toml-sort + run: pip install toml-sort + + - name: Test Typing + run: just tomlsort_check diff --git a/.github/workflows/tox.yaml b/.github/workflows/tox.yaml new file mode 100644 index 0000000..c33f979 --- /dev/null +++ b/.github/workflows/tox.yaml @@ -0,0 +1,30 @@ +name: TOX testing + +"on": + push: + pull_request: + +jobs: + tox: + runs-on: ubuntu-latest + env: + TOX_PARALLEL_NO_SPINNER: 1 # Removes logging spam + steps: + - name: Checkout and setup Pythons + uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.10' + cache: 'pip' + - uses: actions/setup-python@v5 + with: + python-version: '3.11' + cache: 'pip' + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + cache: 'pip' + - name: Install tox and run tests + run: | + pip install tox + tox --parallel diff --git a/.gitignore b/.gitignore index 8904a1f..1b3a25f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,161 @@ -venv -dist -build -*.py[co] -*.egg-info +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST +*.bak + +# 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/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +#.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +Pipfile.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ +.vscode + +#cprofiler +*.prof + +#taskfile +task diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 877d718..71c0181 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,7 +1,158 @@ +minimum_pre_commit_version: 1.21.0 repos: -- repo: https://github.com/ambv/black - rev: stable + - repo: meta hooks: - - id: black - args: [--line-length=79] - language_version: python3.6 +# - id: check-hooks-apply + - id: check-useless-excludes + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-ast + - id: check-json + - id: check-toml + - id: check-yaml + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: trailing-whitespace + types: [file, text] + exclude_types: [html, javascript] + - id: end-of-file-fixer + types: [file, text] + exclude_types: [html, javascript] + - id: check-case-conflict + - id: mixed-line-ending + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-merge-conflict + name: "Check for merge conflicts" + - id: check-yaml + name: "Yaml: Check files" + types: [file, yaml] + - id: check-toml + name: "TOML: check toml syntax" + types: [file, toml] + - repo: https://github.com/python-jsonschema/check-jsonschema + rev: 0.28.2 + hooks: + - id: check-github-workflows + - repo: https://github.com/adrienverge/yamllint.git + rev: v1.35.1 # or higher tag + hooks: + - id: yamllint + name: "Yaml: Linting files" + args: [--format, parsable, --strict] + types: [file, yaml] + - repo: https://github.com/Lucas-C/pre-commit-hooks + rev: v1.5.5 + hooks: + - id: remove-tabs + name: "Python: Convert Tabs to 4 spaces" + args: ['--whitespaces-count', '4'] # defaults to: 4 + types: [file, python] + - repo: https://github.com/asottile/pyupgrade + rev: v3.15.2 + hooks: + - id: pyupgrade + name: "Python: upgrade syntax" + args: [--py310-plus] + - repo: https://github.com/hadialqattan/pycln + rev: v2.4.0 + hooks: + - id: pycln + name: "Python: remove unused imports." + - repo: https://github.com/rbroderi/precommithooks + rev: v1.0.2 + hooks: + - id: python_file_name_check + name: "Python: File name check" + args: ["--ignore-test-files"] + - repo: https://github.com/astral-sh/ruff-pre-commit + # Ruff version. + rev: v0.4.2 + hooks: + # Run the linter. + - id: ruff + name: "Python: Ruff" + types: [file, python] + args: [--fix] + fail_fast: true + # Run the formatter. + - id: ruff-format + name: "Python: Ruff format" + types: [file, python] + fail_fast: true + - repo: local + hooks: + - id: pylint + name: "Python: Pylint code with Perflint" + entry: python -m pylint + language: system + types: [file, python] + args: [-rn, -sn, --load-plugins=perflint] + - repo: https://github.com/asottile/add-trailing-comma + rev: v3.1.0 + hooks: + - id: add-trailing-comma + name: "Python: Add trailing comma" + types: [file, python] + - repo: https://github.com/pre-commit/mirrors-mypy + rev: 'v1.10.0' + hooks: + - id: mypy + name: "Python: Checking variable types" + args: [--ignore-missing-imports, --allow-redefinition] + exclude: "setup[.]py|conf[.]py" + additional_dependencies: + - pydantic + - types-all + - pandas-stubs + types: [file, python] + - repo: https://github.com/PyCQA/bandit + rev: '1.7.8' + hooks: + - id: bandit + name: "Python: Checking for potential security issues (bandit)" + args: + - "--skip=B404,B506,B607,B603,B701,B101,B602" + - repo: local + hooks: + - id: remove-en-dashes + name: Remove the EXTREMELY confusing unicode character U+2013 + language: system + entry: perl -pi* -e 's/\xe2\x80\x93/-/g && ($t = 1) && print STDERR $_; END{{exit $t}}' + types: [file] + types_or: [python, powershell, lua, jinja] + - repo: https://github.com/sirosen/texthooks + rev: 0.6.6 + hooks: + - id: fix-smartquotes + types: [file] + types_or: [python, powershell, lua, jinja] + - id: fix-ligatures + types: [file] + types_or: [python, powershell, lua, jinja] + - id: forbid-bidi-controls + types: [file] + types_or: [python, powershell, lua, jinja] + fail_fast: true + - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks + rev: v2.13.0 + hooks: + - id: pretty-format-java + args: [--autofix] + - id: pretty-format-golang + args: [--autofix] + - id: pretty-format-ini + args: [--autofix] + - id: pretty-format-rust + args: [--autofix] + - repo: local + hooks: + - id: fixes + name: fixes + entry: just _fixes_no_ruff + language: system + pass_filenames: false + verbose: true diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..8531a3b --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.12.2 diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index deafd0f..0000000 --- a/.travis.yml +++ /dev/null @@ -1,12 +0,0 @@ -language: python -python: - - "2.7" - - "3.5" - - "3.6" - - "3.7" - - "3.8" - - "3.9-dev" - -# command to run tests -script: python setup.py test - diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..3a46794 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,20 @@ +{ + "python.testing.unittestArgs": [ + "-v", + "-s", + "./tests", + "-p", + "test*.py" + ], + "python.testing.pytestEnabled": false, + "python.testing.unittestEnabled": true, + "cSpell.words": [ + "pylance", + "pyright", + "Verbex" + ], + "python.linting.flake8Enabled": true, + "python.linting.flake8Args": [ + "--ignore=E501" + ] +} diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..2ce5d39 --- /dev/null +++ b/.yamllint @@ -0,0 +1,9 @@ +extends: default +rules: + comments-indentation: disable + document-start: disable + new-lines: disable + line-length: disable + truthy: + level: warning + indentation: disable diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a734e49 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Contributor Code of Conduct + +This project adheres to No Code of Conduct. We are all adults. We accept anyone's contributions. Nothing else matters. + +For more information please visit the [No Code of Conduct](https://github.com/domgetter/NCoC) homepage. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..942046e --- /dev/null +++ b/LICENSE @@ -0,0 +1,699 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + + + This file incorporates work covered by the following copyright and + permission notice: + + The MIT License (MIT) + + Copyright (c) 2017 jehna + + Permission is hereby granted, free of charge, to any person obtaining a copy of + this software and associated documentation files (the "Software"), to deal in + the Software without restriction, including without limitation the rights to + use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + the Software, and to permit persons to whom the Software is furnished to do so, + subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + 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. diff --git a/README.md b/README.md index d94fbc6..dc51965 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,37 @@ -PythonVerbalExpressions -======================= +Verbex: Python verbal based regular expressions +================================================ + + + +[![Generic badge](https://img.shields.io/badge/license-GPL‐3.0-orange.svg)](https://github.com/rbroderi/Verbex/blob/master/LICENSE) +[![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/Verbex/) +[![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) +[![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) +[![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) +[![Generic badge](https://img.shields.io/badge/uv-requirements-yellow.svg)](https://github.com/astral-sh/uv) +[![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version)](https://github.com/rbroderi/Verbex/releases) -[![Build Status](https://travis-ci.org/VerbalExpressions/PythonVerbalExpressions.svg?branch=master)](https://travis-ci.org/VerbalExpressions/PythonVerbalExpressions) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) ## Installation ```bash -pip install VerbalExpressions +pip install Verbex ``` ## Usage ```python -from verbalexpressions import VerEx -verbal_expression = VerEx() +from verbex import Verbex +verbex = Verbex() ``` + +## Documentation +[API](https://rbroderi.github.io/Verbex/) ## Examples ### Testing if we have a valid URL ```python # Create an example of how to test for correctly formed URLs -verbal_expression = VerEx() -tester = (verbal_expression. +verbex = Verbex() +tester = (verbex. start_of_line(). find('http'). maybe('s'). @@ -33,11 +45,11 @@ tester = (verbal_expression. test_url = "https://www.google.com" # Test if the URL is valid -if tester.match(test_url): - print "Valid URL" +if re.match(test_url.regex,test_url): + print("Valid URL") # Print the generated regex -print tester.source() # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ +print(tester) # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ ``` ### Replacing strings ```python @@ -45,28 +57,18 @@ print tester.source() # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ replace_me = "Replace bird with a duck" # Create an expression that looks for the word "bird" -expression = VerEx().find('bird') - -# Execute the expression in VerEx -result_VerEx = expression.replace(replace_me, 'duck') -print result_VerEx +expression = Verbex().find('bird') -# Or we can compile and use the regular expression using re +# Compile and use the regular expression using re import re regexp = expression.compile() result_re = regexp.sub('duck', replace_me) -print result_re -``` -### Shorthand for string replace -```python -result = VerEx().find('red').replace('We have a red house', 'blue') -print result +print(result_re) ``` ## Developer setup : running the tests ```bash -python setup.py develop -python setup.py test +just tests ``` -## Other implementations +## Other implementations You can view all implementations on [VerbalExpressions.github.io](http://VerbalExpressions.github.io) diff --git a/archive/archive-20220508115341-c1a945c08ab1170c.tar.gz b/archive/archive-20220508115341-c1a945c08ab1170c.tar.gz new file mode 100644 index 0000000..2767ac9 Binary files /dev/null and b/archive/archive-20220508115341-c1a945c08ab1170c.tar.gz differ diff --git a/archive/archive-20220508115432-8f4db45c4efcdff6.tar.gz b/archive/archive-20220508115432-8f4db45c4efcdff6.tar.gz new file mode 100644 index 0000000..e1e7f93 Binary files /dev/null and b/archive/archive-20220508115432-8f4db45c4efcdff6.tar.gz differ diff --git a/archive/archive-20220508115930-3a2864bd92a8e920.tar.gz b/archive/archive-20220508115930-3a2864bd92a8e920.tar.gz new file mode 100644 index 0000000..b60bea7 Binary files /dev/null and b/archive/archive-20220508115930-3a2864bd92a8e920.tar.gz differ diff --git a/dist/Verbex-1.0.2.win-amd64.zip b/dist/Verbex-1.0.2.win-amd64.zip new file mode 100644 index 0000000..f7a2609 Binary files /dev/null and b/dist/Verbex-1.0.2.win-amd64.zip differ diff --git a/dist/Verbex-1.0.3.win-amd64.zip b/dist/Verbex-1.0.3.win-amd64.zip new file mode 100644 index 0000000..f074f34 Binary files /dev/null and b/dist/Verbex-1.0.3.win-amd64.zip differ diff --git a/dist/Verbex-1.1.0.win-amd64.zip b/dist/Verbex-1.1.0.win-amd64.zip new file mode 100644 index 0000000..374059f Binary files /dev/null and b/dist/Verbex-1.1.0.win-amd64.zip differ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# 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) diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 0000000..c3defb4 --- /dev/null +++ b/docs/_static/css/custom.css @@ -0,0 +1,9 @@ +@import 'theme.css'; + +.toctree-l4 { + font-size: 1.2em !important +} + +.toctree-l4>a { + padding: 0em 1.618em 0em 5.663em !important +} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..da968d7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,32 @@ +# type:ignore # noqa: PGH003, INP001 +"""Configuration file for the Sphinx documentation builder. + +For the full list of built-in configuration values, see the documentation: +https://www.sphinx-doc.org/en/master/usage/configuration.html + +-- Project information ----------------------------------------------------- +https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information +""" + +import os +import sys + +from sphinx_pyproject import SphinxConfig + +sys.path.insert(0, os.path.abspath("../src")) # noqa: PTH100 +config = SphinxConfig("../pyproject.toml", globalns=globals()) + + +# def setup(app) -> None: +# """Set up the Sphinx application. + +# Args: +# ---- +# app: The Sphinx application object. + +# Returns: +# ------- +# None + +# """ +# app.add_css_file("source/custom.css") diff --git a/docs/getting-started.rst b/docs/getting-started.rst new file mode 100644 index 0000000..0cc088c --- /dev/null +++ b/docs/getting-started.rst @@ -0,0 +1,6 @@ +Getting started +=============== + +This is where you describe how to get set up on a clean install, including the +commands necessary to get the raw data (using the `sync_data_from_s3` command, +for example), and then how to make the cleaned, final data sets. diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2451d8d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,23 @@ +.. StringDataDeque documentation master file, created by + sphinx-quickstart on Sun Mar 24 15:35:24 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Verbex's documentation! +=========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + getting-started + source/modules + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..4415b88 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +Verbex +=============== + +.. toctree:: + :maxdepth: 4 + + verbex diff --git a/docs/source/verbex.rst b/docs/source/verbex.rst new file mode 100644 index 0000000..bb97781 --- /dev/null +++ b/docs/source/verbex.rst @@ -0,0 +1,13 @@ +verbex package +======================= + +Submodules +---------- + +verbex module +------------------------------------------- + +.. automodule:: verbex + :members: + :undoc-members: + :show-inheritance: diff --git a/justfile b/justfile new file mode 100644 index 0000000..3d29723 --- /dev/null +++ b/justfile @@ -0,0 +1,143 @@ +set ignore-comments +PACKAGE_SLUG := "src/verbex" +export PYTHON_VERSION := if env("CI","false") != "false" { `python --version|cut -d" " -f2` } else { `cat .python-version` } +PYTHON := if env("USE_SYSTEM_PYTHON", "false") != "false" { "python" } else { ".venv/bin/python" } +PYTHON_ENV := if env("USE_SYSTEM_PYTHON", "false") != "false" { "" } else { "sh .venv/bin/activate &&" } +NEWLINE:="$'\n'" +# print list of commands +help: + @just --list --unsorted +# install into the venv +install: + @# $(PYTHON_PYENV) + {{if env("CI","false") != "false" { "" } else { "pyenv install --skip-existing $PYTHON_VERSION "} }} + @# $(PYTHON_VENV) + {{ if env("USE_SYSTEM_PYTHON", "false") != "false" { "" } else { "python -m venv .venv" } }} + @# pip + {{PYTHON}} -m pip install -e .[dev,optional,docs] + +# Install pre-commit +pre-commit_install: + pre-commit install + +# Setup sphynx autodoc +setup_autodoc: + sphinx-apidoc -f -o docs/source {{PACKAGE_SLUG}} + +# copy as template +copy_as_template DEST: + rsync -r --exclude .mypy_cache --exclude .pytest_cache --exclude .ruff_cache --exclude .tox --exclude .venv --exclude *.egg* --exclude .git ./ {{DEST}} + cd {{DEST}} && git init . && git commit --allow-empty -m 'Make initial root commit' + +# profiling +profile: + python -m cProfile -s time -o timing.prof tests/timing.py --profile + snakeviz timing.prof + +# +# Formatting +# +# Run all linting and fixes +fixes: validate_pyproject ruff_fixes ruff_format_fixes pylint dapperdata_fixes tomlsort_fixes docs pytest + +_fixes_no_ruff: validate_pyproject dapperdata_fixes tomlsort_fixes docs pytest update_dependencies_quiet + +# Validate pyproject.toml format +validate_pyproject: + {{PYTHON}} -m validate_pyproject pyproject.toml + +# Run pylint +pylint: + {{PYTHON}} -m pylint {{PACKAGE_SLUG}} + +# Run Ruff and fix +ruff_fixes: + {{PYTHON}} -m ruff check . --fix + +alias black_check := ruff_format_fixes +#Run Ruff format fixes +ruff_format_fixes: + {{PYTHON}} -m ruff format . + +# Run dapperdata fixes +dapperdata_fixes: + {{PYTHON}} -m dapperdata.cli pretty . --no-dry-run + +# Run Tomlsort fixes +tomlsort_fixes: + {{PYTHON_ENV}} toml-sort `find . -not -path "./.venv/*" -not -path "./.tox/*" -name "*.toml"` -i + +# Generate Docs +docs: + make -C ./docs clean html + +# +# Testing +# +# Run all tests +tests: install pytest ruff_check ruff_format_check mypy dapperdata_check tomlsort_check + +# Run Pytest +pytest: + {{PYTHON}} -m pytest --cov=./{{PACKAGE_SLUG}} --cov-report=term-missing tests + +# Run Pytest verbose +pytestvv: + {{PYTHON}} -m pytest -vv --cov=./{{PACKAGE_SLUG}} --cov-report=term-missing tests + +# Run pytest show strings +pytest_loud: + {{PYTHON}} -m pytest -vv -rA --cov=./{{PACKAGE_SLUG}} --cov-report=term-missing tests + +# Run ruff in check mode +ruff_check: + {{PYTHON}} -m ruff check + +# Run ruff format in check mode +ruff_format_check: + {{PYTHON}} -m ruff format . --check + +# Run mypy check +mypy: + {{PYTHON}} -m mypy {{PACKAGE_SLUG}} + +# Run dapperdata check +dapperdata_check: + {{PYTHON}} -m dapperdata.cli pretty . + +# Run tomlsort_check +tomlsort_check: + {{PYTHON_ENV}} toml-sort `find . -not -path "./.venv/*" -not -path "./.tox/*" -name "*.toml"` --check + +# +# Dependencies +# + +# Rebuild dependencies +rebuild_dependencies: + {{PYTHON}} -m uv pip compile --output-file=requirements.txt pyproject.toml + {{PYTHON}} -m uv pip compile --output-file=requirements-dev.txt --extra=dev pyproject.toml + {{PYTHON}} -m uv pip compile --output-file=requirements-optional.txt --extra=optional pyproject.toml + +# Update dependencies +update_dependencies: + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements.txt pyproject.toml + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-dev.txt --extra=dev pyproject.toml + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-optional.txt --extra=optional pyproject.toml + +update_dependencies_quiet: + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements.txt pyproject.toml > /dev/null + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-dev.txt --extra=dev pyproject.toml > /dev/null + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-optional.txt --extra=optional pyproject.toml > /dev/null + +# +# Packaging +# + +# Build package +build: install + {{PYTHON}} -m build + +# Create Git tag for release +create_tag tag notes="": + git tag -a v{{tag}} -m "Release {{tag}} "{{NEWLINE}}" {{notes}})" diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..27a5520 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,314 @@ +[build-system] +build-backend = "setuptools.build_meta" +requires = ["setuptools>=67.0", "wheel"] + +[project] +authors = [{"name" = "R.Broderick"}] +description = "Python verbal based regular expressions" +version = "2.0.2" +license = {"file" = "LICENSE"} +name = "Verbex" +readme = {file = "README.md", content-type = "text/markdown"} +dependencies = ["beartype", "typing-extensions; python_version < '3.12'"] +requires-python = ">=3.10.0" +classifiers = [ + "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12" +] + +[project.optional-dependencies] +dev = [ + "build", + "dapperdata", + "glom", + "mypy", + "pytest", + "pytest-cov", + "pytest-pretty", + "ruamel.yaml", + "ruff", + "toml-sort", + "uv", + "validate-pyproject", + "packaging", + "snakeviz", + "pre-commit", + "tox", + "tox-pyenv-redux", + "pylint", + "perflint", + "snakeviz", + "pip-audit" +] +optional = [] +docs = [ + "Sphinx", + "sphinx-autodoc-typehints", + "sphinx-rtd-theme", + "sphinx-rtd-size", + "autodocsumm", + "sphinx-pyproject" +] + +[project.urls] +homepage = "https://github.com/rbroderi/Verbex" +documentation = "https://rbroderi.github.io/Verbex/" + +[tool.dapperdata] +exclude_paths = [".venv", ".mypy_cache", ".git", ".vscode"] + +[tool.pylint.format] +max-line-length = 200 + +[tool.pylint.main] +extension-pkg-allow-list = ["pyodbc", "win32gui"] +load-plugins = "perflint" + +[tool.pylint."messages control"] +disable = [ + "W0707", + "W0703", + "C0204", + "C0411", + "C0114", + "C0115", + "C0116", + "W0611", + "E0401", + "W2301", + "C0414", + "C0413", + "R0902", + "R0914", + "W8205", + "E0611", + "C0103", + "R0913", + "R0903", + "W0613", + "C0412", + "W8201", + "R0912", + "R0915", + "R0801", + "W8402", + "W0511", + "W0622", + "W0107", + "R0911", + "E1101", + "E1136", + "E1120", + "W8403", + "W0222", + "E1129", + "E0213", + "W0221", + "E1128", + "C0321", + "logging-fstring-interpolation", + "unnecessary-lambda-assignment", + "protected-access", + # codes in ruff + "C0105", + "C0131", + "C0132", + "C0205", + "C0208", + "C0414", + "C3002", + "E0100", + "E0101", + "E0116", + "E0117", + "E0118", + "E0237", + "E0241", + "E0302", + "E0307", + "E0604", + "E0605", + "E1142", + "E1205", + "E1206", + "E1300", + "E1307", + "E1310", + "E1507", + "E1700", + "E2502", + "E2510", + "E2512", + "E2513", + "E2514", + "E2515", + "R0124", + "R0133", + "R0206", + "R0402", + "R0911", + "R0912", + "R0913", + "R0915", + "R1701", + "R1711", + "R1714", + "R1722", + # "R2004", + # "R5501", + "W0120", + "W0127", + "W0129", + "W0131", + "W0406", + "W0602", + "W0603", + "W0711", + "W1508", + "W1509", + "W1510", + # "W2901", + "W3301" +] + +[tool.pytest.ini_options] +pythonpath = ["src"] + +[tool.ruff] +exclude = [".venv"] +line-length = 88 +indent-width = 4 +target-version = "py310" + +[tool.ruff.format] +# Like Black, use double quotes for strings. +quote-style = "double" +# Like Black, indent with spaces, rather than tabs. +indent-style = "space" +# Like Black, respect magic trailing commas. +skip-magic-trailing-comma = false +# Like Black, automatically detect the appropriate line ending. +line-ending = "auto" +# Enable auto-formatting of code examples in docstrings. Markdown, +# reStructuredText code/literal blocks and doctests are all supported. +# +# This is currently disabled by default, but it is planned for this +# to be opt-out in the future. +docstring-code-format = true +# Set the line length limit used when formatting code snippets in +# docstrings. +# +# This only has an effect when the `docstring-code-format` setting is +# enabled. +docstring-code-line-length = "dynamic" + +[tool.ruff.lint] +typing-modules = ["beartype.typing"] +select = ["ALL"] +ignore = [ + "B024", + "PIE790", + "T201", + "PYI013", + "ANN101", + "TCH003", + "PLC0414", + "ERA001", + "T203", + "ANN102", + "ANN401", + "TCH002", + "TD002", + "TD003", + "FIX002", + "D203", + "D213", + "COM812", + "ISC001", + "FBT001", + "FBT002" +] +fixable = ["ALL"] +unfixable = [] + +[tool.ruff.lint.isort] +force-single-line = true + +[tool.setuptools.dynamic] +readme = {file = ["README.md"]} + +[tool.setuptools.package-data] +library = ["py.typed"] + +[tool.setuptools.packages.find] +exclude = ["docs*", "tests*"] +where = ["src"] + +[tool.sphinx-pyproject] +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration +coverage_show_missing_items = true +extensions = [ + "sphinx.ext.autodoc", + "sphinx_autodoc_typehints", + "sphinx.ext.viewcode", + "sphinx.ext.coverage", + "autodocsumm", + "sphinx_rtd_theme", + 'sphinx_rtd_size' +] +sphinx_rtd_size_width = "90%" +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +auto_doc_default_options = {'autosummary' = true} +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output +html_theme = "sphinx_rtd_theme" +html_style = "css/custom.css" +html_static_path = ["_static"] +html_theme_options = {'display_version' = true, 'sticky_navigation' = true, 'includehidden' = true, 'titles_only' = false} +autosummary_generate = true + +[tool.sphinx-pyproject.autodoc_default_options] +exclude-members = """ + __weakref__, + __sizeof__, + __hash__, + __module__, + __dict__, + __annotations__, + __orig_bases__, + __parameters__, + __abstractmethods__, + __non_callable_proto_members__, + __protocol_attrs__, + __subclasshook__, + __dataclass_fields__, + __post_init__, + __dataclass_params__, + __match_args__, + __str__, + __repr__""" +members = true +member-order = 'bysource' +special-members = true +undoc-members = true + +[tool.tox] +legacy_tox_ini = """ +[tox] +skipsdist = True +isolated_build = True +envlist = py310, py311, py312 + +[testenv] +deps = + -rrequirements-dev.txt + -rrequirements-optional.txt + +commands = + pytest tests +""" diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..1c12bc0 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,194 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile --output-file=requirements-dev.txt --extra=dev pyproject.toml +annotated-types==0.6.0 + # via pydantic +astroid==3.1.0 + # via pylint +attrs==23.2.0 + # via glom +beartype==0.18.5 +boltons==24.0.0 + # via + # face + # glom +boolean-py==4.0 + # via license-expression +build==1.2.1 +cachecontrol==0.14.0 + # via pip-audit +cachetools==5.3.3 + # via tox +certifi==2024.2.2 + # via requests +cfgv==3.4.0 + # via pre-commit +chardet==5.2.0 + # via tox +charset-normalizer==3.3.2 + # via requests +click==8.1.7 + # via typer +colorama==0.4.6 + # via tox +coverage==7.5.0 + # via pytest-cov +cyclonedx-python-lib==6.4.4 + # via pip-audit +dapperdata==0.4.0 +defusedxml==0.7.1 + # via py-serializable +dill==0.3.8 + # via pylint +distlib==0.3.8 + # via virtualenv +face==20.1.1 + # via glom +fastjsonschema==2.19.1 + # via validate-pyproject +filelock==3.13.4 + # via + # cachecontrol + # tox + # virtualenv +glom==23.5.0 +html5lib==1.1 + # via pip-audit +identify==2.5.36 + # via pre-commit +idna==3.7 + # via requests +iniconfig==2.0.0 + # via pytest +isort==5.13.2 + # via pylint +license-expression==30.3.0 + # via cyclonedx-python-lib +markdown-it-py==3.0.0 + # via rich +mccabe==0.7.0 + # via pylint +mdurl==0.1.2 + # via markdown-it-py +msgpack==1.0.8 + # via cachecontrol +mypy==1.10.0 +mypy-extensions==1.0.0 + # via mypy +nodeenv==1.8.0 + # via pre-commit +packageurl-python==0.15.0 + # via cyclonedx-python-lib +packaging==24.0 + # via + # build + # pip-audit + # pip-requirements-parser + # pyproject-api + # pytest + # tox +perflint==0.8.1 +pip==24.0 + # via pip-api +pip-api==0.0.33 + # via pip-audit +pip-audit==2.7.2 +pip-requirements-parser==32.0.1 + # via pip-audit +platformdirs==4.2.1 + # via + # pylint + # tox + # virtualenv +pluggy==1.5.0 + # via + # pytest + # tox +pre-commit==3.7.0 +py-serializable==1.0.3 + # via cyclonedx-python-lib +pydantic==2.7.1 + # via + # dapperdata + # pydantic-settings +pydantic-core==2.18.2 + # via pydantic +pydantic-settings==2.2.1 + # via dapperdata +pyenv-inspect==0.4.0 + # via virtualenv-pyenv +pygments==2.17.2 + # via rich +pylint==3.1.0 + # via perflint +pyparsing==3.1.2 + # via pip-requirements-parser +pyproject-api==1.6.1 + # via tox +pyproject-hooks==1.0.0 + # via build +pytest==8.2.0 + # via + # pytest-cov + # pytest-pretty +pytest-cov==5.0.0 +pytest-pretty==1.2.0 +python-dotenv==1.0.1 + # via pydantic-settings +pyyaml==6.0.1 + # via pre-commit +requests==2.31.0 + # via + # cachecontrol + # pip-audit +rich==13.7.1 + # via + # pip-audit + # pytest-pretty + # typer +ruamel-yaml==0.18.6 + # via dapperdata +ruamel-yaml-clib==0.2.8 + # via ruamel-yaml +ruff==0.4.2 +setuptools==69.5.1 + # via nodeenv +shellingham==1.5.4 + # via typer +six==1.16.0 + # via html5lib +snakeviz==2.2.0 +sortedcontainers==2.4.0 + # via cyclonedx-python-lib +toml==0.10.2 + # via pip-audit +toml-sort==0.23.1 +tomlkit==0.12.4 + # via + # pylint + # toml-sort +tornado==6.4 + # via snakeviz +tox==4.15.0 + # via tox-pyenv-redux +tox-pyenv-redux==1.1.0 +typer==0.12.3 + # via dapperdata +typing-extensions==4.11.0 + # via + # mypy + # pydantic + # pydantic-core + # typer +urllib3==2.2.1 + # via requests +uv==0.1.39 +validate-pyproject==0.16 +virtualenv==20.26.0 + # via + # pre-commit + # tox + # virtualenv-pyenv +virtualenv-pyenv==0.5.0 + # via tox-pyenv-redux +webencodings==0.5.1 + # via html5lib diff --git a/requirements-optional.txt b/requirements-optional.txt new file mode 100644 index 0000000..bbca596 --- /dev/null +++ b/requirements-optional.txt @@ -0,0 +1,3 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile --output-file=requirements-optional.txt --extra=optional pyproject.toml +beartype==0.18.5 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..516c965 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile --output-file=requirements.txt pyproject.toml +beartype==0.18.5 diff --git a/setup.py b/setup.py deleted file mode 100755 index e76b29e..0000000 --- a/setup.py +++ /dev/null @@ -1,26 +0,0 @@ -from setuptools import setup - -setup( - name="VerbalExpressions", - version="0.0.2", - description="Make difficult regular expressions easy! Python port of the awesome VerbalExpressions repo - https://github.com/jehna/VerbalExpressions", - long_description="Please see https://github.com/VerbalExpressions/PythonVerbalExpressions/blob/master/README.md for more information!", - author="Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer Raghuram, Kharms", - license="MIT", - url="https://github.com/VerbalExpressions/PythonVerbalExpressions", - test_suite="tests", - packages=["verbalexpressions"], - tests_require=["six"], - extras_require={"dev": ["pre-commit", "black"]}, - classifiers=[ - "License :: OSI Approved :: MIT License", - "Programming Language :: Python", - "Programming Language :: Python :: 2.7", - "Programming Language :: Python :: 3.5", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Topic :: Software Development :: Libraries", - "Topic :: Text Processing", - ], -) diff --git a/src/verbex/__init__.py b/src/verbex/__init__.py new file mode 100644 index 0000000..6ce3539 --- /dev/null +++ b/src/verbex/__init__.py @@ -0,0 +1,12 @@ +"""Verbal regular expression library.""" + +# try: +# from importlib.metadata import version +# except ImportError: +# from importlib_metadata import version + +from .verbex import CharClass as CharClass +from .verbex import SpecialChar as SpecialChar +from .verbex import Verbex as Verbex + +# __version__ = version("verbex") diff --git a/src/verbex/py.typed b/src/verbex/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/src/verbex/verbex.py b/src/verbex/verbex.py new file mode 100644 index 0000000..033ab28 --- /dev/null +++ b/src/verbex/verbex.py @@ -0,0 +1,676 @@ +"""Generate regular expressions from an easier fluent verbal form.""" + +from __future__ import annotations + +import re +from collections.abc import Callable +from collections.abc import Iterator +from enum import Enum +from functools import wraps +from typing import Annotated +from typing import Any +from typing import TypeAlias +from typing import Union +from typing import cast +from typing import runtime_checkable + +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +from re import Pattern +from typing import ParamSpec +from typing import Protocol +from typing import TypeVar + +from beartype import beartype +from beartype.vale import Is + + +def _string_len_is_1(text: object) -> bool: + return isinstance(text, str) and len(text) == 1 + + +Char = Annotated[str, Is[_string_len_is_1]] + + +P = ParamSpec("P") +R = TypeVar("R") + + +# work around for bug https://github.com/python/mypy/issues/12660 +# fixed in next version of mypy. +@runtime_checkable +class HasIter(Protocol): + """Workaround for mypy P.args.""" + + def __iter__(self) -> Iterator[Any]: + """Object can be iterated. + + Yields + ------ + Next object. + + """ + ... + + +# work around for bug https://github.com/python/mypy/issues/12660 +# fixed in next version of mypy +@runtime_checkable +class HasItems(Protocol): + """Workaround for mypy P.kwargs.""" + + def items(self) -> tuple[str, Any]: + """Object has items method. + + :returns: The dict of items. + :rtype: dict + """ + ... + + +class EscapedText(str): + """Text that has been escaped for regex. + + :param str value: the string to escape + :return: escaped regex string + :rtype: str + + """ + + __slots__ = () + + def __new__(cls, value: str) -> Self: + """Return an escaped regex string. + + :param str value: the string to escape + :return: escaped regex string + :rtype: str + + """ + return str.__new__(cls, re.escape(value)) + + +def re_escape(func: Callable[P, R]) -> Callable[P, R]: + """Automatically escape any string parameters as EscapedText. + + :param func: The function to decorate. + :type func: Callable[P, R] + :return: The decorated function. + :rtype: Callable[P, R] + + """ + + @wraps(func) + def inner(*args: P.args, **kwargs: P.kwargs) -> R: + escaped_args: list[Any] = [] + escaped_kwargs: dict[str, Any] = {} + for arg in cast(HasIter, args): + if not isinstance(arg, EscapedText) and isinstance(arg, str): + escaped_args.append(EscapedText(arg)) + else: + escaped_args.append(arg) + arg_k: str + arg_v: Any + for arg_k, arg_v in cast(HasItems, kwargs).items(): + if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str): + escaped_kwargs[arg_k] = EscapedText(str(arg_v)) + else: + escaped_kwargs[arg_k] = arg_v + return func(*escaped_args, **escaped_kwargs) # pyright: ignore[reportCallIssue] + + return inner + + +class CharClass(Enum): + """Enum of character classes in regex. + + :param Enum: Extends the Enum class. + :type Enum: class + + """ + + DIGIT = "\\d" + LETTER = "\\w" + UPPERCASE_LETTER = "\\u" + LOWERCASE_LETTER = "\\l" + WHITESPACE = "\\s" + TAB = "\\t" + + def __str__(self) -> str: + """To string method based on Enum value. + + :return: value of Enum + :rtype: str + + """ + return self.value + + +class SpecialChar(Enum): + """Enum of special characters, shorthand. + + :param Enum: Extends the Enum class. + :type Enum: class + + """ + + # does not work / should not be used in [ ] + LINEBREAK = "(\\n|(\\r\\n))" + START_OF_LINE = "^" + END_OF_LINE = "$" + TAB = "\t" + + def __str__(self) -> str: + """To string for special chars enum. + + :return: Return value of enum as string. + :rtype: str + + """ + return self.value + + +CharClassOrChars: TypeAlias = str | CharClass +EscapedCharClassOrSpecial: TypeAlias = str | CharClass | SpecialChar +VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] + + +class Verbex: # pylint: disable=too-many-public-methods + """VerbalExpressions class. + + The following methods do not try to match the original js lib! + + .. note:: + This class is a modified version of the VerbalExpressions library. + + """ + + EMPTY_REGEX_FLAG = re.RegexFlag(0) + + @re_escape + @beartype + def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG) -> None: + """Create a Verbex object; setting any needed flags. + + :param modifiers: Regex modifying flags (default: ``re.RegexFlag(0)``) + :type modifiers: re.RegexFlag + + :returns: The created Verbex object. + :rtype: Verbex + + """ + # self._parts: List[str] = [text] + self._parts: list[str] = [] + self._modifiers = modifiers + + @property + def modifiers(self) -> re.RegexFlag: + """Return the modifiers for this Verbex object. + + :return: The modifiers applied to this object. + :rtype: re.RegexFlag + + """ + return self._modifiers + + def __str__(self) -> str: + """Return regex string representation. + + :return: The regex string representation. + :rtype: str + + """ + return "".join(self._parts) + + @beartype + def _add(self, value: str | list[str]) -> Verbex: + """Append a transformed value to internal expression to be compiled. + + As possible, this method should be "private". + + :return: Modified Verbex object. + :rtype: Verbex + + """ + if isinstance(value, list): + self._parts.extend(value) + else: + self._parts.append(value) + return self + + def regex(self) -> Pattern[str]: + """Get a regular expression object. + + :return: A regular expression object. + :rtype: Pattern[str] + + """ + return re.compile( + str(self), + self._modifiers, + ) + + # allow VerbexEscapedCharClassOrSpecial + + @re_escape + @beartype + def _capture_group_with_name( + self, + name: str, + text: VerbexEscapedCharClassOrSpecial, + ) -> Verbex: + return self._add(f"(?<{name}>{text!s})") + + @re_escape + @beartype + def _capture_group_without_name( + self, + text: VerbexEscapedCharClassOrSpecial, + ) -> Verbex: + return self._add(f"({text!s})") + + @re_escape + @beartype + def capture_group( + self, + name_or_text: str | None | VerbexEscapedCharClassOrSpecial = None, + text: VerbexEscapedCharClassOrSpecial | None = None, + ) -> Verbex: + """Create a capture group. + + Name is optional. If not specified, then the first argument is the text. + + :param name_or_text: The name of the group / text to search for (default: None) + :type name_or_text: str or None + :param text: The text to search for (default: None) + :type text: str or None + + :raises ValueError: If name is specified, then text must be as well. + + :returns: Verbex with added capture group. + :rtype: Verbex + + """ + if name_or_text is not None: + if text is None: + _text = name_or_text + return self._capture_group_without_name(_text) + if isinstance(name_or_text, str): + return self._capture_group_with_name(name_or_text, text) + msg = "text must be specified with optional name" + raise ValueError(msg) + + @re_escape + @beartype + def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa: N802 + """`or` is a python keyword so we use `OR` instead. + + :param text: Text to find or a Verbex object. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add("|").find(text) + + @re_escape + @beartype + def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Find the text or Verbex object zero or more times. + + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:{text!s})*") + + @re_escape + @beartype + def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Find the text or Verbex object one or more times. + + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:{text!s})+") + + @re_escape + @beartype + def n_times( + self, + text: VerbexEscapedCharClassOrSpecial, + n: int, + ) -> Verbex: + """Find the text or Verbex object n or more times. + + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:{text!s}){{{n}}}") + + @re_escape + @beartype + def n_times_or_more( + self, + text: VerbexEscapedCharClassOrSpecial, + n: int, + ) -> Verbex: + """Find the text or Verbex object at least n times. + + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:{text!s}){{{n},}}") + + @re_escape + @beartype + def n_to_m_times( + self, + text: VerbexEscapedCharClassOrSpecial, + n: int, + m: int, + ) -> Verbex: + """Find the text or Verbex object between n and m times. + + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + :param n: The minimum number of times to find the text. + :type n: int + :param m: The maximum number of times to find the text. + :type m: int + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:{text!s}){{{n},{m}}}") + + @re_escape + @beartype + def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Possibly find the text / Verbex object. + + :param text: The text / Verbex object to possibly find. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:{text!s})?") + + @re_escape + @beartype + def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Find the text or Verbex object. + + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(str(text)) + + @re_escape + @beartype + def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Synonym for find. + + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self.find(text) + + @re_escape + @beartype + def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is followed by text. + + Positive lookahead + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?={text})") + + @re_escape + @beartype + def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is not followed by text. + + Negative lookahead + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?!{text})") + + @re_escape + @beartype + def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is not preceded by text. + + Positive lookbehind + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?<={text})") + + @re_escape + @beartype + def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is not preceded by text. + + Negative Lookbehind + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(? Verbex: + """Find anything in this group of chars or char class. + + :param text: The characters to look for. + :type text: str + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:[{chargroup}])") + + @re_escape + @beartype + def not_any_of(self, text: CharClassOrChars) -> Verbex: + """Find anything but this group of chars or char class. + + :param text: The characters to not look for. + :type text: str + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"(?:[^{text}])") + + @re_escape + def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: + """Find anything one or more times but this group of chars or char class. + + :param text: The characters to not look for. + :type text: str + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"[^{chargroup}]+") + + # no text input + + def start_of_line(self) -> Verbex: + """Find the start of the line. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self.find(SpecialChar.START_OF_LINE) + + def end_of_line(self) -> Verbex: + """Find the end of the line. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self.find(SpecialChar.END_OF_LINE) + + def line_break(self) -> Verbex: + """Find a line break. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self.find(SpecialChar.LINEBREAK) + + def tab(self) -> Verbex: + """Find a tab. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self.find(SpecialChar.TAB) + + def anything(self) -> Verbex: + """Find anything one or more times. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(".+") + + def as_few(self) -> Verbex: + """Modify previous search to not be greedy. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add("?") + + @beartype + def number_range(self, start: int, end: int) -> Verbex: + """Generate a range of numbers. + + :param start: Start of the range + :type start: int + :param end: End of the range + :type end: int + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")") + + @beartype + def letter_range(self, start: Char, end: Char) -> Verbex: + """Generate a range of letters. + + :param start: Start of the range + :type start: Char + :param end: End of the range + :type end: Char + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add(f"[{start}-{end}]") + + def word(self) -> Verbex: + """Find a word on word boundary. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + return self._add("(\\b\\w+\\b)") + + # # --------------- modifiers ------------------------ + + def with_any_case(self) -> Verbex: + """Modify Verbex object to be case insensitive. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + self._modifiers |= re.IGNORECASE + return self + + def search_by_line(self) -> Verbex: + """Search each line, ^ and $ match beginning and end of line respectively. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + self._modifiers |= re.MULTILINE + return self + + def with_ascii(self) -> Verbex: + """Match ascii instead of unicode. + + :return: Modified Verbex object. + :rtype: Verbex + + """ + self._modifiers |= re.ASCII + return self + + +# left over notes from original version +# def __getattr__(self, attr): +# """ any other function will be sent to the regex object """ +# regex = self.regex() +# return getattr(regex, attr) + +# def replace(self, string, repl): +# return self.sub(repl, string) + + +if __name__ == "__main__": + pass diff --git a/tests/__init__.py b/tests/__init__.py index e69de29..aa0162f 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""Unit tests for the Verbex package.""" diff --git a/tests/test_verbex.py b/tests/test_verbex.py new file mode 100644 index 0000000..ca27a72 --- /dev/null +++ b/tests/test_verbex.py @@ -0,0 +1,306 @@ +# pyright: reportPrivateUsage=false +# flake8: noqa +# type: ignore +# pylint: disable-all +import re +import unittest + +from verbex import CharClass, SpecialChar, Verbex + + +class verbexTest(unittest.TestCase): + """Tests for verbal_expressions.py""" + + # def setUp(self): + # Verbex() = Verbex() + + # def tearDown(self): + # ... + # # Verbex() = None + # # self.exp = None + + def test_should_render_verbex_as_string(self): + self.assertEqual(str(Verbex()._add("^$")), "^$") + + def test_should_render_verbex_list_as_string(self): + self.assertEqual(str(Verbex()._add(["^", "[0-9]", "$"])), "^[0-9]$") + + def test_should_match_characters_in_range(self): + regex = Verbex().letter_range("a", "c").regex() + for character in ["a", "b", "c"]: + self.assertRegex(character, regex) + + def test_should_not_match_characters_outside_of_range(self): + regex = Verbex().letter_range("a", "c").regex() + self.assertNotRegex("d", regex) + + def test_should_match_start_of_line(self): + regex = Verbex().find(SpecialChar.START_OF_LINE).find("text ").regex() + self.assertRegex("text ", regex) + + def test_should_match_end_of_line(self): + regex = Verbex().find("test").find(SpecialChar.END_OF_LINE).regex() + self.assertRegex("IGNORE test", regex) + + def test_should_match_anything(self): + regex = Verbex().anything().regex() + self.assertIsNotNone(re.fullmatch(regex, "!@#$%¨&*()__+{}")) + + def test_should_match_anything_but_specified_element_when_element_is_not_found( + self, + ): + regex = Verbex().anything_but("X").find(" Files").regex() + self.assertRegex("Y Files", regex) + self.assertNotRegex("X Files", regex) + + def test_should_not_match_anything_but_specified_element_when_specified_element_is_found( + self, + ): + regex = Verbex().anything_but("X").regex() + self.assertRegex("Y Files", regex) + self.assertNotRegex("X", regex) + + def test_should_find_element(self): + regex = Verbex().find("Wally").regex() + self.assertRegex("Wally", regex) + self.assertNotRegex("Nally", regex) + + def test_should_not_find_missing_element(self): + regex = Verbex().find("Wally").regex() + self.assertNotRegex("Wall-e", regex) + + def test_should_match_when_maybe_element_is_present(self): + regex = ( + Verbex() + .start_of_line() + .find("Python2.") + .maybe("7") + .end_of_line() + .regex() # + ) + self.assertRegex("Python2.7", regex) + + def test_should_match_when_maybe_element_is_missing(self): + regex = ( + Verbex() + .start_of_line() + .find("Python2.") + .maybe("7") + .end_of_line() + .regex() # + ) + self.assertRegex("Python2.", regex) + + def test_should_match_on_any_when_element_is_found(self): + regex = ( + Verbex() + .start_of_line() + .any_of("Q") + .anything() + .end_of_line() + .regex() # E501 # + ) + self.assertRegex("Query", regex) + + def test_should_not_match_on_any_when_element_is_not_found(self): + regex = ( + Verbex() + .start_of_line() + .any_of("Q") + .anything() + .end_of_line() + .regex() # E501 # + ) + self.assertNotRegex("W", regex) + + def test_should_match_when_line_break_present(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .line_break() + .anything() + .end_of_line() + .regex() + ) + self.assertRegex("Marco \n Polo", regex) + self.assertNotRegex("Marco Polo", regex) + + def test_should_match_when_line_break_and_carriage_return_present(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .line_break() + .anything() + .end_of_line() + .regex() + ) + self.assertRegex("Marco \r\n Polo", regex) + + def test_should_not_match_when_line_break_is_missing(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .line_break() + .anything() + .end_of_line() + .regex() + ) + self.assertNotRegex("Marco Polo", regex) + + def test_should_match_when_tab_present(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .as_few() + .find("!") + .tab() + .end_of_line() + .regex() # E501 # + ) + self.assertRegex("One tab only!\t", regex) + self.assertNotRegex("One tab only!\t\t", regex) + + def test_should_not_match_when_tab_is_missing(self): + regex = Verbex().start_of_line().anything().tab().end_of_line().regex() + self.assertNotRegex("No tab here", regex) + + def test_should_match_when_word_present(self): + regex = Verbex().start_of_line().word().end_of_line().regex() + self.assertRegex("Oneword", regex) + + def test_not_match_when_two_words_are_present_instead_of_one(self): + regex = Verbex().start_of_line().word().end_of_line().regex() + self.assertNotRegex("Two words", regex) + + def test_should_match_when_or_condition_fulfilled(self): + regex = ( + Verbex() + .start_of_line() + .find("G") + .OR(Verbex().find("H")) + .anything() + .as_few() + .find("b") + .end_of_line() + .regex() + ) + self.assertRegex("Github", regex) + self.assertRegex("Hithub", regex) + + def test_should_not_match_when_or_condition_not_fulfilled(self): + regex = ( + Verbex() + .start_of_line() + .find("G") + .OR(Verbex().find("H")) + .anything() + .as_few() + .find("b") + .end_of_line() + .regex() + ) + self.assertNotRegex("ithub", regex) + + def test_should_match_on_upper_case_when_lower_case_is_given_and_any_case( + self, + ): + regex = ( + Verbex() + .start_of_line() + .find("THOR") + .end_of_line() + .with_any_case() + .regex() # E501 # + ) + self.assertRegex("thor", regex) + + def test_should_not_match_on_upper_case_when_lower_case_is_given( + self, + ): + regex = Verbex().start_of_line().find("THOR").end_of_line().regex() + self.assertNotRegex("thor", regex) + + def test_should_match_multiple_lines(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .find("Pong") + .anything() + .end_of_line() + .search_by_line() + .regex() + ) + self.assertRegex("Ping \n Pong \n Ping", regex) + + def test_should_not_match_multiple_lines(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .find("Pong") + .anything() + .end_of_line() + .regex() + ) + self.assertNotRegex("Ping \n Pong \n Ping", regex) + + def test_should_match_email_like(self): + regex = ( + Verbex() + .start_of_line() + .one_or_more(Verbex().any_of(CharClass.LETTER)) + .then("@") + .one_or_more(Verbex().any_of(CharClass.LETTER)) + .then(".") + .one_or_more(Verbex().any_of(CharClass.LETTER)) + .end_of_line() + .regex() + ) + self.assertRegex("mail@mail.com", regex) + + def test_should_match_url(self): + regex = ( + Verbex() + .start_of_line() + .then("http") + .maybe("s") + .then("://") + .maybe("www.") + .word() + .then(".") + .word() + .maybe("/") + .end_of_line() + .regex() + ) + self.assertRegex("https://www.google.com/", regex) + self.assertNotRegex("htps://www.google.com/", regex) + + def test_followed_by(self): + regex = Verbex().find("!").followed_by(":").regex() + self.assertRegex("!:", regex) + self.assertNotRegex("! :", regex) + + def test_not_followed_by(self): + regex = Verbex().find("!").not_followed_by(":").regex() + self.assertNotRegex("!:", regex) + self.assertRegex("! :", regex) + + def test_preceded_by(self): + regex = Verbex().preceded_by("!").find(":").regex() + self.assertRegex("!:", regex) + self.assertNotRegex("! :", regex) + + def test_not_preceded_by(self): + regex = Verbex().not_preceded_by("!").find(":").regex() + self.assertNotRegex("!:", regex) + self.assertRegex("! :", regex) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/verbal_expressions_test.py b/tests/verbal_expressions_test.py deleted file mode 100644 index 4996b2f..0000000 --- a/tests/verbal_expressions_test.py +++ /dev/null @@ -1,263 +0,0 @@ -# -*- encoding: utf-8 -*- - -import unittest -import re - -import six - -import verbalexpressions - - -class VerExTest(unittest.TestCase): - """ Tests for verbal_expressions.py """ - - if six.PY3: - assertNotRegexpMatches = unittest.TestCase.assertNotRegex - - def setUp(self): - self.v = verbalexpressions.VerEx() - - def tearDown(self): - self.v = None - self.exp = None - - def test_should_render_verex_as_string(self): - self.assertEqual(str(self.v.add("^$")), "^$") - - def test_should_render_verex_list_as_string(self): - self.assertEqual(str(self.v.add(["^", "[0-9]", "$"])), "^[0-9]$") - - def test_should_match_characters_in_range(self): - self.exp = self.v.start_of_line().range("a", "c").regex() - for character in ["a", "b", "c"]: - six.assertRegex(self, character, self.exp) - - def test_should_not_match_characters_outside_of_range(self): - self.exp = self.v.start_of_line().range("a", "c").regex() - self.assertNotRegexpMatches("d", self.exp) - - def test_should_match_characters_in_extended_range(self): - self.exp = self.v.start_of_line().range("a", "b", "X", "Z").regex() - for character in ["a", "b"]: - six.assertRegex(self, character, self.exp) - for character in ["X", "Y", "Z"]: - six.assertRegex(self, character, self.exp) - - def test_should_not_match_characters_outside_of_extended_range(self): - self.exp = self.v.start_of_line().range("a", "b", "X", "Z").regex() - self.assertNotRegexpMatches("c", self.exp) - self.assertNotRegexpMatches("W", self.exp) - - def test_should_match_start_of_line(self): - self.exp = self.v.start_of_line().regex() - six.assertRegex(self, "text ", self.exp, "Not started :(") - - def test_should_match_end_of_line(self): - self.exp = self.v.start_of_line().end_of_line().regex() - six.assertRegex(self, "", self.exp, "It's not the end!") - - def test_should_match_anything(self): - self.exp = self.v.start_of_line().anything().end_of_line().regex() - six.assertRegex( - self, "!@#$%¨&*()__+{}", self.exp, "Not so anything..." - ) - - def test_should_match_anything_but_specified_element_when_element_is_not_found( - self - ): - self.exp = ( - self.v.start_of_line().anything_but("X").end_of_line().regex() - ) - six.assertRegex(self, "Y Files", self.exp, "Found the X!") - - def test_should_not_match_anything_but_specified_element_when_specified_element_is_found( - self - ): - self.exp = ( - self.v.start_of_line().anything_but("X").end_of_line().regex() - ) - self.assertNotRegexpMatches("VerEX", self.exp, "Didn't found the X :(") - - def test_should_find_element(self): - self.exp = self.v.start_of_line().find("Wally").end_of_line().regex() - six.assertRegex(self, "Wally", self.exp, "404! Wally not Found!") - - def test_should_not_find_missing_element(self): - self.exp = self.v.start_of_line().find("Wally").end_of_line().regex() - self.assertNotRegexpMatches("Wall-e", self.exp, "DAFUQ is Wall-e?") - - def test_should_match_when_maybe_element_is_present(self): - self.exp = ( - self.v.start_of_line() - .find("Python2.") - .maybe("7") - .end_of_line() - .regex() - ) - six.assertRegex(self, "Python2.7", self.exp, "Version doesn't match!") - - def test_should_match_when_maybe_element_is_missing(self): - self.exp = ( - self.v.start_of_line() - .find("Python2.") - .maybe("7") - .end_of_line() - .regex() - ) - six.assertRegex(self, "Python2.", self.exp, "Version doesn't match!") - - def test_should_match_on_any_when_element_is_found(self): - self.exp = ( - self.v.start_of_line().any("Q").anything().end_of_line().regex() - ) - six.assertRegex(self, "Query", self.exp, "No match found!") - - def test_should_not_match_on_any_when_element_is_not_found(self): - self.exp = ( - self.v.start_of_line().any("Q").anything().end_of_line().regex() - ) - self.assertNotRegexpMatches("W", self.exp, "I've found it!") - - def test_should_match_when_line_break_present(self): - self.exp = ( - self.v.start_of_line() - .anything() - .line_break() - .anything() - .end_of_line() - .regex() - ) - six.assertRegex(self, "Marco \n Polo", self.exp, "Give me a break!!") - - def test_should_match_when_line_break_and_carriage_return_present(self): - self.exp = ( - self.v.start_of_line() - .anything() - .line_break() - .anything() - .end_of_line() - .regex() - ) - six.assertRegex(self, "Marco \r\n Polo", self.exp, "Give me a break!!") - - def test_should_not_match_when_line_break_is_missing(self): - self.exp = ( - self.v.start_of_line() - .anything() - .line_break() - .anything() - .end_of_line() - .regex() - ) - self.assertNotRegexpMatches( - "Marco Polo", self.exp, "There's a break here!" - ) - - def test_should_match_when_tab_present(self): - self.exp = ( - self.v.start_of_line().anything().tab().end_of_line().regex() - ) - six.assertRegex(self, "One tab only ", self.exp, "No tab here!") - - def test_should_not_match_when_tab_is_missing(self): - self.exp = ( - self.v.start_of_line().anything().tab().end_of_line().regex() - ) - self.assertFalse( - re.match(self.exp, "No tab here"), "There's a tab here!" - ) - - def test_should_match_when_word_present(self): - self.exp = ( - self.v.start_of_line().anything().word().end_of_line().regex() - ) - six.assertRegex(self, "Oneword", self.exp, "Not just a word!") - - def test_not_match_when_two_words_are_present_instead_of_one(self): - self.exp = ( - self.v.start_of_line().anything().tab().end_of_line().regex() - ) - self.assertFalse( - re.match(self.exp, "Two words"), "I've found two of them" - ) - - def test_should_match_when_or_condition_fulfilled(self): - self.exp = ( - self.v.start_of_line() - .anything() - .find("G") - .OR() - .find("h") - .end_of_line() - .regex() - ) - six.assertRegex(self, "Github", self.exp, "Octocat not found") - - def test_should_not_match_when_or_condition_not_fulfilled(self): - self.exp = ( - self.v.start_of_line() - .anything() - .find("G") - .OR() - .find("h") - .end_of_line() - .regex() - ) - self.assertFalse(re.match(self.exp, "Bitbucket"), "Bucket not found") - - def test_should_match_on_upper_case_when_lower_case_is_given_and_any_case_is_true( - self - ): - self.exp = ( - self.v.start_of_line() - .find("THOR") - .end_of_line() - .with_any_case(True) - .regex() - ) - six.assertRegex(self, "thor", self.exp, "Upper case Thor, please!") - - def test_should_match_multiple_lines(self): - self.exp = ( - self.v.start_of_line() - .anything() - .find("Pong") - .anything() - .end_of_line() - .search_one_line(True) - .regex() - ) - six.assertRegex( - self, "Ping \n Pong \n Ping", self.exp, "Pong didn't answer" - ) - - def test_should_match_email_address(self): - self.exp = ( - self.v.start_of_line() - .word() - .then("@") - .word() - .then(".") - .word() - .end_of_line() - .regex() - ) - six.assertRegex(self, "mail@mail.com", self.exp, "Not a valid email") - - def test_should_match_url(self): - self.exp = ( - self.v.start_of_line() - .then("http") - .maybe("s") - .then("://") - .maybe("www.") - .word() - .then(".") - .word() - .maybe("/") - .end_of_line() - .regex() - ) - six.assertRegex( - self, "https://www.google.com/", self.exp, "Not a valid email" - ) diff --git a/verbalexpressions/__init__.py b/verbalexpressions/__init__.py deleted file mode 100644 index bc28e0a..0000000 --- a/verbalexpressions/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from verbalexpressions.verbal_expressions import VerEx, re_escape diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py deleted file mode 100644 index c1a22c8..0000000 --- a/verbalexpressions/verbal_expressions.py +++ /dev/null @@ -1,133 +0,0 @@ -import re - - -def re_escape(fn): - def arg_escaped(this, *args): - t = [isinstance(a, VerEx) and a.s or re.escape(str(a)) for a in args] - return fn(this, *t) - - return arg_escaped - - -class VerEx(object): - """ - --- VerbalExpressions class --- - the following methods behave different from the original js lib! - - - end_of_line - - start_of_line - - or - when you say you want `$`, `^` and `|`, we just insert it right there. - No other tricks. - - And any string you inserted will be automatically grouped - except `tab` and `add`. - """ - - def __init__(self): - self.s = [] - self.modifiers = {"I": 0, "M": 0, "A": 0} - - def __getattr__(self, attr): - """ any other function will be sent to the regex object """ - regex = self.regex() - return getattr(regex, attr) - - def __str__(self): - return "".join(self.s) - - def add(self, value): - if isinstance(value, list): - self.s.extend(value) - else: - self.s.append(value) - return self - - def regex(self): - """ get a regular expression object. """ - return re.compile( - str(self), - self.modifiers["I"] | self.modifiers["M"] | self.modifiers["A"], - ) - - compile = regex - - def source(self): - """ return the raw string """ - return str(self) - - raw = value = source - - # --------------------------------------------- - - def anything(self): - return self.add("(.*)") - - @re_escape - def anything_but(self, value): - return self.add("([^%s]*)" % value) - - def end_of_line(self): - return self.add("$") - - @re_escape - def maybe(self, value): - return self.add("(%s)?" % value) - - def start_of_line(self): - return self.add("^") - - @re_escape - def find(self, value): - return self.add("(%s)" % value) - - then = find - - # special characters and groups - - @re_escape - def any(self, value): - return self.add("([%s])" % value) - - any_of = any - - def line_break(self): - return self.add(r"(\n|(\r\n))") - - br = line_break - - @re_escape - def range(self, *args): - from_tos = [args[i : i + 2] for i in range(0, len(args), 2)] - return self.add("([%s])" % "".join(["-".join(i) for i in from_tos])) - - def tab(self): - return self.add(r"\t") - - def word(self): - return self.add(r"(\w+)") - - def OR(self, value=None): - """ `or` is a python keyword so we use `OR` instead. """ - self.add("|") - return self.find(value) if value else self - - def replace(self, string, repl): - return self.sub(repl, string) - - # --------------- modifiers ------------------------ - - # no global option. It depends on which method - # you called on the regex object. - - def with_any_case(self, value=False): - self.modifiers["I"] = re.I if value else 0 - return self - - def search_one_line(self, value=False): - self.modifiers["M"] = re.M if value else 0 - return self - - def with_ascii(self, value=False): - self.modifiers["A"] = re.A if value else 0 - return self