ethspecify 0.3.5__tar.gz → 0.3.6__tar.gz

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ethspecify
-Version: 0.3.5
+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.5 → 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.5",
+    version="0.3.6",
     description="A utility for processing Ethereum specification tags.",
     long_description=long_description,
     long_description_content_type="text/markdown",