ethspecify 0.1.4__py3-none-any.whl → 0.2.1__py3-none-any.whl

ethspecify/cli.py

@@ -1,34 +1,205 @@
 import argparse
+import json
 import os
+import sys
+
+from .core import grep, replace_spec_tags, get_pyspec, get_latest_fork
+
+
+def process(args):
+    """Process all spec tags."""
+    project_dir = os.path.abspath(os.path.expanduser(args.path))
+    if not os.path.isdir(project_dir):
+        print(f"Error: The directory {repr(project_dir)} does not exist.")
+        return 1
+
+    for f in grep(project_dir, r"<spec\b.*?>", args.exclude):
+        print(f"Processing file: {f}")
+        replace_spec_tags(f)
+
+    return 0
+
+
+def list_tags(args):
+    """List all available tags for a specific fork and preset."""
+    # Get the specification data
+    pyspec = get_pyspec()
+    fork = args.fork
+    preset = args.preset
+
+    # Validate that the fork exists
+    if fork not in pyspec[preset]:
+        print(f"Error: Fork '{fork}' not found in {preset} preset")
+        available_forks = list(pyspec[preset].keys())
+        print(f"Available forks: {', '.join(available_forks)}")
+        return 1
+
+    # Format output based on requested format
+    if args.format == "json":
+        result = {
+            "fork": fork,
+            "preset": preset,
+            "tags": {
+                "functions": list(pyspec[preset][fork]['functions'].keys()),
+                "constant_vars": list(pyspec[preset][fork]['constant_vars'].keys()),
+                "custom_types": list(pyspec[preset][fork]['custom_types'].keys()),
+                "ssz_objects": list(pyspec[preset][fork]['ssz_objects'].keys()),
+                "dataclasses": list(pyspec[preset][fork]['dataclasses'].keys()),
+                "preset_vars": list(pyspec[preset][fork]['preset_vars'].keys()),
+                "config_vars": list(pyspec[preset][fork]['config_vars'].keys()),
+            }
+        }
+        print(json.dumps(result, indent=2))
+    else:
+        # Plain text output
+        print(f"Available tags for {fork} fork ({preset} preset):")
+        maybe_fork = f' fork="{fork}"' if fork != get_latest_fork() else ""
+
+        print("\nFunctions:")
+        for fn_name in sorted(pyspec[preset][fork]['functions'].keys()):
+            if args.search is None or args.search.lower() in fn_name.lower():
+                print(f"  <spec fn=\"{fn_name}\"{maybe_fork} />")
+
+        print("\nConstants:")
+        for const_name in sorted(pyspec[preset][fork]['constant_vars'].keys()):
+            if args.search is None or args.search.lower() in const_name.lower():
+                print(f"  <spec constant_var=\"{const_name}\"{maybe_fork} />")
+
+        print("\nCustom Types:")
+        for type_name in sorted(pyspec[preset][fork]['custom_types'].keys()):
+            if args.search is None or args.search.lower() in type_name.lower():
+                print(f"  <spec custom_type=\"{type_name}\"{maybe_fork} />")
+
+        print("\nSSZ Objects:")
+        for obj_name in sorted(pyspec[preset][fork]['ssz_objects'].keys()):
+            if args.search is None or args.search.lower() in obj_name.lower():
+                print(f"  <spec ssz_object=\"{obj_name}\"{maybe_fork} />")
+
+        print("\nDataclasses:")
+        for class_name in sorted(pyspec[preset][fork]['dataclasses'].keys()):
+            if args.search is None or args.search.lower() in class_name.lower():
+                print(f"  <spec dataclass=\"{class_name}\"{maybe_fork} />")
+
+        print("\nPreset Variables:")
+        for var_name in sorted(pyspec[preset][fork]['preset_vars'].keys()):
+            if args.search is None or args.search.lower() in var_name.lower():
+                print(f"  <spec preset_var=\"{var_name}\"{maybe_fork} />")
+
+        print("\nConfig Variables:")
+        for var_name in sorted(pyspec[preset][fork]['config_vars'].keys()):
+            if args.search is None or args.search.lower() in var_name.lower():
+                print(f"  <spec config_var=\"{var_name}\"{maybe_fork} />")
+
+    return 0
+
+
+def list_forks(args):
+    """List all available forks."""
+    pyspec = get_pyspec()
+    preset = args.preset
+
+    if preset not in pyspec:
+        print(f"Error: Preset '{preset}' not found.")
+        print(f"Available presets: {', '.join(pyspec.keys())}")
+        return 1
+
+    forks = sorted(
+        pyspec[preset].keys(),
+        # Put phase0 at the top & EIP feature forks at the bottom
+        key=lambda x: (x != "phase0", x.startswith("eip"), x)
+    )
+
+    if args.format == "json":
+        result = {
+            "preset": preset,
+            "forks": forks
+        }
+        print(json.dumps(result, indent=2))
+    else:
+        print(f"Available forks for {preset} preset:")
+        for fork in forks:
+            print(f"  {fork}")
+
+    return 0
 
-from .core import grep, replace_spec_tags
 
 def main():
     parser = argparse.ArgumentParser(
         description="Process files containing <spec> tags."
     )
-    parser.add_argument(
+
+    # Create subparsers for different commands
+    subparsers = parser.add_subparsers(dest="command", help="Command to execute")
+
+    # Parser for 'process' command
+    process_parser = subparsers.add_parser("process", help="Process spec tags in files")
+    process_parser.set_defaults(func=process)
+    process_parser.add_argument(
         "--path",
         type=str,
         help="Directory to search for files containing <spec> tags",
         default=".",
     )
-    parser.add_argument(
+    process_parser.add_argument(
         "--exclude",
         action="append",
         help="Exclude paths matching this regex",
         default=[],
     )
-    args = parser.parse_args()
 
-    project_dir = os.path.abspath(os.path.expanduser(args.path))
-    if not os.path.isdir(project_dir):
-        print(f"Error: The directory '{project_dir}' does not exist.")
-        exit(1)
+    # Parser for 'list-tags' command
+    list_tags_parser = subparsers.add_parser("list-tags", help="List available specification tags")
+    list_tags_parser.set_defaults(func=list_tags)
+    list_tags_parser.add_argument(
+        "--fork",
+        type=str,
+        help="Fork to list tags for",
+        default=get_latest_fork(),
+    )
+    list_tags_parser.add_argument(
+        "--preset",
+        type=str,
+        help="Preset to use (mainnet or minimal)",
+        default="mainnet",
+    )
+    list_tags_parser.add_argument(
+        "--format",
+        type=str,
+        choices=["text", "json"],
+        default="text",
+        help="Output format (text or json)",
+    )
+    list_tags_parser.add_argument(
+        "--search",
+        type=str,
+        help="Filter tags by search term",
+        default=None,
+    )
+
+    # Parser for 'list-forks' command
+    list_forks_parser = subparsers.add_parser("list-forks", help="List available forks")
+    list_forks_parser.set_defaults(func=list_forks)
+    list_forks_parser.add_argument(
+        "--preset",
+        type=str,
+        help="Preset to use (mainnet or minimal)",
+        default="mainnet",
+    )
+    list_forks_parser.add_argument(
+        "--format",
+        type=str,
+        choices=["text", "json"],
+        default="text",
+        help="Output format (text or json)",
+    )
+
+    # Default to 'process' if no args are provided
+    if len(sys.argv) == 1:
+        sys.argv.insert(1, "process")
+
+    args = parser.parse_args()
+    exit(args.func(args))
 
-    for f in grep(project_dir, r"<spec\b.*?>", args.exclude):
-        print(f"Processing file: {f}")
-        replace_spec_tags(f)
 
 if __name__ == "__main__":
-    main()
+    main()

ethspecify/core.py

@@ -83,23 +83,23 @@ def diff(a_name, a_content, b_name, b_content):
 
 
 @functools.lru_cache()
-def get_links():
-    url = f"https://raw.githubusercontent.com/jtraglia/ethspecify/main/links.json"
+def get_links(version="nightly"):
+    url = f"https://raw.githubusercontent.com/jtraglia/ethspecify/main/pyspec/{version}/links.json"
     response = requests.get(url)
     response.raise_for_status()
     return response.json()
 
 
 @functools.lru_cache()
-def get_pyspec():
-    url = f"https://raw.githubusercontent.com/jtraglia/ethspecify/main/pyspec.json"
+def get_pyspec(version="nightly"):
+    url = f"https://raw.githubusercontent.com/jtraglia/ethspecify/main/pyspec/{version}/pyspec.json"
     response = requests.get(url)
     response.raise_for_status()
     return response.json()
 
 
-def get_previous_forks(fork):
-    pyspec = get_pyspec()
+def get_previous_forks(fork, version="nightly"):
+    pyspec = get_pyspec(version)
     config_vars = pyspec["mainnet"][fork]["config_vars"]
     previous_forks = ["phase0"]
     for key in config_vars.keys():
@@ -111,8 +111,8 @@ def get_previous_forks(fork):
     return list(reversed(previous_forks))
 
 
-def get_spec(attributes, preset, fork):
-    pyspec = get_pyspec()
+def get_spec(attributes, preset, fork, version="nightly"):
+    pyspec = get_pyspec(version)
     spec = None
     if "function" in attributes or "fn" in attributes:
         if "function" in attributes and "fn" in attributes:
@@ -197,6 +197,16 @@ def get_spec(attributes, preset, fork):
         raise Exception("invalid spec tag")
     return spec
 
+def get_latest_fork(version="nightly"):
+    """A helper function to get the latest non-eip fork."""
+    pyspec = get_pyspec(version)
+    forks = sorted(
+        pyspec["mainnet"].keys(),
+        key=lambda x: (x != "phase0", x.startswith("eip"), x)
+    )
+    for fork in reversed(forks):
+        if not fork.startswith("eip"):
+            return fork
 
 def parse_common_attributes(attributes):
     try:
@@ -204,36 +214,41 @@ def parse_common_attributes(attributes):
     except KeyError:
         preset = "mainnet"
 
+    try:
+        version = attributes["version"]
+    except KeyError:
+        version = "nightly"
+
     try:
         fork = attributes["fork"]
     except KeyError:
-        raise Exception(f"Missing fork attribute")
+        fork = get_latest_fork(version)
 
     try:
         style = attributes["style"]
     except KeyError:
         style = "hash"
 
-    return preset, fork, style
+    return preset, fork, style, version
 
 def get_spec_item(attributes):
-    preset, fork, style = parse_common_attributes(attributes)
-    spec = get_spec(attributes, preset, fork)
+    preset, fork, style, version = parse_common_attributes(attributes)
+    spec = get_spec(attributes, preset, fork, version)
 
     if style == "full" or style == "hash":
         return spec
     elif style == "diff":
-        previous_forks = get_previous_forks(fork)
+        previous_forks = get_previous_forks(fork, version)
 
         previous_fork = None
         previous_spec = None
         for i, _ in enumerate(previous_forks):
             previous_fork = previous_forks[i]
-            previous_spec = get_spec(attributes, preset, previous_fork)
+            previous_spec = get_spec(attributes, preset, previous_fork, version)
             if previous_spec != "phase0":
                 try:
                     previous_previous_fork = previous_forks[i+1]
-                    previous_previous_spec = get_spec(attributes, preset, previous_previous_fork)
+                    previous_previous_spec = get_spec(attributes, preset, previous_previous_fork, version)
                     if previous_previous_spec == previous_spec:
                         continue
                 except KeyError:
@@ -253,7 +268,7 @@ def get_spec_item(attributes):
                 function_name = attributes["function"]
             else:
                 function_name = attributes["fn"]
-            for key, value in get_links().items():
+            for key, value in get_links(version).items():
                 if fork in key and key.endswith(function_name):
                     return value
             return "Could not find link"
@@ -312,8 +327,8 @@ def replace_spec_tags(file_path):
 
         attributes = extract_attributes(original_tag_text)
         print(f"spec tag: {attributes}")
-        preset, fork, style = parse_common_attributes(attributes)
-        spec = get_spec(attributes, preset, fork)
+        preset, fork, style, version = parse_common_attributes(attributes)
+        spec = get_spec(attributes, preset, fork, version)
         hash_value = hashlib.sha256(spec.encode('utf-8')).hexdigest()[:8]
 
         if style == "hash":

{ethspecify-0.1.4.dist-info → ethspecify-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.1.4
+Version: 0.2.1
 Summary: A utility for processing Ethereum specification tags.
 Home-page: https://github.com/jtraglia/ethspecify
 Author: Justin Traglia
@@ -18,6 +18,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -65,6 +66,20 @@ ethspecify
 
 ## Specification Options
 
+### Version
+
+This attribute specifies which version of the consensus specifications to use. Default is `nightly`.
+
+- `nightly` (default) - Uses the latest nightly build from the master branch
+- `v1.6.0-alpha.2`, `v1.6.0-alpha.3`, etc. - Uses a specific tagged release version
+
+Example:
+```
+/*
+ * <spec fn="apply_deposit" fork="electra" version="v1.6.0-alpha.3" />
+ */
+```
+
 ### Fork
 
 This attribute can be any of the [executable

ethspecify-0.2.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+ethspecify/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ethspecify/cli.py,sha256=73NnY6-xvFcxMnpeZ1LqvU02EiNiPx5jOor1KPERenk,6903
+ethspecify/core.py,sha256=Nu5-onBdtmibdO9FkwZL1gGWjRAvZkTPeWZ0H9v2NoI,13292
+ethspecify-0.2.1.dist-info/licenses/LICENSE,sha256=Awxsr73mm9YMBVhBYnzeI7bNdRd-bH6RDtO5ItG0DaM,1071
+ethspecify-0.2.1.dist-info/METADATA,sha256=qYoT3-9O7b2SbY7mDJrDJo7T--VpjkIJTPrD2Ob03rc,9185
+ethspecify-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ethspecify-0.2.1.dist-info/entry_points.txt,sha256=09viGkCg9J3h0c9BFRN-BKaJUEaIc4JyULNgBP5EL_g,51
+ethspecify-0.2.1.dist-info/top_level.txt,sha256=0klaMvlVyOkXW09fwZTijJpdybITEp2c9zQKV5v30VM,11
+ethspecify-0.2.1.dist-info/RECORD,,

{ethspecify-0.1.4.dist-info → ethspecify-0.2.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ethspecify-0.1.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-ethspecify/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ethspecify/cli.py,sha256=TTKmSGUkuRdYlYS6t-cpVXpdpSKsYCWvmRDy8DcC10E,882
-ethspecify/core.py,sha256=dJnhQpAhNpp_cY_fMj8k_cthXOVW_nagTl2oBZsIDc8,12654
-ethspecify-0.1.4.dist-info/LICENSE,sha256=Awxsr73mm9YMBVhBYnzeI7bNdRd-bH6RDtO5ItG0DaM,1071
-ethspecify-0.1.4.dist-info/METADATA,sha256=bALmnZ4tsQQ4ftX5JlwP06-i-O2jLcXowalbdEHa-2w,8790
-ethspecify-0.1.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ethspecify-0.1.4.dist-info/entry_points.txt,sha256=09viGkCg9J3h0c9BFRN-BKaJUEaIc4JyULNgBP5EL_g,51
-ethspecify-0.1.4.dist-info/top_level.txt,sha256=0klaMvlVyOkXW09fwZTijJpdybITEp2c9zQKV5v30VM,11
-ethspecify-0.1.4.dist-info/RECORD,,