faster-eth-abi 5.2.5__tar.gz → 5.2.6__tar.gz

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: faster_eth_abi
-Version: 5.2.5
-Summary: A fork of eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding, implemented in C.
+Version: 5.2.6
+Summary: A aster fork of eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding. Implemented in C.
 Home-page: https://github.com/BobTheBuidler/faster-eth-abi
 Author: The Ethereum Foundation
 Author-email: snakecharmers@ethereum.org
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.8, <4
 Description-Content-Type: text/markdown
@@ -27,6 +28,20 @@ Provides-Extra: test
 Provides-Extra: tools
 License-File: LICENSE
 
+### I forked eth-abi and compiled it to C. It does the same stuff, now faster
+
+[![PyPI](https://img.shields.io/pypi/v/faster-eth-abi.svg?logo=Python&logoColor=white)](https://pypi.org/project/faster-eth-abi/)
+[![Monthly Downloads](https://img.shields.io/pypi/dm/faster-eth-abi)](https://pypistats.org/packages/faster-eth-abi)
+[![Codspeed.io Status](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/BobTheBuidler/faster-eth-abi)
+
+##### This fork will be kept up-to-date with [eth-abi](https://github.com/ethereum/eth-abi). I will pull updates as they are released and push new [faster-eth-abi](https://github.com/BobTheBuidler/faster-eth-abi) releases to [PyPI](https://pypi.org/project/faster-eth-abi/).
+
+##### You can find the compiled C code on faster-eth-abi [master](https://github.com/BobTheBuidler/eth-abi/tree/master) branch.
+
+##### We benchmark `faster-eth-abi` against the original `eth-abi` for your convenience. [See results](https://github.com/BobTheBuidler/faster-eth-abi/tree/master/benchmarks/results).
+
+##### The original eth-abi readme is below:
+
 # Ethereum Contract Interface (ABI) Utility
 
 [![Join the conversation on Discord](https://img.shields.io/discord/809793915578089484?color=blue&label=chat&logo=discord&logoColor=white)](https://discord.gg/GHryRvPB84)

faster_eth_abi-5.2.6/README.md

@@ -0,0 +1,33 @@
+### I forked eth-abi and compiled it to C. It does the same stuff, now faster
+
+[![PyPI](https://img.shields.io/pypi/v/faster-eth-abi.svg?logo=Python&logoColor=white)](https://pypi.org/project/faster-eth-abi/)
+[![Monthly Downloads](https://img.shields.io/pypi/dm/faster-eth-abi)](https://pypistats.org/packages/faster-eth-abi)
+[![Codspeed.io Status](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/BobTheBuidler/faster-eth-abi)
+
+##### This fork will be kept up-to-date with [eth-abi](https://github.com/ethereum/eth-abi). I will pull updates as they are released and push new [faster-eth-abi](https://github.com/BobTheBuidler/faster-eth-abi) releases to [PyPI](https://pypi.org/project/faster-eth-abi/).
+
+##### You can find the compiled C code on faster-eth-abi [master](https://github.com/BobTheBuidler/eth-abi/tree/master) branch.
+
+##### We benchmark `faster-eth-abi` against the original `eth-abi` for your convenience. [See results](https://github.com/BobTheBuidler/faster-eth-abi/tree/master/benchmarks/results).
+
+##### The original eth-abi readme is below:
+
+# Ethereum Contract Interface (ABI) Utility
+
+[![Join the conversation on Discord](https://img.shields.io/discord/809793915578089484?color=blue&label=chat&logo=discord&logoColor=white)](https://discord.gg/GHryRvPB84)
+[![Build Status](https://circleci.com/gh/ethereum/faster-eth-abi.svg?style=shield)](https://circleci.com/gh/ethereum/faster-eth-abi)
+[![PyPI version](https://badge.fury.io/py/faster-eth-abi.svg)](https://badge.fury.io/py/faster-eth-abi)
+[![Python versions](https://img.shields.io/pypi/pyversions/faster-eth-abi.svg)](https://pypi.python.org/pypi/faster-eth-abi)
+[![Docs build](https://readthedocs.org/projects/faster-eth-abi/badge/?version=latest)](https://faster-eth-abi.readthedocs.io/en/latest/?badge=latest)
+
+Python utilities for working with Ethereum ABI definitions, especially encoding and decoding
+
+Read the [documentation](https://faster-eth-abi.readthedocs.io/).
+
+View the [change log](https://faster-eth-abi.readthedocs.io/en/latest/release_notes.html).
+
+## Installation
+
+```sh
+python -m pip install faster-eth-abi
+```

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/faster_eth_abi/_encoding.py

@@ -72,7 +72,7 @@ def encode_signed(
 def encode_elements(item_encoder: "BaseEncoder", value: Sequence[Any]) -> bytes:
     tail_chunks = tuple(item_encoder(i) for i in value)
 
-    items_are_dynamic = getattr(item_encoder, "is_dynamic", False)
+    items_are_dynamic: bool = getattr(item_encoder, "is_dynamic", False)
     if not items_are_dynamic or len(value) == 0:
         return b"".join(tail_chunks)
 
@@ -91,8 +91,9 @@ def encode_elements_dynamic(item_encoder: "BaseEncoder", value: Sequence[Any]) -
 
 
 def encode_uint_256(i: int) -> bytes:
-    # An optimized version of the `encode_uint_256` in `encoding.py` which does not perform any validation.
-    # We should not have any issues here unless you're encoding really really massive iterables.
+    # An optimized version of the `encode_uint_256` in `encoding.py` which
+    # does not perform any validation. We should not have any issues here
+    # unless you're encoding really really massive iterables.
     big_endian = int_to_big_endian(i)
     return big_endian.rjust(32, b"\x00")
 

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/faster_eth_abi/grammar.py

@@ -458,10 +458,11 @@ def normalize(type_str: TypeStr) -> TypeStr:
     :param type_str: The type string to be normalized.
     :returns: The canonical version of the input type string.
     """
-    return TYPE_ALIAS_RE.sub(
-        lambda match: TYPE_ALIASES[match.group(0)],
-        type_str,
-    )
+    return TYPE_ALIAS_RE.sub(__normalize, type_str)
+
+
+def __normalize(match: re.Match[str]) -> str:
+    return TYPE_ALIASES[match.group(0)]
 
 
 parse: Final = visitor.parse

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/faster_eth_abi.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: faster-eth-abi
-Version: 5.2.5
-Summary: A fork of eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding, implemented in C.
+Version: 5.2.6
+Summary: A aster fork of eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding. Implemented in C.
 Home-page: https://github.com/BobTheBuidler/faster-eth-abi
 Author: The Ethereum Foundation
 Author-email: snakecharmers@ethereum.org
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.8, <4
 Description-Content-Type: text/markdown
@@ -27,6 +28,20 @@ Provides-Extra: test
 Provides-Extra: tools
 License-File: LICENSE
 
+### I forked eth-abi and compiled it to C. It does the same stuff, now faster
+
+[![PyPI](https://img.shields.io/pypi/v/faster-eth-abi.svg?logo=Python&logoColor=white)](https://pypi.org/project/faster-eth-abi/)
+[![Monthly Downloads](https://img.shields.io/pypi/dm/faster-eth-abi)](https://pypistats.org/packages/faster-eth-abi)
+[![Codspeed.io Status](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/BobTheBuidler/faster-eth-abi)
+
+##### This fork will be kept up-to-date with [eth-abi](https://github.com/ethereum/eth-abi). I will pull updates as they are released and push new [faster-eth-abi](https://github.com/BobTheBuidler/faster-eth-abi) releases to [PyPI](https://pypi.org/project/faster-eth-abi/).
+
+##### You can find the compiled C code on faster-eth-abi [master](https://github.com/BobTheBuidler/eth-abi/tree/master) branch.
+
+##### We benchmark `faster-eth-abi` against the original `eth-abi` for your convenience. [See results](https://github.com/BobTheBuidler/faster-eth-abi/tree/master/benchmarks/results).
+
+##### The original eth-abi readme is below:
+
 # Ethereum Contract Interface (ABI) Utility
 
 [![Join the conversation on Discord](https://img.shields.io/discord/809793915578089484?color=blue&label=chat&logo=discord&logoColor=white)](https://discord.gg/GHryRvPB84)

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/faster_eth_abi.egg-info/SOURCES.txt

@@ -32,6 +32,9 @@ faster_eth_abi/utils/numeric.py
 faster_eth_abi/utils/padding.py
 faster_eth_abi/utils/string.py
 faster_eth_abi/utils/validation.py
+scripts/benchmark/compare_benchmark_results.py
+scripts/benchmark/generate_benchmark_markdown.py
+scripts/benchmark/parse_benchmark_output.py
 scripts/release/test_package.py
 tests/core/__init__.py
 tests/core/base.py

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/faster_eth_abi.egg-info/requires.txt

@@ -13,6 +13,8 @@ pre-commit>=3.4.0
 tox>=4.0.0
 twine
 wheel
+pytest-codspeed
+pytest-benchmark
 sphinx>=6.0.0
 sphinx-autobuild>=2021.3.14
 sphinx_rtd_theme>=1.0.0

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/pyproject.toml

@@ -2,7 +2,7 @@
 requires = [
 	"setuptools",
 	"wheel",
-	"mypy[mypyc]>=1.14.1,<1.17.1",
+	"mypy[mypyc]>=1.14.1,<1.18.2",
 	"mypy_extensions",
 	"cchecksum>=0.2.6,<0.4",
  	# pydantic-core (installed with faster-eth-utils) is unable to build on Python3.14

faster_eth_abi-5.2.6/scripts/benchmark/compare_benchmark_results.py

@@ -0,0 +1,101 @@
+"""
+compare_benchmark_results.py
+
+Compares the two implementations in each benchmark group from a pytest-benchmark parsed results JSON file,
+grouped by submodule.
+For each submodule and group (e.g., "abi_to_signature"), finds both implementations
+(e.g., "test_abi_to_signature" and "test_faster_abi_to_signature"), computes the percent change
+in mean execution time, speedup percent, and x factor, and writes a diff JSON file summarizing the results.
+
+Usage:
+    python compare_benchmark_results.py <results.json> [output.json]
+"""
+
+import json
+import re
+import sys
+from typing import (
+    Any,
+    Dict,
+)
+
+
+def get_group_name(test_name: str) -> str:
+    # Extract group from test name, e.g., test_foo, test_faster_foo -> group: foo
+    m = re.match(r"test_faster_(.+)", test_name)
+    if m:
+        return m.group(1)
+    m = re.match(r"test_(.+)", test_name)
+    if m:
+        return m.group(1)
+    return test_name
+
+
+def compare_group(group_results: Dict[str, Any]) -> Dict[str, Any]:
+    # Find reference and faster implementations in the group
+    ref = None
+    fast = None
+    ref_name = None
+    fast_name = None
+    for func_name, data in group_results.items():
+        if func_name.startswith("test_faster_"):
+            fast = data
+            fast_name = func_name
+        elif func_name.startswith("test_"):
+            ref = data
+            ref_name = func_name
+
+    if ref and fast:
+        mean_ref = ref["mean"]
+        mean_fast = fast["mean"]
+        percent_change = (
+            ((mean_ref - mean_fast) / mean_ref) * 100 if mean_ref != 0 else 0.0
+        )
+        speedup_x = mean_ref / mean_fast if mean_fast != 0 else float("inf")
+        speedup_percent = (
+            (speedup_x - 1) * 100 if speedup_x != float("inf") else float("inf")
+        )
+        return {
+            "reference_mean": mean_ref,
+            "faster_mean": mean_fast,
+            "percent_change": percent_change,
+            "speedup_percent": speedup_percent,
+            "speedup_x": speedup_x,
+            "reference": ref_name,
+            "faster": fast_name,
+        }
+    else:
+        missing = []
+        if not ref:
+            missing.append("reference")
+        if not fast:
+            missing.append("faster")
+        return {"note": f"Missing implementation(s): {missing}"}
+
+
+def main() -> None:
+    if len(sys.argv) < 2:
+        print("Usage: python compare_benchmark_results.py <results.json> [output.json]")
+        sys.exit(1)
+    results_path = sys.argv[1]
+    output_path = sys.argv[2] if len(sys.argv) > 2 else "benchmark_diff.json"
+
+    with open(results_path) as f:
+        results = json.load(f)
+
+    # results: {submodule: {group: {function_name: {...}}}}
+    diff_by_submodule = {
+        submodule: {
+            group: compare_group(group_results)
+            for group, group_results in groups.items()
+        }
+        for submodule, groups in results.items()
+    }
+
+    with open(output_path, "w") as f:
+        json.dump(diff_by_submodule, f, indent=2)
+    print(f"Diff written to {output_path}")
+
+
+if __name__ == "__main__":
+    main()

faster_eth_abi-5.2.6/scripts/benchmark/generate_benchmark_markdown.py

@@ -0,0 +1,85 @@
+import json
+import os
+
+
+def main():
+    diff_path = "pytest_benchmark_diff.json"
+    results_dir = os.path.join("benchmarks", "results")
+    os.makedirs(results_dir, exist_ok=True)
+
+    # Get repo and branch info from environment variables (for links)
+    repo = os.environ.get("GITHUB_REPOSITORY", "unknown/unknown")
+    branch = os.environ.get("GITHUB_HEAD_REF") or os.environ.get(
+        "GITHUB_REF", "main"
+    ).replace("refs/heads/", "")
+
+    with open(diff_path, encoding="utf-8") as f:
+        diff = json.load(f)
+
+    for submodule, groupDiffs in diff.items():
+        # Convert submodule name to submodule file path (e.g., faster_eth_abi.encoding -> faster_eth_abi/encoding.py)
+        submoduleFile = "unknown"
+        benchmarkFile = "unknown"
+        m = None
+        if submodule.startswith("faster_eth_abi."):
+            m = submodule[len("faster_eth_abi.") :]
+
+        if m:
+            submoduleFile = f"faster_eth_abi/{m}.py"
+            benchmarkFile = f"benchmarks/test_{m}_benchmarks.py"
+
+        submoduleUrl = f"https://github.com/{repo}/blob/{branch}/{submoduleFile}"
+        benchmarkUrl = f"https://github.com/{repo}/blob/{branch}/{benchmarkFile}"
+
+        md_lines = []
+        md_lines.append(
+            f"#### [{submodule}]({submoduleUrl}) - [view benchmarks]({benchmarkUrl})\n"
+        )
+        md_lines.append(
+            "| Function | Reference Mean | Faster Mean | % Change | Speedup (%) | x Faster | Faster |"
+        )
+        md_lines.append(
+            "|----------|---------------|-------------|----------|-------------|----------|--------|"
+        )
+
+        for group, data in sorted(groupDiffs.items()):
+            if data.get("percent_change") is not None:
+                emoji = "➖"
+                if data["percent_change"] > 0:
+                    emoji = "✅"
+                elif data["percent_change"] < 0:
+                    emoji = "❌"
+                percentChange = (
+                    f"{data['percent_change']:.2f}%"
+                    if data.get("percent_change") is not None
+                    else ""
+                )
+                speedupPercent = (
+                    f"{data['speedup_percent']:.2f}%"
+                    if data.get("speedup_percent") is not None
+                    else ""
+                )
+                speedupX = (
+                    f"{data['speedup_x']:.2f}x"
+                    if data.get("speedup_x") is not None
+                    and isinstance(data["speedup_x"], (int, float))
+                    else ""
+                )
+                md_lines.append(
+                    f"| `{group}` | {data.get('reference_mean', '')} | {data.get('faster_mean', '')} | {percentChange} | {speedupPercent} | {speedupX} | {emoji} |"
+                )
+            elif data.get("note"):
+                md_lines.append(f"| `{group}` |  |  |  |  |  | ➖ |")
+
+        md_lines.append("")  # Blank line at end
+        md_content = "\n".join(md_lines)
+
+        # Write to file
+        module_name = submodule.split(".")[-1]
+        out_path = os.path.join(results_dir, f"{module_name}.md")
+        with open(out_path, "w", encoding="utf-8") as outf:
+            outf.write(md_content)
+
+
+if __name__ == "__main__":
+    main()

faster_eth_abi-5.2.6/scripts/benchmark/parse_benchmark_output.py

@@ -0,0 +1,83 @@
+"""
+parse_benchmark_output.py
+
+Extracts per-function benchmark timings from pytest-benchmark's benchmark.json output.
+Parses the JSON file, finds all test function results, and writes a JSON file
+mapping submodules (e.g., Python submodules like faster_eth_abi.encoding) to groups and their test functions and results.
+
+Usage:
+    python parse_benchmark_output.py <benchmark.json> [output.json]
+"""
+
+from collections import (
+    defaultdict,
+)
+import json
+import re
+import sys
+from typing import (
+    Any,
+    Dict,
+)
+
+
+def get_submodule(bench: dict) -> str:
+    # Extract Python submodule from fullname, e.g., "benchmarks/test_abi_benchmarks.py::test_abi_to_signature"
+    fullname = bench.get("fullname", "")
+    # Try to extract the submodule from the test file path
+    m = re.search(r"benchmarks/test_([a-zA-Z0-9_]+)_benchmarks\.py", fullname)
+    if m:
+        return f"faster_eth_abi.{m.group(1)}"
+    return "unknown"
+
+
+def get_group_name(test_name: str) -> str:
+    # Extract group from test name, e.g., test_foo, test_faster_foo -> group: foo
+    m = re.match(r"test_faster_(.+)", test_name)
+    if m:
+        return m.group(1)
+    m = re.match(r"test_(.+)", test_name)
+    if m:
+        return m.group(1)
+    return test_name
+
+
+def parse_pytest_benchmark_json(data: dict) -> Dict[str, Dict[str, Dict[str, Any]]]:
+    """
+    Parses pytest-benchmark's benchmark.json and extracts per-function timings,
+    grouped by submodule and group name.
+    Returns a dict: {submodule: {group: {function_name: {...}}}}
+    """
+    results = defaultdict(lambda: defaultdict(dict))
+    for bench in data.get("benchmarks", []):
+        name = bench["name"]
+        submodule = get_submodule(bench)
+        group = get_group_name(name)
+        stats = bench["stats"]
+        results[submodule][group][name] = {
+            "mean": stats.get("mean"),
+            "stddev": stats.get("stddev", None),
+            "iqr": stats.get("iqr", None),
+            "min": stats.get("min", None),
+            "max": stats.get("max", None),
+            "rounds": stats.get("rounds", None),
+        }
+    return results
+
+
+def main() -> None:
+    if len(sys.argv) < 2:
+        print("Usage: python parse_benchmark_output.py <benchmark.json> [output.json]")
+        sys.exit(1)
+    infile = sys.argv[1]
+    outfile = sys.argv[2] if len(sys.argv) > 2 else "benchmark_results.json"
+    with open(infile) as f:
+        data = json.load(f)
+    results = parse_pytest_benchmark_json(data)
+    with open(outfile, "w") as f:
+        json.dump(results, f, indent=2)
+    print(f"Parsed results written to {outfile}")
+
+
+if __name__ == "__main__":
+    main()

{faster_eth_abi-5.2.5 → faster_eth_abi-5.2.6}/setup.py

@@ -16,6 +16,8 @@ extras_require = {
         "tox>=4.0.0",
         "twine",
         "wheel",
+        "pytest-codspeed",
+        "pytest-benchmark",
     ],
     "docs": [
         "sphinx>=6.0.0",
@@ -74,8 +76,8 @@ else:
 setup(
     name="faster_eth_abi",
     # *IMPORTANT*: Don't manually change the version here. See Contributing docs for the release process.
-    version="5.2.5",
-    description="""A fork of eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding, implemented in C.""",
+    version="5.2.6",
+    description="""A aster fork of eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding. Implemented in C.""",
     long_description=long_description,
     long_description_content_type="text/markdown",
     author="The Ethereum Foundation",
@@ -110,6 +112,7 @@ setup(
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
         "Programming Language :: Python :: Implementation :: CPython",
     ],
 )

faster_eth_abi-5.2.5/README.md

@@ -1,19 +0,0 @@
-# Ethereum Contract Interface (ABI) Utility
-
-[![Join the conversation on Discord](https://img.shields.io/discord/809793915578089484?color=blue&label=chat&logo=discord&logoColor=white)](https://discord.gg/GHryRvPB84)
-[![Build Status](https://circleci.com/gh/ethereum/faster-eth-abi.svg?style=shield)](https://circleci.com/gh/ethereum/faster-eth-abi)
-[![PyPI version](https://badge.fury.io/py/faster-eth-abi.svg)](https://badge.fury.io/py/faster-eth-abi)
-[![Python versions](https://img.shields.io/pypi/pyversions/faster-eth-abi.svg)](https://pypi.python.org/pypi/faster-eth-abi)
-[![Docs build](https://readthedocs.org/projects/faster-eth-abi/badge/?version=latest)](https://faster-eth-abi.readthedocs.io/en/latest/?badge=latest)
-
-Python utilities for working with Ethereum ABI definitions, especially encoding and decoding
-
-Read the [documentation](https://faster-eth-abi.readthedocs.io/).
-
-View the [change log](https://faster-eth-abi.readthedocs.io/en/latest/release_notes.html).
-
-## Installation
-
-```sh
-python -m pip install faster-eth-abi
-```