refactor: rename transform_html to set_html_attributes

Author: JuroOravec

README.md

@@ -13,10 +13,10 @@ pip install djc-core-html-parser
 ## Usage
 
 ```python
-from djc_core_html_parser import transform_html
+from djc_core_html_parser import set_html_attributes
 
 html = '<div><p>Hello</p></div>'
-result, _ = transform_html(
+result, _ = set_html_attributes(
   html,
   # Add attributes to the root elements
   root_attributes=['data-root-id'],
@@ -25,7 +25,7 @@ result, _ = transform_html(
 )
 ```
 
-To save ourselves from re-parsing the HTML, `transform_html` returns not just the transformed HTML, but also a dictionary as the second item.
+To save ourselves from re-parsing the HTML, `set_html_attributes` returns not just the transformed HTML, but also a dictionary as the second item.
 
 This dictionary contains a record of which HTML attributes were written to which elemenents.
 
@@ -37,7 +37,7 @@ Then, during the HTML transformation, we check each element for this attribute.
 2. Record the attributes that were added to the element, using the value of the watched attribute as the key.
 
 ```python
-from djc_core_html_parser import transform_html
+from djc_core_html_parser import set_html_attributes
 
 html = """
   <div data-watch-id="123">
@@ -47,7 +47,7 @@ html = """
   </div>
 """
 
-result, captured = transform_html(
+result, captured = set_html_attributes(
   html,
   # Add attributes to the root elements
   root_attributes=['data-root-id'],

__init__.pyi

@@ -1,6 +1,6 @@
 from typing import List, Dict, Optional
 
-def transform_html(
+def set_html_attributes(
     html: str,
     root_attributes: List[str],
     all_attributes: List[str],
@@ -25,7 +25,7 @@ def transform_html(
 
     Example:
         >>> html = '<div><p>Hello</p></div>'
-        >>> transform_html(html, ['data-root-id'], ['data-v-123'])
+        >>> set_html_attributes(html, ['data-root-id'], ['data-v-123'])
         '<div data-root-id="" data-v-123=""><p data-v-123="">Hello</p></div>'
 
     Raises:

src/html_parser.rs

@@ -31,7 +31,7 @@ const VOID_ELEMENTS: [&str; 14] = [
 ///
 /// Example:
 ///     >>> html = '<div data-id="123"><p>Hello</p></div>'
-///     >>> html, captured = transform_html(html, ['data-root-id'], ['data-v-123'], watch_on_attribute='data-id')
+///     >>> html, captured = set_html_attributes(html, ['data-root-id'], ['data-v-123'], watch_on_attribute='data-id')
 ///     >>> print(captured)
 ///     {'123': ['data-root-id', 'data-v-123']}
 ///
@@ -41,7 +41,7 @@ const VOID_ELEMENTS: [&str; 14] = [
 #[pyo3(
     text_signature = "(html, root_attributes, all_attributes, *, check_end_names=False, watch_on_attribute=None)"
 )]
-pub fn transform_html(
+pub fn set_html_attributes(
     py: Python,
     html: &str,
     root_attributes: Vec<String>,

src/lib.rs

@@ -6,6 +6,6 @@ mod html_parser;
 /// A Python module implemented in Rust for high-performance HTML transformation.
 #[pymodule]
 fn djc_core_html_parser(_py: Python, m: &PyModule) -> PyResult<()> {
-    m.add_function(wrap_pyfunction!(html_parser::transform_html, m)?)?;
+    m.add_function(wrap_pyfunction!(html_parser::set_html_attributes, m)?)?;
     Ok(())
 }

tests/benchmark.py

@@ -1,7 +1,7 @@
 from statistics import mean, stdev
 import time
 
-from djc_core_html_parser import transform_html
+from djc_core_html_parser import set_html_attributes
 
 
 def generate_large_html(num_elements: int = 1000) -> str:
@@ -85,7 +85,7 @@ def generate_large_html(num_elements: int = 1000) -> str:
 for i in range(NUM_ITER):  # Run N iterations
 
     start = time.perf_counter()
-    transform_html(html, root_attributes, all_attributes, watch_on_attribute="data-id")
+    set_html_attributes(html, root_attributes, all_attributes, watch_on_attribute="data-id")
     modify_time = time.perf_counter() - start
     modify_times.append(modify_time)
 

tests/test_html_parser.py

@@ -1,20 +1,20 @@
 # This same set of tests is also found in django-components, to ensure that
 # this implementation can be replaced with the django-components' pure-python implementation
 
-from djc_core_html_parser import transform_html
+from djc_core_html_parser import set_html_attributes
 from typing import Dict, List
 
 
 def test_basic_transformation():
     html = "<div><p>Hello</p></div>"
-    result, _ = transform_html(html, ["data-root"], ["data-all"])
+    result, _ = set_html_attributes(html, ["data-root"], ["data-all"])
     expected = '<div data-root="" data-all=""><p data-all="">Hello</p></div>'
     assert result == expected
 
 
 def test_multiple_roots():
     html = "<div>First</div><span>Second</span>"
-    result, _ = transform_html(html, ["data-root"], ["data-all"])
+    result, _ = set_html_attributes(html, ["data-root"], ["data-all"])
     expected = '<div data-root="" data-all="">First</div><span data-root="" data-all="">Second</span>'
     assert result == expected
 
@@ -42,7 +42,7 @@ def test_complex_html():
         </footer>
     """
 
-    result, _ = transform_html(html, ["data-root"], ["data-all", "data-v-123"])
+    result, _ = set_html_attributes(html, ["data-root"], ["data-all", "data-v-123"])
     expected = """
         <div class="container" id="main" data-root="" data-all="" data-v-123="">
             <header class="flex" data-all="" data-v-123="">
@@ -76,7 +76,7 @@ def test_void_elements():
     ]
 
     for input_html, expected in test_cases:
-        result, _ = transform_html(input_html, ["data-root"], ["data-v-123"])
+        result, _ = set_html_attributes(input_html, ["data-root"], ["data-v-123"])
         assert result == expected
 
 
@@ -89,7 +89,7 @@ def test_html_head_with_meta():
             <meta name="description" content="Test">
         </head>"""
 
-    result, _ = transform_html(html, ["data-root"], ["data-v-123"])
+    result, _ = set_html_attributes(html, ["data-root"], ["data-v-123"])
     expected = """
         <head data-root="" data-v-123="">
             <meta charset="utf-8" data-v-123=""/>
@@ -110,7 +110,7 @@ def test_watch_attribute():
 
     result: str
     captured: Dict[str, List[str]]
-    result, captured = transform_html(html, ["data-root"], ["data-v-123"], watch_on_attribute="data-id")
+    result, captured = set_html_attributes(html, ["data-root"], ["data-v-123"], watch_on_attribute="data-id")
     expected = """
         <div data-id="123" data-root="" data-v-123="">
             <p data-v-123="">Regular element</p>
@@ -140,7 +140,7 @@ def test_whitespace_preservation():
         <span> Text with spaces </span>
     </div>"""
 
-    result, _ = transform_html(html, ["data-root"], ["data-all"])
+    result, _ = set_html_attributes(html, ["data-root"], ["data-all"])
     expected = """<div data-root="" data-all="">
         <p data-all="">  Hello  World  </p>
         <span data-all=""> Text with spaces </span>