sfq 0.0.36__tar.gz → 0.0.38__tar.gz

{sfq-0.0.36 → sfq-0.0.38}/.github/workflows/publish.yml

@@ -76,7 +76,6 @@ jobs:
 
           echo "Updating src/sfq/__init__.py user_agent to $VERSION"
           sed -i -E "s/(user_agent: str = \"sfq\/)[0-9]+\.[0-9]+\.[0-9]+(\")/\1$VERSION\2/" src/sfq/__init__.py
-          sed -i -E "s/(user_agent: str = \"sfq\/)[0-9]+\.[0-9]+\.[0-9]+(\")/\1$VERSION\2/" src/sfq/http_client.py
           sed -i -E "s/(default is \"sfq\/)[0-9]+\.[0-9]+\.[0-9]+(\")/\1$VERSION\2/" src/sfq/__init__.py
 
           echo "Updating src/sfq/__init__.py __version__ to $VERSION"
@@ -85,6 +84,7 @@ jobs:
           
           echo "Updating src/sfq/http_client.py user_agent to $VERSION"
           sed -i -E "s/(user_agent: str = \"sfq\/)[0-9]+\.[0-9]+\.[0-9]+(\")/\1$VERSION\2/" src/sfq/http_client.py
+          sed -i -E "s/(user_agent: str = \"sfq\/)[0-9]+\.[0-9]+\.[0-9]+(\",)/\1$VERSION\2/" src/sfq/http_client.py
 
       - name: Run tests
         run: pytest --verbose --strict-config
@@ -99,7 +99,7 @@ jobs:
         run: |
           git config user.name "github-actions[bot]"
           git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          git add pyproject.toml uv.lock src/sfq/__init__.py
+          git add pyproject.toml uv.lock src/sfq/__init__.py src/sfq/http_client.py
           git commit -m "CI: bump version to ${{ steps.get_version.outputs.version }}"
           git push
 

{sfq-0.0.36 → sfq-0.0.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfq
-Version: 0.0.36
+Version: 0.0.38
 Summary: Python wrapper for the Salesforce's Query API.
 Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
 Keywords: salesforce,salesforce query

{sfq-0.0.36 → sfq-0.0.38}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sfq"
-version = "0.0.36"
+version = "0.0.38"
 description = "Python wrapper for the Salesforce's Query API."
 readme = "README.md"
 authors = [{ name = "David Moruzzi", email = "sfq.pypi@dmoruzi.com" }]

{sfq-0.0.36 → sfq-0.0.38}/src/sfq/__init__.py

@@ -43,7 +43,7 @@ __all__ = [
     "__version__",
 ]
 
-__version__ = "0.0.36"
+__version__ = "0.0.38"
 """
 ### `__version__`
 
@@ -67,7 +67,7 @@ class SFAuth:
         access_token: Optional[str] = None,
         token_expiration_time: Optional[float] = None,
         token_lifetime: int = 15 * 60,
-        user_agent: str = "sfq/0.0.36",
+        user_agent: str = "sfq/0.0.38",
         sforce_client: str = "_auto",
         proxy: str = "_auto",
     ) -> None:
@@ -132,7 +132,7 @@ class SFAuth:
         self._debug_cleanup = DebugCleanup(sf_auth=self)
 
         # Store version information
-        self.__version__ = "0.0.36"
+        self.__version__ = "0.0.38"
         """
         ### `__version__`
         
@@ -565,6 +565,7 @@ class SFAuth:
     def records_to_html_table(
         self,
         items: List[Dict[str, Any]],
+        headers: Dict[str, str] = None,
         styled: bool = False,
     ) -> str:
         """
@@ -576,4 +577,4 @@ class SFAuth:
         """
         if "records" in items:
             items = items["records"]
-        return records_to_html_table(items, styled=styled)
+        return records_to_html_table(items, headers=headers, styled=styled)

{sfq-0.0.36 → sfq-0.0.38}/src/sfq/http_client.py

@@ -28,7 +28,7 @@ class HTTPClient:
     def __init__(
         self,
         auth_manager: AuthManager,
-        user_agent: str = "sfq/0.0.36",
+        user_agent: str = "sfq/0.0.38",
         sforce_client: str = "_auto",
         high_api_usage_threshold: int = 80,
     ) -> None:

{sfq-0.0.36 → sfq-0.0.38}/src/sfq/utils.py

@@ -197,9 +197,7 @@ def extract_org_and_user_ids(token_id_url: str) -> Tuple[str, str]:
         raise ValueError(f"Invalid token ID URL format: {token_id_url}")
 
 
-def dicts_to_html_table(
-    items: List[Dict[str, Any]], styled: bool = False
-) -> str:
+def dicts_to_html_table(items: List[Dict[str, Any]], styled: bool = False) -> str:
     """
     Convert a list of dictionaries to a compact HTML table.
 
@@ -215,7 +213,7 @@ def dicts_to_html_table(
         if val is None:
             return ""
         if isinstance(val, (int, float, str, bool)):
-            return escape(str(val))
+            return str(val)
         if isinstance(val, list):
             return (
                 "<ul>"
@@ -277,7 +275,7 @@ def dicts_to_html_table(
         )
         if columns:
             html = [f'<table style="{table_style}"><thead><tr>']
-            html.extend(f'<th style="{th_style}">{escape(col)}</th>' for col in columns)
+            html.extend(f'<th style="{th_style}">{col}</th>' for col in columns)
             html.append("</tr></thead><tbody>")
             for d in items:
                 html.append("<tr>")
@@ -294,7 +292,7 @@ def dicts_to_html_table(
     else:
         if columns:
             html = ["<table><thead><tr>"]
-            html.extend(f"<th>{escape(col)}</th>" for col in columns)
+            html.extend(f"<th>{col}</th>" for col in columns)
             html.append("</tr></thead><tbody>")
             for d in items:
                 html.append("<tr>")
@@ -309,13 +307,70 @@ def dicts_to_html_table(
 
     return "".join(html)
 
-def records_to_html_table(records: List[Dict[str, Any]], styled: bool = False) -> str:
-    """Convert a list of records to an HTML table."""
-    # really we don't want anything associated with "attributes"
-    normalized_records = []
-    for record in records:
+
+def flatten_dict(d, parent_key="", sep="."):
+    """Recursively flatten a dictionary with dot notation."""
+    items = {}
+    for k, v in d.items():
+        new_key = f"{parent_key}{sep}{k}" if parent_key else k
+        if isinstance(v, dict):
+            items.update(flatten_dict(v, new_key, sep=sep))
+        else:
+            items[new_key] = v
+    return items
+
+
+def remove_attributes(obj):
+    """Recursively remove 'attributes' key from dicts/lists."""
+    if isinstance(obj, dict):
+        return {k: remove_attributes(v) for k, v in obj.items() if k != "attributes"}
+    elif isinstance(obj, list):
+        return [remove_attributes(item) for item in obj]
+    else:
+        return obj
+
+
+def records_to_html_table(
+    records: List[Dict[str, Any]], headers: Dict[str, str] = None, styled: bool = False
+) -> str:
+    if not isinstance(records, list):
+        raise ValueError("records must be a list of dictionaries")
+
+    cleaned = remove_attributes(records)
+
+    flat_rows = []
+    for record in cleaned:
         if not isinstance(record, dict):
             raise ValueError(f"Record is not a dictionary: {record!r}")
-        record.pop("attributes", None)
-        normalized_records.append(record)
-    return dicts_to_html_table(normalized_records, styled=styled)
+        flat_rows.append(flatten_dict(record))
+
+    # Preserve column order across all rows
+    seen = set()
+    ordered_columns = []
+    for row in flat_rows:
+        for key in row.keys():
+            if key not in seen:
+                ordered_columns.append(key)
+                seen.add(key)
+
+    # headers optionally remaps flattened field names to user-friendly display names
+    if headers is None:
+        headers = {}
+        for col in ordered_columns:
+            headers[col] = col
+    else:
+        for col in ordered_columns:
+            headers[col] = headers.get(col, col)
+
+    # Normalize rows so all have the same keys, using remapped column names
+    normalized_data = []
+    for row in flat_rows:
+        normalized_row = {
+            headers.get(col, col): (
+                "" if row.get(col, None) is None else row.get(col, "")
+            )
+            for col in ordered_columns
+        }
+        normalized_data.append(normalized_row)
+
+    return dicts_to_html_table(normalized_data, styled=styled)

sfq-0.0.38/tests/test_records_to_html.py

@@ -0,0 +1,153 @@
+import os
+
+import pytest
+
+from sfq import SFAuth
+
+
+@pytest.fixture(scope="module")
+def sf_instance():
+    required_env_vars = [
+        "SF_INSTANCE_URL",
+        "SF_CLIENT_ID",
+        "SF_CLIENT_SECRET",
+        "SF_REFRESH_TOKEN",
+    ]
+
+    missing_vars = [var for var in required_env_vars if not os.getenv(var)]
+    if missing_vars:
+        pytest.fail(f"Missing required env vars: {', '.join(missing_vars)}")
+
+    sf = SFAuth(
+        instance_url=os.getenv("SF_INSTANCE_URL"),
+        client_id=os.getenv("SF_CLIENT_ID"),
+        client_secret=os.getenv("SF_CLIENT_SECRET").strip(),
+        refresh_token=os.getenv("SF_REFRESH_TOKEN"),
+    )
+    return sf
+
+
+def test_html_table_conversion(sf_instance):
+    """
+    Test the HTML table conversion utility.
+    """
+    records = sf_instance.query("SELECT Id,NamespacePrefix FROM Organization LIMIT 1")
+
+    plain_html_table = sf_instance.records_to_html_table(records, styled=False)
+    styled_html_table = sf_instance.records_to_html_table(records, styled=True)
+
+    assert isinstance(plain_html_table, str)
+    assert "<table>" in plain_html_table
+    assert "<tr>" in plain_html_table
+    assert "<td>" in plain_html_table
+    org_id = sf_instance.org_id
+    assert f"<table><thead><tr><th>Id</th><th>NamespacePrefix</th></tr></thead><tbody><tr><td>{org_id}</td><td></td></tr></tbody></table>" == plain_html_table
+    assert f'<table style="border-collapse:collapse;font-size:12px;line-height:1.2;margin:0;padding:0;width:auto;"><thead><tr><th style="border:1px solid #ccc;padding:2px 6px;background:#f8f8f8;font-weight:bold;">Id</th><th style="border:1px solid #ccc;padding:2px 6px;background:#f8f8f8;font-weight:bold;">NamespacePrefix</th></tr></thead><tbody><tr><td style="border:1px solid #ccc;padding:2px 6px;vertical-align:top;">{org_id}</td><td style="border:1px solid #ccc;padding:2px 6px;vertical-align:top;"></td></tr></tbody></table>' == styled_html_table
+
+def test_html_table_with_nested_fields(sf_instance):
+    results = sf_instance.query("SELECT Id,Name,CreatedBy.Name,CreatedBy.Profile.Name FROM User WHERE CreatedBy.Name <> null LIMIT 1")
+    html = sf_instance.records_to_html_table(results)
+    assert isinstance(html, str)
+    assert "<table>" in html
+    assert "<tr>" in html
+    assert "<td>" in html
+    assert "CreatedBy.Name" in html
+    assert "CreatedBy.Profile.Name" in html
+    assert "Id" in html
+
+def test_html_table_with_mapped_headers(sf_instance):
+    header_map = {
+        "Id": "Id",
+        "Name": "Name",
+        "CreatedBy.Name": "Created By",
+        "CreatedBy.Profile.Name": "Created By Profile"
+    }
+    results = sf_instance.query("SELECT Id,Name,CreatedBy.Name,CreatedBy.Profile.Name FROM User WHERE CreatedBy.Name <> null LIMIT 1")
+    html = sf_instance.records_to_html_table(results, headers=header_map)
+    assert isinstance(html, str)
+    assert "<table>" in html
+    assert "<tr>" in html
+    assert "<td>" in html
+    assert "Created By" in html
+    assert "Created By Profile" in html
+    assert "Id" in html
+    assert "CreatedBy.Name" not in html
+    assert "CreatedBy.Profile.Name" not in html
+
+def test_html_table_with_no_records(sf_instance):
+    html = sf_instance.records_to_html_table([])
+    assert isinstance(html, str)
+    assert "<table>" in html
+    assert "<tr>" not in html
+    assert "<td>" not in html
+    assert "</table>" in html
+
+def test_html_table_with_single_record(sf_instance):
+    records = sf_instance.query("SELECT Id,NamespacePrefix FROM Organization LIMIT 1")
+    html = sf_instance.records_to_html_table(records)
+    assert isinstance(html, str)
+    assert "<table>" in html
+    assert "<tr>" in html
+    assert "<td>" in html
+    org_id = sf_instance.org_id
+    assert f"<table><thead><tr><th>Id</th><th>NamespacePrefix</th></tr></thead><tbody><tr><td>{org_id}</td><td></td></tr></tbody></table>" == html
+
+    styled_html = sf_instance.records_to_html_table(records, styled=True)
+    assert isinstance(styled_html, str)
+    assert "<table" in styled_html
+    assert 'style="border-collapse:collapse;font-size:12px;line-height:1.2;margin:0;padding:0;width:auto;"' in styled_html
+    assert "<tr" in styled_html
+    assert "<td" in styled_html
+    assert "</td>" in styled_html
+    assert "</tr>" in styled_html
+    assert "</table>" in styled_html
+
+def test_html_with_nested_fields(sf_instance):
+    results = sf_instance.query("SELECT Id,Name,CreatedBy.Name,CreatedBy.Profile.Name FROM User WHERE CreatedBy.Name <> null LIMIT 1")
+    html = sf_instance.records_to_html_table(results)
+    assert isinstance(html, str)
+    assert "<table>" in html
+    assert "<tr" in html
+    assert "<td" in html
+    assert "</tr>" in html
+    assert "</td>" in html
+    assert "CreatedBy.Name" in html
+    assert "CreatedBy.Profile.Name" in html
+    assert "Id" in html
+
+
+def test_html_table_with_none_values(sf_instance):
+    records = [
+        {"Id": None, "Name": "Test"},
+        {"Id": "123", "Name": None},
+    ]
+    html = sf_instance.records_to_html_table(records)
+    assert "<td></td>" in html  # None should be rendered as empty
+    assert "Test" in html
+    assert "123" in html
+
+def test_html_table_with_empty_dict(sf_instance):
+    records = [{}]
+    html = sf_instance.records_to_html_table(records)
+    assert "<table>" in html
+    assert "<tr>" not in html or "<td>" not in html
+
+def test_html_table_with_mixed_types(sf_instance):
+    records = [
+        {"Id": 1, "Active": True, "Score": 99.5},
+        {"Id": 2, "Active": False, "Score": None},
+    ]
+    html = sf_instance.records_to_html_table(records)
+    assert "1" in html
+    assert "True" in html or "False" in html
+    assert "99.5" in html
+
+def test_html_table_with_header_remapping_missing_keys(sf_instance):
+    records = [
+        {"Id": "abc", "Name": "Test", "Extra": "Value"}
+    ]
+    headers = {"Id": "Identifier", "Name": "Label"}  # 'Extra' not mapped
+    html = sf_instance.records_to_html_table(records, headers=headers)
+    assert "Identifier" in html
+    assert "Label" in html
+    assert "Extra" in html  # Should fall back to original key

{sfq-0.0.36 → sfq-0.0.38}/uv.lock

@@ -3,5 +3,5 @@ requires-python = ">=3.9"
 
 [[package]]
 name = "sfq"
-version = "0.0.36"
+version = "0.0.38"
 source = { editable = "." }

sfq-0.0.36/tests/test_records_to_html.py

@@ -1,45 +0,0 @@
-import os
-
-import pytest
-
-from sfq import SFAuth
-
-
-@pytest.fixture(scope="module")
-def sf_instance():
-    required_env_vars = [
-        "SF_INSTANCE_URL",
-        "SF_CLIENT_ID",
-        "SF_CLIENT_SECRET",
-        "SF_REFRESH_TOKEN",
-    ]
-
-    missing_vars = [var for var in required_env_vars if not os.getenv(var)]
-    if missing_vars:
-        pytest.fail(f"Missing required env vars: {', '.join(missing_vars)}")
-
-    sf = SFAuth(
-        instance_url=os.getenv("SF_INSTANCE_URL"),
-        client_id=os.getenv("SF_CLIENT_ID"),
-        client_secret=os.getenv("SF_CLIENT_SECRET").strip(),
-        refresh_token=os.getenv("SF_REFRESH_TOKEN"),
-    )
-    return sf
-
-
-def test_html_table_conversion(sf_instance):
-    """
-    Test the HTML table conversion utility.
-    """
-    records = sf_instance.query("SELECT Id,NamespacePrefix FROM Organization LIMIT 1")
-
-    plain_html_table = sf_instance.records_to_html_table(records, styled=False)
-    styled_html_table = sf_instance.records_to_html_table(records, styled=True)
-
-    assert isinstance(plain_html_table, str)
-    assert "<table>" in plain_html_table
-    assert "<tr>" in plain_html_table
-    assert "<td>" in plain_html_table
-    org_id = sf_instance.org_id
-    assert f"<table><thead><tr><th>Id</th><th>NamespacePrefix</th></tr></thead><tbody><tr><td>{org_id}</td><td></td></tr></tbody></table>" == plain_html_table
-    assert f'<table style="border-collapse:collapse;font-size:12px;line-height:1.2;margin:0;padding:0;width:auto;"><thead><tr><th style="border:1px solid #ccc;padding:2px 6px;background:#f8f8f8;font-weight:bold;">Id</th><th style="border:1px solid #ccc;padding:2px 6px;background:#f8f8f8;font-weight:bold;">NamespacePrefix</th></tr></thead><tbody><tr><td style="border:1px solid #ccc;padding:2px 6px;vertical-align:top;">{org_id}</td><td style="border:1px solid #ccc;padding:2px 6px;vertical-align:top;"></td></tr></tbody></table>' == styled_html_table