ethspecify 0.3.5__tar.gz → 0.3.7__tar.gz

{ethspecify-0.3.5 → ethspecify-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.3.5
+Version: 0.3.7
 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.5 → ethspecify-0.3.7}/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.5 → ethspecify-0.3.7}/ethspecify/core.py

@@ -235,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"
@@ -563,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))
@@ -867,7 +875,7 @@ def load_yaml_entries(yaml_file):
         return []
 
 
-def extract_spec_tag_key(spec_content):
+def extract_spec_tag_key(spec_content, alias_groups=None, alias_preference=None):
     """Extract a unique key from spec tag to identify duplicates."""
     if not spec_content:
         return None
@@ -886,7 +894,14 @@ def extract_spec_tag_key(spec_content):
     for attr in ['fn', 'function', 'constant_var', 'config_var', 'preset_var',
                  'container', 'ssz_object', 'dataclass', 'custom_type']:
         if attr in attributes:
-            key_parts.append(f"{attr}:{attributes[attr]}")
+            normalized_attr = attr
+            if alias_groups:
+                for group_key, aliases in alias_groups.items():
+                    if attr in aliases:
+                        if alias_preference and group_key in alias_preference:
+                            normalized_attr = alias_preference[group_key]
+                        break
+            key_parts.append(f"{normalized_attr}:{attributes[attr]}")
             break
 
     if 'fork' in attributes:
@@ -915,18 +930,40 @@ def add_missing_entries_to_yaml(yaml_file, new_entries):
     # Load existing entries
     existing_entries = load_yaml_entries(yaml_file)
 
+    # Build alias preferences from the first existing entries in the file
+    alias_groups = {
+        'function': ['fn', 'function'],
+        'ssz_object': ['ssz_object', 'container'],
+    }
+    alias_preference = {}
+    for entry in existing_entries:
+        if not isinstance(entry, dict) or 'spec' not in entry:
+            continue
+        spec_content = entry.get('spec', '')
+        match = re.search(r'<spec\b([^>]*)>', spec_content)
+        if not match:
+            continue
+        attributes = extract_attributes(match.group(0))
+        for group_key, aliases in alias_groups.items():
+            if group_key in alias_preference:
+                continue
+            for alias in aliases:
+                if alias in attributes:
+                    alias_preference[group_key] = alias
+                    break
+
     # Build a set of existing spec tag keys
     existing_spec_keys = set()
     for entry in existing_entries:
         if isinstance(entry, dict) and 'spec' in entry:
-            spec_key = extract_spec_tag_key(entry['spec'])
+            spec_key = extract_spec_tag_key(entry['spec'], alias_groups, alias_preference)
             if spec_key:
                 existing_spec_keys.add(spec_key)
 
     # Filter out entries that already exist (based on spec tag, not name)
     entries_to_add = []
     for entry in new_entries:
-        spec_key = extract_spec_tag_key(entry.get('spec', ''))
+        spec_key = extract_spec_tag_key(entry.get('spec', ''), alias_groups, alias_preference)
         if spec_key and spec_key not in existing_spec_keys:
             entries_to_add.append(entry)
             existing_spec_keys.add(spec_key)  # Avoid duplicates within new entries
@@ -1854,6 +1891,10 @@ def add_missing_spec_items_to_yaml_files(project_dir, config, specrefs_files):
         'dataclasses.yml': ('dataclasses', 'dataclass'),
         'types.yml': ('custom_types', 'custom_type'),
     }
+    alias_groups = {
+        'functions': ['fn', 'function'],
+        'ssz_objects': ['container', 'ssz_object'],
+    }
 
     for yaml_file in specrefs_files:
         yaml_path = os.path.join(project_dir, yaml_file)
@@ -1863,6 +1904,26 @@ def add_missing_spec_items_to_yaml_files(project_dir, config, specrefs_files):
             continue
 
         category, spec_attr = filename_to_category[yaml_basename]
+
+        # Prefer the first alias used in the file for this category.
+        if category in alias_groups:
+            existing_entries = load_yaml_entries(yaml_path)
+            preferred_attr = None
+            for entry in existing_entries:
+                if not isinstance(entry, dict) or 'spec' not in entry:
+                    continue
+                match = re.search(r'<spec\b([^>]*)>', entry.get('spec', ''))
+                if not match:
+                    continue
+                attributes = extract_attributes(match.group(0))
+                for alias in alias_groups[category]:
+                    if alias in attributes:
+                        preferred_attr = alias
+                        break
+                if preferred_attr:
+                    break
+            if preferred_attr:
+                spec_attr = preferred_attr
         type_exceptions = []
         if isinstance(exceptions, dict) and category in category_exception_keys:
             for key in category_exception_keys[category]:

{ethspecify-0.3.5 → ethspecify-0.3.7}/ethspecify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.3.5
+Version: 0.3.7
 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.5 → ethspecify-0.3.7}/setup.py

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