ethspecify 0.3.4__tar.gz → 0.3.6__tar.gz

{ethspecify-0.3.4 → ethspecify-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.3.4
+Version: 0.3.6
 Summary: A utility for processing Ethereum specification tags.
 Home-page: https://github.com/jtraglia/ethspecify
 Author: Justin Traglia
@@ -184,11 +184,11 @@ def is_fully_withdrawable_validator(validator: Validator, balance: Gwei, epoch:
 
 ### `link`
 
-This style displays a GitHub link to the specification item.
+This style displays an ethspec.tools link to the specification item.
 
 ```
 <spec fn="apply_pending_deposit" fork="electra" style="link" hash="83ee9126">
-https://github.com/ethereum/consensus-specs/blob/dev/specs/electra/beacon-chain.md#new-apply_pending_deposit
+https://ethspec.tools/#specs/v1.7.0-alpha.1/functions-apply_pending_deposit-electra
 </spec>
 ```
 

{ethspecify-0.3.4 → ethspecify-0.3.6}/README.md

@@ -158,11 +158,11 @@ def is_fully_withdrawable_validator(validator: Validator, balance: Gwei, epoch:
 
 ### `link`
 
-This style displays a GitHub link to the specification item.
+This style displays an ethspec.tools link to the specification item.
 
 ```
 <spec fn="apply_pending_deposit" fork="electra" style="link" hash="83ee9126">
-https://github.com/ethereum/consensus-specs/blob/dev/specs/electra/beacon-chain.md#new-apply_pending_deposit
+https://ethspec.tools/#specs/v1.7.0-alpha.1/functions-apply_pending_deposit-electra
 </spec>
 ```
 

{ethspecify-0.3.4 → ethspecify-0.3.6}/ethspecify/cli.py

@@ -3,7 +3,7 @@ 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, sort_specref_yaml, generate_specref_files, get_yaml_filename_for_spec_attr, get_spec_attr_and_name, add_missing_entries_to_yaml
+from .core import grep, replace_spec_tags, get_pyspec, get_spec_item_history, load_config, run_checks, sort_specref_yaml, generate_specref_files
 
 
 def process(args):

{ethspecify-0.3.4 → ethspecify-0.3.6}/ethspecify/core.py

@@ -11,7 +11,7 @@ import tokenize
 import yaml
 
 
-def validate_exception_items(exceptions, version):
+def validate_exception_items(exceptions, version, require_exceptions_have_fork=False):
     """
     Validate that exception items actually exist in the spec.
     Raises an exception if any item doesn't exist.
@@ -69,6 +69,9 @@ def validate_exception_items(exceptions, version):
                 # If no fork specified, we'll check if it exists in any fork
                 item_name = item
                 fork = None
+                if require_exceptions_have_fork:
+                    errors.append(f"invalid key: {exception_key}.{item_name} (missing fork)")
+                    continue
 
             # Check if the item exists
             item_found = False
@@ -116,14 +119,19 @@ def load_config(directory=None):
                 # Get version from config, default to 'nightly'
                 version = config.get('version', 'nightly')
 
+                specrefs_require = False
+                if 'specrefs' in config and isinstance(config['specrefs'], dict):
+                    specrefs_require = config['specrefs'].get('require_exceptions_have_fork', False)
+                require_exceptions_have_fork = config.get('require_exceptions_have_fork', False) or specrefs_require
+
                 # Validate exceptions in root config
                 if 'exceptions' in config:
-                    validate_exception_items(config['exceptions'], version)
+                    validate_exception_items(config['exceptions'], version, require_exceptions_have_fork)
 
                 # Also validate exceptions in specrefs section if present
                 if 'specrefs' in config and isinstance(config['specrefs'], dict):
                     if 'exceptions' in config['specrefs']:
-                        validate_exception_items(config['specrefs']['exceptions'], version)
+                        validate_exception_items(config['specrefs']['exceptions'], version, require_exceptions_have_fork)
 
                 return config
         except (yaml.YAMLError, IOError) as e:
@@ -227,14 +235,6 @@ def diff(a_name, a_content, b_name, b_content):
     return "\n".join(diff)
 
 
-@functools.lru_cache()
-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(version="nightly"):
     url = f"https://raw.githubusercontent.com/jtraglia/ethspecify/main/pyspec/{version}/pyspec.json"
@@ -555,23 +555,39 @@ def get_spec_item(attributes, config=None):
                 raise Exception("there is no previous spec for this")
         return diff(previous_fork, strip_comments(previous_spec), fork, strip_comments(spec))
     if style == "link":
-        if "function" in attributes or "fn" in attributes:
-            if "function" in attributes and "fn" in attributes:
-                raise Exception(f"cannot contain 'function' and 'fn'")
-            if "function" in attributes:
-                function_name = attributes["function"]
-            else:
-                function_name = attributes["fn"]
-            for key, value in get_links(version).items():
-                if fork in key and key.endswith(function_name):
-                    return value
-            return "Could not find link"
-        else:
+        link = build_spec_link(attributes, fork, version)
+        if link is None:
             return "Not available for this type of spec"
+        return link
     else:
         raise Exception("invalid style type")
 
 
+def build_spec_link(attributes, fork, version):
+    base = f"https://ethspec.tools/#specs/{version}"
+    if "function" in attributes or "fn" in attributes:
+        if "function" in attributes and "fn" in attributes:
+            raise Exception(f"cannot contain 'function' and 'fn'")
+        function_name = attributes.get("function", attributes.get("fn"))
+        return f"{base}/functions-{function_name}-{fork}"
+    if "constant_var" in attributes:
+        return f"{base}/constant_vars-{attributes['constant_var']}-{fork}"
+    if "preset_var" in attributes:
+        return f"{base}/preset_vars-{attributes['preset_var']}-{fork}"
+    if "config_var" in attributes:
+        return f"{base}/config_vars-{attributes['config_var']}-{fork}"
+    if "custom_type" in attributes:
+        return f"{base}/custom_types-{attributes['custom_type']}-{fork}"
+    if "ssz_object" in attributes or "container" in attributes:
+        if "ssz_object" in attributes and "container" in attributes:
+            raise Exception(f"cannot contain 'ssz_object' and 'container'")
+        object_name = attributes.get("ssz_object", attributes.get("container"))
+        return f"{base}/ssz_objects-{object_name}-{fork}"
+    if "dataclass" in attributes:
+        return f"{base}/dataclasses-{attributes['dataclass']}-{fork}"
+    return None
+
+
 def extract_attributes(tag):
     attr_pattern = re.compile(r'(\w+)="(.*?)"')
     return dict(attr_pattern.findall(tag))
@@ -1798,6 +1814,31 @@ def add_missing_spec_items_to_yaml_files(project_dir, config, specrefs_files):
     """
     version = config.get('version', 'nightly')
     preset = 'mainnet'  # Could make this configurable
+    specrefs_config = config.get('specrefs', {})
+
+    # Resolve exceptions (support root or specrefs section, but not both)
+    if isinstance(specrefs_config, list):
+        exceptions = config.get('exceptions', {})
+    else:
+        specrefs_exceptions = specrefs_config.get('exceptions', {})
+        root_exceptions = config.get('exceptions', {})
+        if specrefs_exceptions and root_exceptions:
+            print("Warning: Exceptions found in both root and specrefs sections. Using specrefs exceptions.")
+            exceptions = specrefs_exceptions
+        elif specrefs_exceptions:
+            exceptions = specrefs_exceptions
+        else:
+            exceptions = root_exceptions
+
+    category_exception_keys = {
+        'ssz_objects': ['ssz_objects', 'ssz_object', 'containers', 'container'],
+        'config_vars': ['configs', 'config_variables', 'config_var'],
+        'preset_vars': ['presets', 'preset_variables', 'preset_var'],
+        'dataclasses': ['dataclasses', 'dataclass'],
+        'functions': ['functions', 'fn'],
+        'constant_vars': ['constants', 'constant_variables', 'constant_var'],
+        'custom_types': ['custom_types', 'custom_type']
+    }
 
     # Get all spec items
     pyspec = get_pyspec(version)
@@ -1830,6 +1871,14 @@ def add_missing_spec_items_to_yaml_files(project_dir, config, specrefs_files):
             continue
 
         category, spec_attr = filename_to_category[yaml_basename]
+        type_exceptions = []
+        if isinstance(exceptions, dict) and category in category_exception_keys:
+            for key in category_exception_keys[category]:
+                if key in exceptions:
+                    type_exceptions = exceptions[key]
+                    break
+        if type_exceptions and not isinstance(type_exceptions, list):
+            type_exceptions = [type_exceptions]
 
         # Collect all items in this category organized by name and fork
         items_by_name = {}
@@ -1885,6 +1934,17 @@ def add_missing_spec_items_to_yaml_files(project_dir, config, specrefs_files):
                     versions.append((fork, item_data, spec_content))
                     prev_content = spec_content
 
+            # Skip versions that are excepted for this item
+            if type_exceptions:
+                versions = [
+                    (fork, item_data, spec_content)
+                    for fork, item_data, spec_content in versions
+                    if not is_excepted(item_name, fork, type_exceptions)
+                ]
+
+            if not versions:
+                continue
+
             # Create entries based on number of unique versions
             use_fork_suffix = len(versions) > 1
 

{ethspecify-0.3.4 → ethspecify-0.3.6}/ethspecify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.3.4
+Version: 0.3.6
 Summary: A utility for processing Ethereum specification tags.
 Home-page: https://github.com/jtraglia/ethspecify
 Author: Justin Traglia
@@ -184,11 +184,11 @@ def is_fully_withdrawable_validator(validator: Validator, balance: Gwei, epoch:
 
 ### `link`
 
-This style displays a GitHub link to the specification item.
+This style displays an ethspec.tools link to the specification item.
 
 ```
 <spec fn="apply_pending_deposit" fork="electra" style="link" hash="83ee9126">
-https://github.com/ethereum/consensus-specs/blob/dev/specs/electra/beacon-chain.md#new-apply_pending_deposit
+https://ethspec.tools/#specs/v1.7.0-alpha.1/functions-apply_pending_deposit-electra
 </spec>
 ```
 

{ethspecify-0.3.4 → ethspecify-0.3.6}/setup.py

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