ethspecify 0.2.4__py3-none-any.whl → 0.3.2__py3-none-any.whl

ethspecify/cli.py

@@ -3,11 +3,11 @@ import json
 import os
 import sys
 
-from .core import grep, replace_spec_tags, get_pyspec, get_latest_fork, get_spec_item_history, load_config, run_checks
+from .core import grep, replace_spec_tags, get_pyspec, get_latest_fork, get_spec_item_history, load_config, run_checks, sort_specref_yaml, generate_specref_files, get_yaml_filename_for_spec_attr, get_spec_attr_and_name, add_missing_entries_to_yaml
 
 
 def process(args):
-    """Process all spec tags."""
+    """Process all spec tags and sort specref YAML files."""
     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.")
@@ -16,23 +16,57 @@ def process(args):
     # Load config once from the project directory
     config = load_config(project_dir)
 
+    # Check if auto_add_missing_entries and auto_standardize_names are enabled
+    specrefs_config = config.get('specrefs', {})
+    if isinstance(specrefs_config, dict):
+        auto_add_missing = specrefs_config.get('auto_add_missing_entries', False)
+        auto_standardize_names = specrefs_config.get('auto_standardize_names', False)
+        specrefs_files = specrefs_config.get('files', [])
+    elif isinstance(specrefs_config, list):
+        auto_add_missing = False
+        auto_standardize_names = False
+        specrefs_files = specrefs_config
+    else:
+        auto_add_missing = False
+        auto_standardize_names = False
+        specrefs_files = []
+
+    # Process spec tags in files
     for f in grep(project_dir, r"<spec\b.*?>", args.exclude):
         print(f"Processing file: {f}")
         replace_spec_tags(f, config)
 
+    # Add missing spec items to YAML files if enabled
+    if auto_add_missing:
+        from .core import add_missing_spec_items_to_yaml_files
+        add_missing_spec_items_to_yaml_files(project_dir, config, specrefs_files)
+
+    # Update entry names to <spec_item>#<fork> format if enabled
+    if auto_standardize_names:
+        from .core import update_entry_names_in_yaml_files
+        update_entry_names_in_yaml_files(project_dir, specrefs_files)
+
+    # Sort specref YAML files if they exist in config
+    for yaml_file in specrefs_files:
+        yaml_path = os.path.join(project_dir, yaml_file)
+        if os.path.exists(yaml_path):
+            if not sort_specref_yaml(yaml_path):
+                print(f"Error sorting: {yaml_file}")
+
     return 0
 
 
 def list_tags(args):
     """List all available tags with their fork history."""
     preset = getattr(args, 'preset', 'mainnet')
-    return _list_tags_with_history(args, preset)
+    version = getattr(args, 'version', 'nightly')
+    return _list_tags_with_history(args, preset, version)
 
 
-def _list_tags_with_history(args, preset):
+def _list_tags_with_history(args, preset, version):
     """List all tags with their fork history."""
     try:
-        history = get_spec_item_history(preset)
+        history = get_spec_item_history(preset, version)
     except ValueError as e:
         print(f"Error: {e}")
         return 1
@@ -89,30 +123,36 @@ def check(args):
     total_source_files = {"valid": 0, "total": 0}
 
     for section_name, section_results in results.items():
-        # Determine the type prefix from section name
-        if "Config Variables" in section_name:
-            type_prefix = "config_var"
-        elif "Preset Variables" in section_name:
-            type_prefix = "preset_var"
-        elif "Ssz Objects" in section_name:
-            type_prefix = "ssz_object"
-        elif "Dataclasses" in section_name:
-            type_prefix = "dataclass"
-        else:
-            type_prefix = section_name.lower().replace(" ", "_")
-
         # Collect source file errors
         source = section_results['source_files']
         total_source_files["valid"] += source["valid"]
         total_source_files["total"] += source["total"]
         all_errors.extend(source["errors"])
 
-        # Collect missing items with type prefix
+        # Collect missing items
         coverage = section_results['coverage']
         total_coverage["found"] += coverage["found"]
         total_coverage["expected"] += coverage["expected"]
-        for missing in coverage['missing']:
-            all_missing.append(f"MISSING: {type_prefix}.{missing}")
+
+        # For Project Coverage, items already have the proper prefix
+        if section_name == "Project Coverage":
+            for missing in coverage['missing']:
+                all_missing.append(f"MISSING: {missing}")
+        else:
+            # Determine the type prefix from section name for YAML-based checks
+            if "Config Variables" in section_name:
+                type_prefix = "config_var"
+            elif "Preset Variables" in section_name:
+                type_prefix = "preset_var"
+            elif "Ssz Objects" in section_name:
+                type_prefix = "ssz_object"
+            elif "Dataclasses" in section_name:
+                type_prefix = "dataclass"
+            else:
+                type_prefix = section_name.lower().replace(" ", "_")
+
+            for missing in coverage['missing']:
+                all_missing.append(f"MISSING: {type_prefix}.{missing}")
 
     # Display only errors and missing items
     for error in all_errors:
@@ -159,6 +199,28 @@ def list_forks(args):
     return 0
 
 
+def init(args):
+    """Initialize a specrefs directory with basic configuration and empty source mappings."""
+    output_dir = args.path or "specrefs"
+    version = args.version
+
+    # Check if output directory already exists
+    if os.path.exists(output_dir):
+        print(f"Error: directory {repr(output_dir)} already exists.")
+        print("Please specify a different directory or remove the existing one.")
+        return 1
+
+    try:
+        # Generate the specref files
+        print(f"Initializing specrefs directory: {version}")
+        generate_specref_files(output_dir, version, "mainnet")
+        print(f"Successfully created specrefs directory at: {output_dir}")
+        return 0
+    except Exception as e:
+        print(f"Error: {e}")
+        return 1
+
+
 def main():
     parser = argparse.ArgumentParser(
         description="Process files containing <spec> tags."
@@ -199,6 +261,12 @@ def main():
         help="Filter tags by search term",
         default=None,
     )
+    list_tags_parser.add_argument(
+        "--version",
+        type=str,
+        help="Specification version to use (default: nightly)",
+        default="nightly",
+    )
 
     # Parser for 'check' command
     check_parser = subparsers.add_parser("check", help="Check spec reference coverage and validity")
@@ -227,6 +295,21 @@ def main():
         help="Output format (text or json)",
     )
 
+    # Parser for 'init' command
+    init_parser = subparsers.add_parser("init", help="Initialize a specrefs directory")
+    init_parser.set_defaults(func=init)
+    init_parser.add_argument(
+        "version",
+        type=str,
+        help="Specification version (e.g., 'nightly' or 'v1.6.0-alpha.5')",
+    )
+    init_parser.add_argument(
+        "--path",
+        type=str,
+        help="Output directory for specrefs (default: specrefs)",
+        default="specrefs",
+    )
+
     # Default to 'process' if no args are provided
     if len(sys.argv) == 1:
         sys.argv.insert(1, "process")