esp-bool-parser 0.1.0__tar.gz

esp_bool_parser-0.1.0/.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.rst]
+indent_style = space
+indent_size = 3
+
+[*.md]
+indent_style = space
+indent_size = 4

esp_bool_parser-0.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

esp_bool_parser-0.1.0/.github/workflows/check-pre-commit.yml

@@ -0,0 +1,18 @@
+name: pre-commit check
+
+on:
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+      - id: changed-files
+        uses: tj-actions/changed-files@v45
+      - uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --files ${{ steps.changed-files.outputs.all_changed_files }}

esp_bool_parser-0.1.0/.github/workflows/issue_comment.yml

@@ -0,0 +1,20 @@
+name: Sync issue comments to JIRA
+
+# This workflow will be triggered when new issue comment is created (including PR comments)
+on: issue_comment
+
+jobs:
+  sync_issue_comments_to_jira:
+    name: Sync Issue Comments to Jira
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Sync issue comments to JIRA
+        uses: espressif/github-actions/sync_issues_to_jira@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          JIRA_PASS: ${{ secrets.JIRA_PASS }}
+          JIRA_PROJECT: RDT
+          JIRA_COMPONENT: idf-build-apps
+          JIRA_URL: ${{ secrets.JIRA_URL }}
+          JIRA_USER: ${{ secrets.JIRA_USER }}

esp_bool_parser-0.1.0/.github/workflows/new_issues.yml

@@ -0,0 +1,20 @@
+name: Sync issues to Jira
+
+# This workflow will be triggered when a new issue is opened
+on: issues
+
+jobs:
+  sync_issues_to_jira:
+    name: Sync issues to Jira
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Sync GitHub issues to Jira project
+        uses: espressif/github-actions/sync_issues_to_jira@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          JIRA_PASS: ${{ secrets.JIRA_PASS }}
+          JIRA_PROJECT: RDT
+          JIRA_COMPONENT: idf-build-apps
+          JIRA_URL: ${{ secrets.JIRA_URL }}
+          JIRA_USER: ${{ secrets.JIRA_USER }}

esp_bool_parser-0.1.0/.github/workflows/new_prs.yml

@@ -0,0 +1,25 @@
+name: Sync remain PRs to Jira
+
+# This workflow will be triggered every hour, to sync remaining PRs (i.e. PRs with zero comment) to Jira project
+# Note that, PRs can also get synced when new PR comment is created
+on:
+  schedule:
+    - cron: "0 * * * *"
+
+jobs:
+  sync_prs_to_jira:
+    name: Sync PRs to Jira
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Sync PRs to Jira project
+        uses: espressif/github-actions/sync_issues_to_jira@master
+        with:
+          cron_job: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          JIRA_PASS: ${{ secrets.JIRA_PASS }}
+          JIRA_PROJECT: RDT
+          JIRA_COMPONENT: idf-build-apps
+          JIRA_URL: ${{ secrets.JIRA_URL }}
+          JIRA_USER: ${{ secrets.JIRA_USER }}

esp_bool_parser-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,35 @@
+name: Publish PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-22.04
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: pypi
+    permissions:
+      # IMPORTANT: this permission is mandatory for Trusted Publishing
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.7'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flit
+
+      - name: Build package
+        run: flit build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

esp_bool_parser-0.1.0/.github/workflows/test-build-docs.yml

@@ -0,0 +1,25 @@
+name: Test Build Docs
+
+on:
+  pull_request:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.7'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flit
+          flit install -s
+      - name: Build the docs
+        run: |
+          cd docs
+          pushd en && make html && popd
+      - name: markdown-link-check
+        uses: gaurav-nelson/github-action-markdown-link-check@1.0.15

esp_bool_parser-0.1.0/.github/workflows/test-esp-bool-parser.yml

@@ -0,0 +1,52 @@
+name: Test ESP bool parser
+
+on:
+  pull_request:
+    paths:
+      - 'esp_bool_parser/**'
+  push:
+    branches:
+      - main
+
+env:
+  IDF_PATH: /opt/esp/idf
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build-python-packages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.7'
+      - run: |
+          pip install -U pip
+          pip install flit
+          flit build
+      - name: Upload built python packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel
+          path: dist/esp_bool_parser-*.whl
+
+
+  basic-testest:
+    runs-on: ubuntu-latest
+    env:
+      FLIT_ROOT_INSTALL: 1
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build the Apps
+        run: |
+          pip install flit
+          flit install -s
+          pytest --cov esp_bool_parser --cov-report term-missing:skip-covered --junit-xml pytest.xml | tee pytest-coverage.txt
+      - name: Pytest coverage comment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: pytest-coverage.txt
+          junitxml-path: pytest.xml

esp_bool_parser-0.1.0/.gitignore

@@ -0,0 +1,161 @@
+# 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
+
+# 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/
+docs/en/references/api/
+
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.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/

esp_bool_parser-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [ '-f=lf' ]
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: insert-license
+        files: \.py$
+        args:
+          - --license-filepath
+          - license_header.txt        # defaults to: LICENSE.txt
+          - --use-current-year
+        exclude: 'idf_build_apps/vendors/'
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.8.0'
+    hooks:
+      - id: ruff
+        args: ['--fix']
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.13.0'
+    hooks:
+      - id: mypy
+        args: ['--warn-unused-ignores']
+        additional_dependencies:
+          - pydantic<2.6
+          - pydantic-settings
+          - packaging
+          - toml
+          - pyparsing
+          - types-PyYAML
+          - types-toml
+          - pytest
+          - argcomplete>=3
+  - repo: https://github.com/hfudev/rstfmt
+    rev: v0.1.4
+    hooks:
+      - id: rstfmt
+        args: ['-w', '-1']
+        files: "docs\/.+rst$"
+        additional_dependencies:
+          - sphinx-argparse
+          - sphinx-tabs
+          - sphinxcontrib-mermaid

esp_bool_parser-0.1.0/.readthedocs.yml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

esp_bool_parser-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## v0.1.0 (2025-01-02)
+
+### Added
+
+- **`parse_bool_expr`**: A method for handling complex boolean expressions, supporting logical operators like `and` and `or`.
+- **`register_addition_attribute`**: A method for dynamically registering additional attributes with the `ChipAttr` class, enabling custom attribute handling for targets and configurations.

esp_bool_parser-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributions Guide
+
+Hi! We're glad that you're interested in contributing to `esp-bool-parser`. This document would guide you through the process of setting up the development environment, running tests, and building documentation.
+
+## Supported ESP-IDF Versions
+
+Here's a table shows the supported ESP-IDF versions and the corresponding Python versions.
+
+| ESP-IDF Version | ESP-IDF Supported Python Versions | esp-bool-parser Releases |
+|-----------------|-----------------------------------|--------------------------|
+| 5.0             | 3.7+                              | main (0.x)               |
+| 5.1             | 3.7+                              | main (0.x)               |
+| 5.2             | 3.7+                              | main (0.x)               |
+| 5.3             | 3.8+                              | main (0.x)               |
+| 5.4             | 3.8+                              | main (0.x)               |
+| master (5.5)    | 3.9+                              | main (0.x)               |
+
+## Setup the Dev Environment
+
+1. Create virtual environment
+
+    ```shell
+    python -m venv venv
+    ```
+
+2. Activate the virtual environment
+
+    ```shell
+    . ./venv/bin/activate
+    ```
+
+3. Install [flit][flit]
+
+    We use [flit][flit] to build the package and install the dependencies.
+
+    ```shell
+    pip install flit
+    ```
+
+4. Install all dependencies
+
+    All dependencies would be installed, and our package `esp-bool-parser` would be installed with editable mode.
+
+    ```shell
+    flit install -s
+    ```
+
+## Run Testing
+
+We use [pytest][pytest] for testing.
+
+```shell
+pytest
+```
+
+## Build Documentation
+
+We use [sphinx][sphinx] and [autodoc][autodoc] for generating documentation and API references. Besides, we treat warnings as errors while building the documentation. Please fix them before your commits got merged.
+
+```shell
+cd docs/en && make html
+```
+
+For documentation preview, you may use any browser you prefer. The executable has to be searchable in `PATH`. For example we're using firefox here.
+
+```shell
+firefox _build/html/index.html
+```
+
+[flit]: https://flit.pypa.io/en/stable/index.html
+[pytest]: https://docs.pytest.org/en/stable/contents.html
+[sphinx]: https://www.sphinx-doc.org/en/master/
+[autodoc]: https://www.sphinx-doc.org/en/master/usage/quickstart.html#autodoc