ethspecify 0.1.0__tar.gz → 0.1.2__tar.gz

{ethspecify-0.1.0 → ethspecify-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ethspecify
-Version: 0.1.0
+Version: 0.1.2
 Summary: A utility for processing Ethereum specification tags.
 Home-page: https://github.com/jtraglia/ethspecify
 Author: Justin Traglia
@@ -33,81 +33,50 @@ When that happens, they can update the implementations appropriately.
 
 ## Getting Started
 
-### Adding Spec Tags
-
-In your client, add an HTML tag like this:
-
-```
-/*
- * <spec fn="is_fully_withdrawable_validator" fork="deneb">
- */
-```
-
-This supports all languages and comment styles. It preserves indentation, so something like this
-would also work:
-
-```
-/// <spec fn="is_fully_withdrawable_validator" fork="deneb">
-```
-
-After the script is finished executing, a new `hash` field will exist in the tag. This tag is used
-to tell if the specification changed, without having to include the specification content.
-
-```
-/// <spec fn="is_fully_withdrawable_validator" fork="deneb" hash="e936da25" />
-```
-
-> [!NOTE]
-> Closing tags will be added automatically. For `style="hash"` tags, a self-closing tag is used for
-> conciseness. For `style="full"` and `style="diff"` tags, a paired closing tag must be used.
-
 ### Installation
 
-#### Install with Pip
-
 ```
 python3 -mpip install ethspecify
 ```
 
-#### Manual Install
+### Adding Spec Tags
 
-First, clone the repository. You only need the latest commit.
+In your client, add HTML tags like this:
 
 ```
-git clone https://github.com/jtraglia/ethspecify.git --depth=1
-cd ethspecify
+/*
+ * <spec fn="is_fully_withdrawable_validator" fork="deneb">
+ */
 ```
 
-Next, build and install the utility.
-
 ```
-python3 -mpip install .
+/*
+ * <spec ssz_object="BeaconState" fork="electra" style="diff">
+ */
 ```
 
-Then, change directory to the source source directory and run `ethspecify`.
+### Populating Spec Tags
+
+Then, navigate to your codebase and run `ethspecify`:
 
 ```
-Projects/client$ ethspecify
-Processing file: /Users/user/Projects/client/src/file.ext
-spec tag: {'custom_type': 'Blob', 'fork': 'electra'}
-spec tag: {'dataclass': 'PayloadAttributes', 'fork': 'electra'}
-spec tag: {'ssz_object': 'ConsolidationRequest', 'fork': 'electra'}
+ethspecify
 ```
 
-### Specification Options
+## Specification Options
 
-#### Fork
+### Fork
 
 This attribute can be any of the [executable
 specifications](https://github.com/ethereum/consensus-specs/blob/e6bddd966214a19d2b97199bbe3c02577a22a8b4/Makefile#L3-L15)
 in the consensus-specs. At the time of writing, these are: phase0, altair, bellatrix, capella,
 deneb, electra, fulu, whisk, eip6800, and eip7732.
 
-#### Style
+### Style
 
 This attribute can be used to change how the specification content is shown.
 
-##### `hash` (default)
+#### `hash` (default)
 
 This style adds a hash of the specification content to the spec tag, without showing the content.
 
@@ -120,7 +89,7 @@ This style adds a hash of the specification content to the spec tag, without sho
 > [!NOTE]
 > The hash is the first 8 characters of the specification content's SHA256 digest.
 
-##### `full`
+#### `full`
 
 This style displays the whole content of this specification item, including comments.
 
@@ -140,10 +109,7 @@ This style displays the whole content of this specification item, including comm
  */
 ```
 
-##### `link`
-
-> [!WARNING]
-> This feature is a work-in-progress.
+#### `link`
 
 This style displays a GitHub link to the specification item.
 
@@ -155,7 +121,7 @@ This style displays a GitHub link to the specification item.
  */
 ```
 
-##### `diff`
+#### `diff`
 
 This style displays a diff with the previous fork's version of the specification.
 
@@ -203,9 +169,9 @@ This can be used with any specification item, like functions too:
  */
 ```
 
-### Supported Specification Items
+## Supported Specification Items
 
-#### Constants
+### Constants
 
 These are items found in the `Constants` section of the specifications.
 
@@ -217,7 +183,7 @@ These are items found in the `Constants` section of the specifications.
  */
 ```
 
-#### Custom Types
+### Custom Types
 
 These are items found in the `Custom types` section of the specifications.
 
@@ -229,7 +195,7 @@ These are items found in the `Custom types` section of the specifications.
  */
 ```
 
-#### Preset Variables
+### Preset Variables
 
 These are items found in the
 [`presets`](https://github.com/ethereum/consensus-specs/tree/dev/presets) directory.
@@ -259,7 +225,7 @@ It's not strictly necessary to specify the preset attribute. The default preset
  */
 ```
 
-#### Config Variables
+### Config Variables
 
 These are items found in the
 [`configs`](https://github.com/ethereum/consensus-specs/tree/dev/presets) directory.
@@ -272,7 +238,7 @@ These are items found in the
  */
 ```
 
-#### SSZ Objects
+### SSZ Objects
 
 These are items found in the `Containers` section of the specifications.
 
@@ -287,7 +253,7 @@ These are items found in the `Containers` section of the specifications.
  */
 ```
 
-#### Dataclasses
+### Dataclasses
 
 These are classes with the `@dataclass` decorator.
 
@@ -304,7 +270,7 @@ These are classes with the `@dataclass` decorator.
  */
 ```
 
-#### Functions
+### Functions
 
 These are all the functions found in the specifications.
 

{ethspecify-0.1.0 → ethspecify-0.1.2}/README.md

@@ -9,81 +9,50 @@ When that happens, they can update the implementations appropriately.
 
 ## Getting Started
 
-### Adding Spec Tags
-
-In your client, add an HTML tag like this:
-
-```
-/*
- * <spec fn="is_fully_withdrawable_validator" fork="deneb">
- */
-```
-
-This supports all languages and comment styles. It preserves indentation, so something like this
-would also work:
-
-```
-/// <spec fn="is_fully_withdrawable_validator" fork="deneb">
-```
-
-After the script is finished executing, a new `hash` field will exist in the tag. This tag is used
-to tell if the specification changed, without having to include the specification content.
-
-```
-/// <spec fn="is_fully_withdrawable_validator" fork="deneb" hash="e936da25" />
-```
-
-> [!NOTE]
-> Closing tags will be added automatically. For `style="hash"` tags, a self-closing tag is used for
-> conciseness. For `style="full"` and `style="diff"` tags, a paired closing tag must be used.
-
 ### Installation
 
-#### Install with Pip
-
 ```
 python3 -mpip install ethspecify
 ```
 
-#### Manual Install
+### Adding Spec Tags
 
-First, clone the repository. You only need the latest commit.
+In your client, add HTML tags like this:
 
 ```
-git clone https://github.com/jtraglia/ethspecify.git --depth=1
-cd ethspecify
+/*
+ * <spec fn="is_fully_withdrawable_validator" fork="deneb">
+ */
 ```
 
-Next, build and install the utility.
-
 ```
-python3 -mpip install .
+/*
+ * <spec ssz_object="BeaconState" fork="electra" style="diff">
+ */
 ```
 
-Then, change directory to the source source directory and run `ethspecify`.
+### Populating Spec Tags
+
+Then, navigate to your codebase and run `ethspecify`:
 
 ```
-Projects/client$ ethspecify
-Processing file: /Users/user/Projects/client/src/file.ext
-spec tag: {'custom_type': 'Blob', 'fork': 'electra'}
-spec tag: {'dataclass': 'PayloadAttributes', 'fork': 'electra'}
-spec tag: {'ssz_object': 'ConsolidationRequest', 'fork': 'electra'}
+ethspecify
 ```
 
-### Specification Options
+## Specification Options
 
-#### Fork
+### Fork
 
 This attribute can be any of the [executable
 specifications](https://github.com/ethereum/consensus-specs/blob/e6bddd966214a19d2b97199bbe3c02577a22a8b4/Makefile#L3-L15)
 in the consensus-specs. At the time of writing, these are: phase0, altair, bellatrix, capella,
 deneb, electra, fulu, whisk, eip6800, and eip7732.
 
-#### Style
+### Style
 
 This attribute can be used to change how the specification content is shown.
 
-##### `hash` (default)
+#### `hash` (default)
 
 This style adds a hash of the specification content to the spec tag, without showing the content.
 
@@ -96,7 +65,7 @@ This style adds a hash of the specification content to the spec tag, without sho
 > [!NOTE]
 > The hash is the first 8 characters of the specification content's SHA256 digest.
 
-##### `full`
+#### `full`
 
 This style displays the whole content of this specification item, including comments.
 
@@ -116,10 +85,7 @@ This style displays the whole content of this specification item, including comm
  */
 ```
 
-##### `link`
-
-> [!WARNING]
-> This feature is a work-in-progress.
+#### `link`
 
 This style displays a GitHub link to the specification item.
 
@@ -131,7 +97,7 @@ This style displays a GitHub link to the specification item.
  */
 ```
 
-##### `diff`
+#### `diff`
 
 This style displays a diff with the previous fork's version of the specification.
 
@@ -179,9 +145,9 @@ This can be used with any specification item, like functions too:
  */
 ```
 
-### Supported Specification Items
+## Supported Specification Items
 
-#### Constants
+### Constants
 
 These are items found in the `Constants` section of the specifications.
 
@@ -193,7 +159,7 @@ These are items found in the `Constants` section of the specifications.
  */
 ```
 
-#### Custom Types
+### Custom Types
 
 These are items found in the `Custom types` section of the specifications.
 
@@ -205,7 +171,7 @@ These are items found in the `Custom types` section of the specifications.
  */
 ```
 
-#### Preset Variables
+### Preset Variables
 
 These are items found in the
 [`presets`](https://github.com/ethereum/consensus-specs/tree/dev/presets) directory.
@@ -235,7 +201,7 @@ It's not strictly necessary to specify the preset attribute. The default preset
  */
 ```
 
-#### Config Variables
+### Config Variables
 
 These are items found in the
 [`configs`](https://github.com/ethereum/consensus-specs/tree/dev/presets) directory.
@@ -248,7 +214,7 @@ These are items found in the
  */
 ```
 
-#### SSZ Objects
+### SSZ Objects
 
 These are items found in the `Containers` section of the specifications.
 
@@ -263,7 +229,7 @@ These are items found in the `Containers` section of the specifications.
  */
 ```
 
-#### Dataclasses
+### Dataclasses
 
 These are classes with the `@dataclass` decorator.
 
@@ -280,7 +246,7 @@ These are classes with the `@dataclass` decorator.
  */
 ```
 
-#### Functions
+### Functions
 
 These are all the functions found in the specifications.
 

{ethspecify-0.1.0 → ethspecify-0.1.2}/ethspecify/cli.py

@@ -1,7 +1,7 @@
 import argparse
 import os
 
-from .core import grep, replace_spec_tags  # if you split functionality into core.py
+from .core import grep, replace_spec_tags
 
 def main():
     parser = argparse.ArgumentParser(

{ethspecify-0.1.0 → ethspecify-0.1.2}/ethspecify/core.py

@@ -272,50 +272,66 @@ def replace_spec_tags(file_path):
     with open(file_path, 'r') as file:
         content = file.read()
 
-    # Define regex to match both long and self-closing <spec> tags
-    pattern = re.compile(r'(<spec\b[^>]*)(/?>)(?:([\s\S]*?)(</spec>))?', re.DOTALL)
+    # Define regex to match self-closing tags and long (paired) tags separately
+    pattern = re.compile(
+        r'(?P<self><spec\b[^>]*\/>)|(?P<long><spec\b[^>]*>[\s\S]*?</spec>)',
+        re.DOTALL
+    )
 
     def replacer(match):
-        # Extract the tag parts:
-        opening_tag_base = match.group(1)
-        tag_end = match.group(2)  # either ">" or "/>"
-
-        # Reconstruct the full opening tag for attribute extraction
-        opening_tag_full = opening_tag_base + tag_end
-
-        # Extract attributes from the full opening tag
-        attributes = extract_attributes(opening_tag_full)
-        print(f"spec tag: {attributes}")
-
-        # Parse common attributes to get preset, fork, style, etc.
-        preset, fork, style = parse_common_attributes(attributes)
-        spec = get_spec(attributes, preset, fork)
-
-        # Compute the first 8 characters of the SHA256 hash of the spec content.
-        hash_value = hashlib.sha256(spec.encode('utf-8')).hexdigest()[:8]
-
-        # Update the full opening tag (opening_tag_full) to include the hash attribute.
-        if 'hash="' in opening_tag_full:
-            updated_opening = re.sub(
-                r'(hash=")[^"]*(")',
-                lambda m: f'{m.group(1)}{hash_value}{m.group(2)}',
-                opening_tag_full
-            )
+        if match.group("self") is not None:
+            # Process self-closing tag
+            tag_text = match.group("self")
+            attributes = extract_attributes(tag_text)
+            print(f"spec tag: {attributes}")
+            preset, fork, style = parse_common_attributes(attributes)
+            spec = get_spec(attributes, preset, fork)
+            hash_value = hashlib.sha256(spec.encode('utf-8')).hexdigest()[:8]
+            if 'hash="' in tag_text:
+                updated_tag = re.sub(
+                    r'(hash=")[^"]*(")',
+                    lambda m: f'{m.group(1)}{hash_value}{m.group(2)}',
+                    tag_text
+                )
+            else:
+                # Insert hash attribute before the trailing '/>'
+                updated_tag = tag_text[:-2] + f' hash="{hash_value}"' + tag_text[-2:]
+            return updated_tag
         else:
-            updated_opening = opening_tag_full[:-1] + f' hash="{hash_value}">'
+            # Process long (paired) tag
+            tag_text = match.group("long")
+            # Extract the opening tag from the long tag (everything up to the first '>')
+            opening_match = re.match(r'(<spec\b[^>]*>)([\s\S]*)(</spec>)', tag_text, re.DOTALL)
+            if not opening_match:
+                return tag_text
+            opening_tag_full = opening_match.group(1)
+            attributes = extract_attributes(opening_tag_full)
+            print(f"spec tag: {attributes}")
+            preset, fork, style = parse_common_attributes(attributes)
+            spec = get_spec(attributes, preset, fork)
+            hash_value = hashlib.sha256(spec.encode('utf-8')).hexdigest()[:8]
+            if 'hash="' in opening_tag_full:
+                updated_opening = re.sub(
+                    r'(hash=")[^"]*(")',
+                    lambda m: f'{m.group(1)}{hash_value}{m.group(2)}',
+                    opening_tag_full
+                )
+            else:
+                updated_opening = opening_tag_full[:-1] + f' hash="{hash_value}">'
+            if style == "hash":
+                updated_tag = re.sub(r'\s*</spec>\s*$', '', updated_opening)
+                updated_tag = re.sub(r'\s*>$', '', updated_tag) + " />"
+            else:
+                spec_content = get_spec_item(attributes)
+                prefix = content[:match.start()].splitlines()[-1]
+                prefixed_spec = "\n".join(
+                    f"{prefix}{line}" if line.rstrip() else prefix.rstrip()
+                    for line in spec_content.rstrip().split("\n")
+                )
+                long_opening = updated_opening.rstrip(">/") + ">"
+                updated_tag = f"{long_opening}\n{prefixed_spec}\n{prefix}</spec>"
+            return updated_tag
 
-        if style == "hash":
-            # For hash style, output a short self-closing tag with normalized spacing.
-            updated_tag = re.sub(r'\s*/?>\s*$', '', updated_opening) + " />"
-        else:
-            # For full/diff styles, output the long form with content.
-            spec_content = get_spec_item(attributes)
-            prefix = content[:match.start()].splitlines()[-1]
-            prefixed_spec = "\n".join(f"{prefix}{line}" if line.rstrip() else prefix.rstrip() for line in spec_content.rstrip().split("\n"))
-            long_opening = updated_opening.rstrip(">/") + ">"
-            updated_tag = f"{long_opening}\n{prefixed_spec}\n{prefix}</spec>"
-
-        return updated_tag
 
     # Replace all matches in the content
     updated_content = pattern.sub(replacer, content)

{ethspecify-0.1.0 → ethspecify-0.1.2}/ethspecify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ethspecify
-Version: 0.1.0
+Version: 0.1.2
 Summary: A utility for processing Ethereum specification tags.
 Home-page: https://github.com/jtraglia/ethspecify
 Author: Justin Traglia
@@ -33,81 +33,50 @@ When that happens, they can update the implementations appropriately.
 
 ## Getting Started
 
-### Adding Spec Tags
-
-In your client, add an HTML tag like this:
-
-```
-/*
- * <spec fn="is_fully_withdrawable_validator" fork="deneb">
- */
-```
-
-This supports all languages and comment styles. It preserves indentation, so something like this
-would also work:
-
-```
-/// <spec fn="is_fully_withdrawable_validator" fork="deneb">
-```
-
-After the script is finished executing, a new `hash` field will exist in the tag. This tag is used
-to tell if the specification changed, without having to include the specification content.
-
-```
-/// <spec fn="is_fully_withdrawable_validator" fork="deneb" hash="e936da25" />
-```
-
-> [!NOTE]
-> Closing tags will be added automatically. For `style="hash"` tags, a self-closing tag is used for
-> conciseness. For `style="full"` and `style="diff"` tags, a paired closing tag must be used.
-
 ### Installation
 
-#### Install with Pip
-
 ```
 python3 -mpip install ethspecify
 ```
 
-#### Manual Install
+### Adding Spec Tags
 
-First, clone the repository. You only need the latest commit.
+In your client, add HTML tags like this:
 
 ```
-git clone https://github.com/jtraglia/ethspecify.git --depth=1
-cd ethspecify
+/*
+ * <spec fn="is_fully_withdrawable_validator" fork="deneb">
+ */
 ```
 
-Next, build and install the utility.
-
 ```
-python3 -mpip install .
+/*
+ * <spec ssz_object="BeaconState" fork="electra" style="diff">
+ */
 ```
 
-Then, change directory to the source source directory and run `ethspecify`.
+### Populating Spec Tags
+
+Then, navigate to your codebase and run `ethspecify`:
 
 ```
-Projects/client$ ethspecify
-Processing file: /Users/user/Projects/client/src/file.ext
-spec tag: {'custom_type': 'Blob', 'fork': 'electra'}
-spec tag: {'dataclass': 'PayloadAttributes', 'fork': 'electra'}
-spec tag: {'ssz_object': 'ConsolidationRequest', 'fork': 'electra'}
+ethspecify
 ```
 
-### Specification Options
+## Specification Options
 
-#### Fork
+### Fork
 
 This attribute can be any of the [executable
 specifications](https://github.com/ethereum/consensus-specs/blob/e6bddd966214a19d2b97199bbe3c02577a22a8b4/Makefile#L3-L15)
 in the consensus-specs. At the time of writing, these are: phase0, altair, bellatrix, capella,
 deneb, electra, fulu, whisk, eip6800, and eip7732.
 
-#### Style
+### Style
 
 This attribute can be used to change how the specification content is shown.
 
-##### `hash` (default)
+#### `hash` (default)
 
 This style adds a hash of the specification content to the spec tag, without showing the content.
 
@@ -120,7 +89,7 @@ This style adds a hash of the specification content to the spec tag, without sho
 > [!NOTE]
 > The hash is the first 8 characters of the specification content's SHA256 digest.
 
-##### `full`
+#### `full`
 
 This style displays the whole content of this specification item, including comments.
 
@@ -140,10 +109,7 @@ This style displays the whole content of this specification item, including comm
  */
 ```
 
-##### `link`
-
-> [!WARNING]
-> This feature is a work-in-progress.
+#### `link`
 
 This style displays a GitHub link to the specification item.
 
@@ -155,7 +121,7 @@ This style displays a GitHub link to the specification item.
  */
 ```
 
-##### `diff`
+#### `diff`
 
 This style displays a diff with the previous fork's version of the specification.
 
@@ -203,9 +169,9 @@ This can be used with any specification item, like functions too:
  */
 ```
 
-### Supported Specification Items
+## Supported Specification Items
 
-#### Constants
+### Constants
 
 These are items found in the `Constants` section of the specifications.
 
@@ -217,7 +183,7 @@ These are items found in the `Constants` section of the specifications.
  */
 ```
 
-#### Custom Types
+### Custom Types
 
 These are items found in the `Custom types` section of the specifications.
 
@@ -229,7 +195,7 @@ These are items found in the `Custom types` section of the specifications.
  */
 ```
 
-#### Preset Variables
+### Preset Variables
 
 These are items found in the
 [`presets`](https://github.com/ethereum/consensus-specs/tree/dev/presets) directory.
@@ -259,7 +225,7 @@ It's not strictly necessary to specify the preset attribute. The default preset
  */
 ```
 
-#### Config Variables
+### Config Variables
 
 These are items found in the
 [`configs`](https://github.com/ethereum/consensus-specs/tree/dev/presets) directory.
@@ -272,7 +238,7 @@ These are items found in the
  */
 ```
 
-#### SSZ Objects
+### SSZ Objects
 
 These are items found in the `Containers` section of the specifications.
 
@@ -287,7 +253,7 @@ These are items found in the `Containers` section of the specifications.
  */
 ```
 
-#### Dataclasses
+### Dataclasses
 
 These are classes with the `@dataclass` decorator.
 
@@ -304,7 +270,7 @@ These are classes with the `@dataclass` decorator.
  */
 ```
 
-#### Functions
+### Functions
 
 These are all the functions found in the specifications.
 

{ethspecify-0.1.0 → ethspecify-0.1.2}/setup.py

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