esp-bool-parser 0.1.0__py3-none-any.whl

esp_bool_parser/__init__.py

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Tools for building ESP-IDF related apps.
+"""
+
+# ruff: noqa: E402
+
+__version__ = '0.1.0'
+
+from .bool_parser import parse_bool_expr, register_addition_attribute
+
+__all__ = [
+    'parse_bool_expr',
+    'register_addition_attribute',
+]

esp_bool_parser/bool_parser.py

@@ -0,0 +1,279 @@
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+import operator
+import os
+import typing as t
+from ast import (
+    literal_eval,
+)
+
+from packaging.version import (
+    Version,
+)
+from pyparsing import (
+    Keyword,
+    Literal,
+    ParseResults,
+    QuotedString,
+    Suppress,
+    Word,
+    alphas,
+    delimitedList,
+    hexnums,
+    infixNotation,
+    nums,
+    opAssoc,
+)
+
+from .utils import (
+    InvalidInput,
+    to_version,
+)
+
+
+class Stmt:
+    """
+    Statement
+    """
+
+    def get_value(self, target: str, config_name: str) -> t.Any:
+        """
+        Lazy calculated. All subclasses of `Stmt` should implement this function.
+
+        :param target: ESP-IDF target
+        :type target: str
+        :param config_name: config name
+        :type target: str
+        :return: the value of the statement
+        """
+        raise NotImplementedError('Please implement this function in sub classes')
+
+
+class ChipAttr(Stmt):
+    """
+    Attributes defined in SOC Header Files and other keywords as followed:
+
+    - IDF_TARGET: target
+    - INCLUDE_DEFAULT: take the default build targets into account or not
+    - IDF_VERSION_MAJOR: major version of ESP-IDF
+    - IDF_VERSION_MINOR: minor version of ESP-IDF
+    - IDF_VERSION_PATCH: patch version of ESP-IDF
+    - CONFIG_NAME: config name defined in the config rules
+    """
+
+    addition_attr: t.Dict[str, t.Callable] = {}
+
+    def __init__(self, t: ParseResults):
+        self.attr: str = t[0]
+
+    def get_value(self, target: str, config_name: str) -> t.Any:
+        if self.attr in self.addition_attr:
+            return self.addition_attr[self.attr](target=target, config_name=config_name)
+
+        if self.attr == 'IDF_TARGET':
+            return target
+
+        if self.attr == 'CONFIG_NAME':
+            return config_name
+
+        if self.attr in os.environ:
+            return os.environ[self.attr]
+
+        from .constants import (
+            IDF_VERSION,
+            IDF_VERSION_MAJOR,
+            IDF_VERSION_MINOR,
+            IDF_VERSION_PATCH,
+        )
+
+        if self.attr == 'IDF_VERSION':
+            return IDF_VERSION
+
+        if self.attr == 'IDF_VERSION_MAJOR':
+            return IDF_VERSION_MAJOR
+
+        if self.attr == 'IDF_VERSION_MINOR':
+            return IDF_VERSION_MINOR
+
+        if self.attr == 'IDF_VERSION_PATCH':
+            return IDF_VERSION_PATCH
+
+        from .soc_header import SOC_HEADERS
+
+        if self.attr in SOC_HEADERS[target]:
+            return SOC_HEADERS[target][self.attr]
+
+        return 0  # default return 0 as false
+
+
+class Integer(Stmt):
+    def __init__(self, t: ParseResults):
+        self.expr: str = t[0]
+
+    def get_value(self, target: str, config_name: str) -> t.Any:  # noqa: ARG002
+        return literal_eval(self.expr)
+
+
+class String(Stmt):
+    def __init__(self, t: ParseResults):
+        self.expr: str = t[0]
+
+    def get_value(self, target: str, config_name: str) -> t.Any:  # noqa: ARG002
+        return literal_eval(f'"{self.expr}"')  # double quotes is swallowed by QuotedString
+
+
+class List_(Stmt):
+    def __init__(self, t: ParseResults):
+        self.expr = t
+
+    def get_value(self, target: str, config_name: str) -> t.Any:
+        return [item.get_value(target, config_name) for item in self.expr]
+
+
+class BoolStmt(Stmt):
+    _OP_DICT = {
+        '==': operator.eq,
+        '!=': operator.ne,
+        '>': operator.gt,
+        '>=': operator.ge,
+        '<': operator.lt,
+        '<=': operator.le,
+        'not in': lambda x, y: x not in y,
+        'in': lambda x, y: x in y,
+    }
+
+    def __init__(self, t: ParseResults):
+        self.left: Stmt = t[0]
+        self.comparison: str = t[1]
+        self.right: Stmt = t[2]
+
+    def get_value(self, target: str, config_name: str) -> t.Any:
+        _l = self.left.get_value(target, config_name)
+        _r = self.right.get_value(target, config_name)
+
+        if self.comparison not in ['in', 'not in']:
+            # will use version comparison if any of the operands is a Version
+            if any(isinstance(x, Version) for x in [_l, _r]):
+                _l = to_version(_l)
+                _r = to_version(_r)
+        else:
+            # use str for "in" and "not in" operator
+            if isinstance(_l, Version):
+                _l = str(_l)
+            if isinstance(_r, Version):
+                _r = str(_r)
+
+        if self.comparison in self._OP_DICT:
+            return self._OP_DICT[self.comparison](_l, _r)
+
+        raise InvalidInput(f'Unsupported comparison operator: "{self.comparison}"')
+
+
+class BoolExpr(Stmt):
+    pass
+
+
+def _and(_l, _r):
+    return _l and _r
+
+
+def _or(_l, _r):
+    return _l or _r
+
+
+class BoolOr(BoolExpr):
+    def __init__(self, res: ParseResults):
+        self.bool_stmts: t.List[BoolStmt] = []
+        for stmt in res[0]:
+            if stmt != 'or':
+                self.bool_stmts.append(stmt)
+
+    def get_value(self, target: str, config_name: str) -> t.Any:
+        for stmt in self.bool_stmts:
+            if stmt.get_value(target, config_name):
+                return True
+        return False
+
+
+class BoolAnd(BoolExpr):
+    def __init__(self, res: ParseResults):
+        self.bool_stmts: t.List[BoolStmt] = []
+        for stmt in res[0]:
+            if stmt != 'and':
+                self.bool_stmts.append(stmt)
+
+    def get_value(self, target: str, config_name: str) -> t.Any:
+        for stmt in self.bool_stmts:
+            if not stmt.get_value(target, config_name):
+                return False
+        return True
+
+
+CAP_WORD = Word(alphas.upper(), nums + alphas.upper() + '_').setParseAction(ChipAttr)
+
+DECIMAL_NUMBER = Word(nums)
+HEX_NUMBER = Literal('0x') + Word(hexnums)
+INTEGER = (HEX_NUMBER | DECIMAL_NUMBER).setParseAction(Integer)
+
+STRING = QuotedString('"').setParseAction(String)
+
+LIST = Suppress('[') + delimitedList(INTEGER | STRING).setParseAction(List_) + Suppress(']')
+
+BOOL_OPERAND = CAP_WORD | INTEGER | STRING | LIST
+
+EQ = Keyword('==').setParseAction(lambda t: t[0])
+NE = Keyword('!=').setParseAction(lambda t: t[0])
+LE = Keyword('<=').setParseAction(lambda t: t[0])
+LT = Keyword('<').setParseAction(lambda t: t[0])
+GE = Keyword('>=').setParseAction(lambda t: t[0])
+GT = Keyword('>').setParseAction(lambda t: t[0])
+NOT_IN = Keyword('not in').setParseAction(lambda t: t[0])
+IN = Keyword('in').setParseAction(lambda t: t[0])
+
+BOOL_STMT = BOOL_OPERAND + (EQ | NE | LE | LT | GE | GT | NOT_IN | IN) + BOOL_OPERAND
+BOOL_STMT.setParseAction(BoolStmt)
+
+AND = Keyword('and')
+OR = Keyword('or')
+
+BOOL_EXPR = infixNotation(
+    BOOL_STMT,
+    [
+        (AND, 2, opAssoc.LEFT, BoolAnd),
+        (OR, 2, opAssoc.LEFT, BoolOr),
+    ],
+)
+
+
+def register_addition_attribute(attr: str, action: t.Callable[..., t.Any]) -> None:
+    """
+    Register an additional attribute for ChipAttr.
+
+    :param attr: The name of the additional attribute (string).
+    :param action: A callable that processes **kwargs. The `target` and `config_name`
+                   parameters will be passed as kwargs when the attribute is detected.
+    """
+    ChipAttr.addition_attr[attr] = action
+
+
+def parse_bool_expr(stmt: str) -> BoolStmt:
+    """
+    Parse a boolean expression.
+
+    :param stmt: A string containing the boolean expression.
+    :return: A `BoolStmt` object representing the parsed expression.
+
+    .. note::
+
+        You can use this function to parse a boolean expression and evaluate its value based on the given context.
+        For example:
+
+        .. code:: python
+
+           stmt_string = 'IDF_TARGET == "esp32"'
+           stmt: BoolStmt = parse_bool_expr(stmt_string)
+           value = stmt.get_value("esp32", "config_name")
+           print(value)
+           # Output: True
+    """
+    return BOOL_EXPR.parseString(stmt)[0]

esp_bool_parser/constants.py

@@ -0,0 +1,61 @@
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib
+import logging
+import os
+import re
+import sys
+import typing as t
+
+from .utils import (
+    to_version,
+)
+
+LOGGER = logging.getLogger(__name__)
+
+_idf_env = os.getenv('IDF_PATH') or ''
+if not _idf_env:
+    LOGGER.warning('IDF_PATH environment variable is not set. Entering test mode...')
+    LOGGER.warning('- Setting IDF_PATH to current directory...')
+IDF_PATH = os.path.abspath(_idf_env)
+
+
+_idf_py_actions = os.path.join(IDF_PATH, 'tools', 'idf_py_actions')
+sys.path.append(_idf_py_actions)
+try:
+    _idf_py_constant_py = importlib.import_module('constants')
+except ModuleNotFoundError:
+    LOGGER.warning(
+        '- Set supported/preview targets to empty list... (ESP-IDF constants.py module not found under %s)',
+        _idf_py_actions,
+    )
+    _idf_py_constant_py = object()  # type: ignore
+SUPPORTED_TARGETS = getattr(_idf_py_constant_py, 'SUPPORTED_TARGETS', [])
+PREVIEW_TARGETS = getattr(_idf_py_constant_py, 'PREVIEW_TARGETS', [])
+ALL_TARGETS = SUPPORTED_TARGETS + PREVIEW_TARGETS
+
+
+def _idf_version_from_cmake() -> t.Tuple[int, int, int]:
+    version_path = os.path.join(IDF_PATH, 'tools', 'cmake', 'version.cmake')
+    if not os.path.isfile(version_path):
+        LOGGER.warning('- Setting ESP-IDF version to 1.0.0... (ESP-IDF version.cmake not exists at %s)', version_path)
+        return 1, 0, 0
+
+    regex = re.compile(r'^\s*set\s*\(\s*IDF_VERSION_([A-Z]{5})\s+(\d+)')
+    ver = {}
+    try:
+        with open(version_path) as f:
+            for line in f:
+                m = regex.match(line)
+
+                if m:
+                    ver[m.group(1)] = m.group(2)
+
+        return int(ver['MAJOR']), int(ver['MINOR']), int(ver['PATCH'])
+    except (KeyError, OSError):
+        raise ValueError(f'Cannot find ESP-IDF version in {version_path}')
+
+
+IDF_VERSION_MAJOR, IDF_VERSION_MINOR, IDF_VERSION_PATCH = _idf_version_from_cmake()
+IDF_VERSION = to_version(f'{IDF_VERSION_MAJOR}.{IDF_VERSION_MINOR}.{IDF_VERSION_PATCH}')

esp_bool_parser/soc_header.py

@@ -0,0 +1,141 @@
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+import logging
+import os.path
+import typing as t
+from pathlib import (
+    Path,
+)
+
+from pyparsing import (
+    CaselessLiteral,
+    Char,
+    Combine,
+    Group,
+    Literal,
+    MatchFirst,
+    OneOrMore,
+    Optional,
+    ParseException,
+    ParseResults,
+    QuotedString,
+    Word,
+    alphas,
+    hexnums,
+    nums,
+)
+
+from .constants import (
+    ALL_TARGETS,
+    IDF_PATH,
+)
+
+LOGGER = logging.getLogger(__name__)
+
+# Group for parsing literal suffix of a numbers, e.g. 100UL
+_literal_symbol = Group(CaselessLiteral('L') | CaselessLiteral('U'))
+_literal_suffix = OneOrMore(_literal_symbol)
+
+# Define name
+_name = Word(alphas, alphas + nums + '_')
+
+# Define value, either a hex, int or a string
+_hex_value = Combine(Literal('0x') + Word(hexnums) + Optional(_literal_suffix).suppress())('hex_value')
+_str_value = QuotedString('"')('str_value')
+_int_value = Combine(Optional('-') + Word(nums))('int_value') + ~Char('.') + Optional(_literal_suffix)('literal_suffix')
+
+# Remove optional parenthesis around values
+_value = Optional('(').suppress() + MatchFirst([_hex_value, _str_value, _int_value])('value') + Optional(')').suppress()
+
+_define_expr = '#define' + Optional(_name)('name') + Optional(_value)
+
+
+def get_defines(header_path: str) -> t.List[str]:
+    defines = []
+    LOGGER.debug('Reading macros from %s...', header_path)
+    with open(header_path) as f:
+        output = f.read()
+
+    for line in output.split('\n'):
+        line = line.strip()
+        if len(line):
+            defines.append(line)
+
+    return defines
+
+
+def parse_define(define_line: str) -> ParseResults:
+    res = _define_expr.parseString(define_line)
+
+    return res
+
+
+class SocHeader(dict):
+    CAPS_HEADER_FILEPATTERN = '*_caps.h'
+
+    def __init__(self, target: str) -> None:
+        if target != 'linux':
+            soc_header_dict = self._parse_soc_header(target)
+        else:
+            soc_header_dict = {}
+
+        super().__init__(**soc_header_dict)
+
+    @staticmethod
+    def _get_dirs_from_candidates(candidates: t.List[str]) -> t.List[str]:
+        dirs = []
+        for d in candidates:
+            if not os.path.isdir(d):
+                LOGGER.debug('folder "%s" not found. Skipping...', os.path.abspath(d))
+            else:
+                dirs.append(d)
+
+        return dirs
+
+    @classmethod
+    def _parse_soc_header(cls, target: str) -> t.Dict[str, t.Any]:
+        soc_headers_dirs = cls._get_dirs_from_candidates(
+            [
+                # master c5 mp
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', target, 'mp', 'include', 'soc')),
+                # other branches
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', target, 'include', 'soc')),
+                # release/v4.2
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', 'soc', target, 'include', 'soc')),
+            ]
+        )
+        esp_rom_headers_dirs = cls._get_dirs_from_candidates(
+            [
+                # master c5 mp
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'esp_rom', target, 'mp', target)),
+                # others
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'esp_rom', target)),
+            ]
+        )
+
+        header_files: t.List[str] = []
+        for d in [*soc_headers_dirs, *esp_rom_headers_dirs]:
+            LOGGER.debug('Checking dir %s', d)
+            header_files += [str(p.resolve()) for p in Path(d).glob(cls.CAPS_HEADER_FILEPATTERN)]
+
+        output_dict = {}
+        for f in header_files:
+            LOGGER.debug('Checking header file %s', f)
+            for line in get_defines(f):
+                try:
+                    res = parse_define(line)
+                except ParseException:
+                    LOGGER.debug('Failed to parse: %s', line)
+                    continue
+
+                if 'str_value' in res:
+                    output_dict[res.name] = res.str_value
+                elif 'int_value' in res:
+                    output_dict[res.name] = int(res.int_value)
+                elif 'hex_value' in res:
+                    output_dict[res.name] = int(res.hex_value, 16)
+
+        return output_dict
+
+
+SOC_HEADERS: t.Dict[str, SocHeader] = {target: SocHeader(target) for target in ALL_TARGETS}

esp_bool_parser/utils.py

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+import typing as t
+
+from packaging.version import (
+    Version,
+)
+
+
+class InvalidInput(SystemExit):
+    """Invalid input from user"""
+
+
+class InvalidIfClause(SystemExit):
+    """Invalid if clause in manifest file"""
+
+
+def to_version(s: t.Any) -> Version:
+    if isinstance(s, Version):
+        return s
+
+    try:
+        return Version(str(s))
+    except ValueError:
+        raise InvalidInput(f'Invalid version: {s}')

esp_bool_parser-0.1.0.dist-info/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

esp_bool_parser-0.1.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.3
+Name: esp-bool-parser
+Version: 0.1.0
+Summary: Tools for building ESP-IDF related apps.
+Author-email: Fu Hanxi <fuhanxi@espressif.com>
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pyparsing
+Requires-Dist: packaging
+Requires-Dist: sphinx ; extra == "doc"
+Requires-Dist: sphinx-rtd-theme ; extra == "doc"
+Requires-Dist: sphinx_copybutton ; extra == "doc"
+Requires-Dist: myst-parser ; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid ; extra == "doc"
+Requires-Dist: sphinx-argparse ; extra == "doc"
+Requires-Dist: sphinx-tabs ; extra == "doc"
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: pytest-cov ; extra == "test"
+Project-URL: changelog, https://github.com/espressif/esp-bool-parsers/blob/main/CHANGELOG.md
+Project-URL: documentation, https://docs.espressif.com/projects/esp-bool-parser
+Project-URL: homepage, https://github.com/espressif/esp-bool-parser
+Project-URL: repository, https://github.com/espressif/esp-bool-parser
+Provides-Extra: doc
+Provides-Extra: test
+
+# esp-bool-parser
+
+`esp-bool-parser` is a package that provides a way to process boolean statements based on `soc_caps` files in the ESP-IDF.
+
+It helps you locate `soc_headers` files in the ESP-IDF, parse them, and store the parsed values as constants, which are then used in `ChipAttr`.
+
+When you import `esp_bool_parser`, you will gain access to the following functions:
+
+### Key Functions
+
+#### `parse_bool_expr(stmt: str)`
+
+Parses a boolean expression.
+
+- **Parameters:**
+    - `stmt` (str): A string containing the boolean expression.
+
+- **Returns:**
+    - A parsed representation of the boolean expression.
+
+- **Usage Example:**
+
+  ```python
+  stmt_string = 'IDF_TARGET == "esp32"'
+  stmt = parse_bool_expr(stmt_string)
+  result = stmt.get_value("esp32", "config_name")
+  ```
+
+#### `register_addition_attribute(attr: str, action: t.Callable[..., t.Any]) -> None`
+
+Registers an additional attribute for `ChipAttr`.
+
+You can extend the functionality of `ChipAttr` by adding custom handlers for new attributes.
+Use the `register_addition_attribute` function to register additional attributes.
+When these attributes are encountered, the associated handler function will be called.
+Additionally, you can override existing attributes, as the newly registered handler will take priority over the original ones.
+
+- **Parameters:**
+  - `attr` (str): The name of the additional attribute.
+  - `action` (Callable): A callable that processes `**kwargs`. The `target` and `config_name` parameters will be passed as `kwargs` when the attribute is detected.
+
+- **Usage Example:**
+
+  ```python
+  def my_action(target, config_name, **kwargs):
+      # Custom logic to handle the attribute
+      print(f"Processing {target} with {config_name}")
+      return target
+
+  register_addition_attribute("CUSTOM_ATTR", my_action)
+  ```
+

esp_bool_parser-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+esp_bool_parser/__init__.py,sha256=RG4kHKlaRIYMxetf1abfCFxOljS5cSGFNREviYIbDhE,347
+esp_bool_parser/bool_parser.py,sha256=al9fOJyo6o-Kpemy8DXICqeaZtl2zccx6SxF0wrue2s,7750
+esp_bool_parser/constants.py,sha256=PzdTHNzOK08Pg1QnP3UeLZcNiSCEOhXWrhWENN3Nx2Y,2064
+esp_bool_parser/soc_header.py,sha256=A-7nIsHcAKMv7uO6qCPN-BAfoAH8Qjypgg7TxYXXdZo,4368
+esp_bool_parser/utils.py,sha256=WOgVQVg9PajUIsp0njV2AZ334zf9mcbINQBBobA0Sz4,526
+esp_bool_parser-0.1.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+esp_bool_parser-0.1.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+esp_bool_parser-0.1.0.dist-info/METADATA,sha256=V5oRhsv2tKn9kXsSMk5QtXo5UrAK_FSuTUEOR4WU_yg,3264
+esp_bool_parser-0.1.0.dist-info/RECORD,,

esp_bool_parser-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.10.1
+Root-Is-Purelib: true
+Tag: py3-none-any