sfq 0.0.35__py3-none-any.whl → 0.0.36__py3-none-any.whl

sfq/__init__.py

@@ -24,7 +24,7 @@ from .exceptions import (
 from .http_client import HTTPClient
 from .query import QueryClient
 from .soap import SOAPClient
-from .utils import get_logger
+from .utils import get_logger, records_to_html_table
 from .debug_cleanup import DebugCleanup
 
 # Define public API for documentation tools
@@ -43,7 +43,7 @@ __all__ = [
     "__version__",
 ]
 
-__version__ = "0.0.35"
+__version__ = "0.0.36"
 """
 ### `__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.35",
+        user_agent: str = "sfq/0.0.36",
         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.35"
+        self.__version__ = "0.0.36"
         """
         ### `__version__`
         
@@ -561,3 +561,19 @@ class SFAuth:
         sid = quote(self.access_token, safe="")
         frontdoor_url = f"{self.instance_url}/secur/frontdoor.jsp?sid={sid}"
         webbrowser.open(frontdoor_url)
+
+    def records_to_html_table(
+        self,
+        items: List[Dict[str, Any]],
+        styled: bool = False,
+    ) -> str:
+        """
+        Convert a list of dictionaries to an HTML table.
+
+        :param items: List of dictionaries to convert.
+        :param styled: If True, apply basic CSS styles to the table.
+        :return: HTML string representing the table.
+        """
+        if "records" in items:
+            items = items["records"]
+        return records_to_html_table(items, styled=styled)

sfq/http_client.py

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

sfq/utils.py

@@ -9,6 +9,7 @@ sensitive data redaction functionality.
 import json
 import logging
 import re
+from html import escape
 from typing import Any, Dict, List, Tuple, Union
 
 # Custom TRACE logging level
@@ -194,3 +195,127 @@ def extract_org_and_user_ids(token_id_url: str) -> Tuple[str, str]:
         return org_id, user_id
     except (IndexError, AttributeError):
         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:
+    """
+    Convert a list of dictionaries to a compact HTML table.
+
+    :param items: List of dictionaries to convert
+    :param styled: If True, apply minimal inline CSS for compact styling
+    :return: HTML string for a table with one column per key.
+    :raises ValueError: If input is not a list of dictionaries, or if keys are invalid types.
+    """
+    if not isinstance(items, list):
+        raise ValueError("Input must be a list of dictionaries.")
+
+    def render_value(val: Any) -> str:
+        if val is None:
+            return ""
+        if isinstance(val, (int, float, str, bool)):
+            return escape(str(val))
+        if isinstance(val, list):
+            return (
+                "<ul>"
+                + "".join(f"<li>{render_value(item)}</li>" for item in val)
+                + "</ul>"
+            )
+        if isinstance(val, dict):
+            return dicts_to_html_table([val], styled=styled)
+        try:
+            dumped = json.dumps(val, default=str)
+            if dumped.startswith('"') and dumped.endswith('"'):
+                dumped = dumped[1:-1]
+            return escape(dumped)
+        except Exception:
+            return escape(str(val))
+
+    # Preserve key order by first appearance
+    columns: List[str] = []
+    seen = set()
+    for i, d in enumerate(items):
+        if not isinstance(d, dict):
+            raise ValueError(f"Element at index {i} is not a dictionary.")
+        for k in d.keys():
+            k_str = (
+                k
+                if isinstance(k, str)
+                else str(k)
+                if isinstance(k, (int, float, bool))
+                else None
+            )
+            if k_str is None:
+                raise ValueError(f"Dictionary at index {i} has a non-string key: {k!r}")
+            if k_str not in seen:
+                columns.append(k_str)
+                seen.add(k_str)
+
+    # Build table
+    def get_value_by_str_key(d: Dict[Any, Any], col: str) -> Any:
+        for k in d.keys():
+            k_str = (
+                k
+                if isinstance(k, str)
+                else str(k)
+                if isinstance(k, (int, float, bool))
+                else None
+            )
+            if k_str == col:
+                return d[k]
+        return ""
+
+    if styled:
+        table_style = (
+            "border-collapse:collapse;font-size:12px;line-height:1.2;"
+            "margin:0;padding:0;width:auto;"
+        )
+        td_style = "border:1px solid #ccc;padding:2px 6px;vertical-align:top;"
+        th_style = (
+            "border:1px solid #ccc;padding:2px 6px;background:#f8f8f8;font-weight:bold;"
+        )
+        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.append("</tr></thead><tbody>")
+            for d in items:
+                html.append("<tr>")
+                html.extend(
+                    f'<td style="{td_style}">{render_value(get_value_by_str_key(d, col))}</td>'
+                    for col in columns
+                )
+                html.append("</tr>")
+            html.append("</tbody></table>")
+        else:
+            html = [
+                f'<table style="{table_style}"><thead></thead><tbody></tbody></table>'
+            ]
+    else:
+        if columns:
+            html = ["<table><thead><tr>"]
+            html.extend(f"<th>{escape(col)}</th>" for col in columns)
+            html.append("</tr></thead><tbody>")
+            for d in items:
+                html.append("<tr>")
+                html.extend(
+                    f"<td>{render_value(get_value_by_str_key(d, col))}</td>"
+                    for col in columns
+                )
+                html.append("</tr>")
+            html.append("</tbody></table>")
+        else:
+            html = ["<table><thead></thead><tbody></tbody></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:
+        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)

{sfq-0.0.35.dist-info → sfq-0.0.36.dist-info}/METADATA

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

{sfq-0.0.35.dist-info → sfq-0.0.36.dist-info}/RECORD

@@ -1,14 +1,14 @@
-sfq/__init__.py,sha256=dfNoQFuitLT_j-nKPtsqYpeJLxwIzwBgPjiuVerelfk,19929
+sfq/__init__.py,sha256=VlPphhQ59mVW-BmJHE_S5P4-v1czO-CSX9icraMUx3E,20465
 sfq/_cometd.py,sha256=QqdSGsms9uFm7vgmxgau7m2UuLHztK1yjN-BNjeo8xM,10381
 sfq/auth.py,sha256=bD7kEI5UpUAh0xpE2GzB7EatfLE0q-rqG7tOpqn_cQY,13985
 sfq/crud.py,sha256=fj4wPMt0DcrMKbMWQ9AUMsUNUWicsY93LP_3Q7lhmDU,20300
 sfq/debug_cleanup.py,sha256=e2_Hpigy3F7XsATOUXo8DZNmuEIL9SDD0tBlZIZeQLc,2638
 sfq/exceptions.py,sha256=HZctvGj1SGguca0oG6fqSmf3KDbq4v68FfQfqB-crpo,906
-sfq/http_client.py,sha256=-Xs3I9jW-3l098wdi7CMnS4wWwffZ8EeQ_xygacaNHg,11636
+sfq/http_client.py,sha256=7SWfnJxHZMNphPc-pd3DUzPDrJymPQ9znNMSALnFiHQ,11636
 sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sfq/query.py,sha256=AoagL8PMKUcpbPPTcHJPKhmUdDDPa0La4JLC0TUN_Yc,14586
 sfq/soap.py,sha256=FM4msP9ErrgLFaNOQy_kYVde8QFkT4yQu9TfMiZG0VA,7006
-sfq/utils.py,sha256=gx_pCZmOykYz19wwx6O2BTGj7bQfzhX_SuLHnYGCWuc,6234
-sfq-0.0.35.dist-info/METADATA,sha256=mXHjqsfIWDzGKnFe7dzZVEj54yqT4xdd1702heA4Vh8,6899
-sfq-0.0.35.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sfq-0.0.35.dist-info/RECORD,,
+sfq/utils.py,sha256=3RjloIAO0A2i8nkbPwB6m9nnKhMvXBSsqnnKFmY1cwY,10782
+sfq-0.0.36.dist-info/METADATA,sha256=_6EWxpLVyuecOv0St_dTygTIt8wXodqtgx3cfQnNKHc,6899
+sfq-0.0.36.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sfq-0.0.36.dist-info/RECORD,,