ethspecify 0.1.4__tar.gz → 0.2.0__tar.gz

{ethspecify-0.1.4 → ethspecify-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.1.4
+Version: 0.2.0
 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

ethspecify-0.2.0/ethspecify/cli.py

@@ -0,0 +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
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Process files containing <spec> tags."
+    )
+
+    # 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=".",
+    )
+    process_parser.add_argument(
+        "--exclude",
+        action="append",
+        help="Exclude paths matching this regex",
+        default=[],
+    )
+
+    # 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))
+
+
+if __name__ == "__main__":
+    main()

{ethspecify-0.1.4 → ethspecify-0.2.0}/ethspecify/core.py

@@ -197,6 +197,16 @@ def get_spec(attributes, preset, fork):
         raise Exception("invalid spec tag")
     return spec
 
+def get_latest_fork():
+    """A helper function to get the latest non-eip fork."""
+    pyspec = get_pyspec()
+    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:
@@ -207,7 +217,7 @@ def parse_common_attributes(attributes):
     try:
         fork = attributes["fork"]
     except KeyError:
-        raise Exception(f"Missing fork attribute")
+        fork = get_latest_fork()
 
     try:
         style = attributes["style"]

{ethspecify-0.1.4 → ethspecify-0.2.0}/ethspecify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.1.4
+Version: 0.2.0
 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

{ethspecify-0.1.4 → ethspecify-0.2.0}/setup.py

@@ -8,7 +8,7 @@ long_description = (this_directory / "README.md").read_text(encoding="utf-8")
 
 setup(
     name="ethspecify",
-    version="0.1.4",
+    version="0.2.0",
     description="A utility for processing Ethereum specification tags.",
     long_description=long_description,
     long_description_content_type="text/markdown",

ethspecify-0.1.4/ethspecify/cli.py

@@ -1,34 +0,0 @@
-import argparse
-import os
-
-from .core import grep, replace_spec_tags
-
-def main():
-    parser = argparse.ArgumentParser(
-        description="Process files containing <spec> tags."
-    )
-    parser.add_argument(
-        "--path",
-        type=str,
-        help="Directory to search for files containing <spec> tags",
-        default=".",
-    )
-    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)
-
-    for f in grep(project_dir, r"<spec\b.*?>", args.exclude):
-        print(f"Processing file: {f}")
-        replace_spec_tags(f)
-
-if __name__ == "__main__":
-    main()