python-jack-knife 0.5.5__tar.gz → 0.6.2__tar.gz

{python_jack_knife-0.5.5 → python_jack_knife-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-jack-knife
-Version: 0.5.5
+Version: 0.6.2
 Summary: Python Jack Knife – a command line data processor
 Author-email: Mike Schultz <mike.schultz@gmail.com>
 License: 

{python_jack_knife-0.5.5 → python_jack_knife-0.6.2}/src/pjk/base.py

@@ -279,6 +279,11 @@ class KeyedSource(ABC):
     def deep_copy(self):
         return None
 
+# mixin 
+# just for distinguishing components for display
+class Integration(ABC):
+    pass
+
 class Source(ABC):
     @classmethod
     def usage(cls):

{python_jack_knife-0.5.5 → python_jack_knife-0.6.2}/src/pjk/common.py

@@ -3,8 +3,9 @@
 
 import sys, shutil, subprocess, contextlib, signal
 import os
+import re
 import yaml
-from pjk.base import TokenError
+from pjk.base import TokenError, Integration
 
 class SafeNamespace:
     def __init__(self, obj):
@@ -99,7 +100,7 @@ class Lookups:
         entry = self._data.get(lookup_key, default)
         if not entry:
             raise TokenError(
-                f"~/.pjk/lookups.yaml must contain entry for '{lookup_key}' with host, user, password."
+                f"~/.pjk/lookups.yaml does not contain entry for '{lookup_key}' with required params."
             )
         return entry
 
@@ -119,39 +120,43 @@ class Lookups:
         return dict(self._data)
 
 class ComponentFactory:
-    def __init__(self, components: dict, comp_type_name: str):
+    def __init__(self, core_components: dict):
         self.num_orig = 0
-        self.components = components # name -> component_class
-        self.comp_type_name = comp_type_name
-        self.num_orig_comps = len(components)
+        self._components = {}
+        for k, v in core_components.items():
+            if issubclass(v, Integration):
+                self.register(k, v, 'integration')
+            else:
+                self.register(k, v, 'core')
 
-    def register(self, name, comp_class):
-        self.components[name] = comp_class
+    def register(self, name, comp_class, origin: str):
+        self._components[name] = (comp_class, origin)
 
     def get_comp_type_name(self):
-        return self.comp_type_name
-
-    def print_descriptions(self):
-        header = highlight(f'{self.comp_type_name}s')
-        print(header)
+        pass
 
-        i = 0
-        # user and outside package components are also here, but printed from registry class
-        for name, comp_class in self.components.items():
-            usage = comp_class.usage()
-            lines = usage.desc.split('\n')
-            if i >= self.num_orig_comps:
-                break
+    def get_component_name_class_tuples(self, origin: str = None) -> list:
+        ret = []
+        for k, (v, org) in self._components.items():
+            if not origin or origin == org:
+                ret.append((k, v))
+        return ret
 
-            line = f'  {name:<12} {lines[0]}'
-            print(line)
-            i += 1
+    def get_component_class(self, name: str):
+        tuple = self._components.get(name)
+        if not tuple:
+            return None
+        component_class, origin = tuple
+        return component_class
 
     def get_usage(self, name: str):
-        comp_class = self.components.get(name)
+        comp_class = self.get_component_class(name)
         if not comp_class:
             return None
         return comp_class.usage()
 
     def create(self, token: str):
         pass
+
+def is_valid_field_name(name: str):
+    return re.fullmatch(r'^[A-Za-z_][A-Za-z0-9_]*$', name)

python_jack_knife-0.5.5/src/pjk/sinks/ddb.py → python_jack_knife-0.6.2/src/pjk/integrations/ddb_sink.py

@@ -1,10 +1,10 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright 2024 Mike Schultz
 
-from pjk.base import Sink, Source, ParsedToken, Usage
+from pjk.base import Sink, Integration, Source, ParsedToken, Usage
 from decimal import Decimal
 
-class DDBSink(Sink):
+class DDBSink(Sink, Integration):
     @classmethod
     def usage(cls):
         usage = Usage(

{python_jack_knife-0.5.5/src/pjk/pipes → python_jack_knife-0.6.2/src/pjk/integrations}/postgres_pipe.py

@@ -9,8 +9,9 @@ import uuid
 from decimal import Decimal
 from typing import Any, Dict, Optional
 
-from pjk.base import Pipe, ParsedToken, NoBindUsage, Usage, TokenError
+from pjk.base import Integration, ParsedToken, Usage
 from pjk.common import Lookups
+from pjk.pipes.query_pipe import QueryPipe
 
 
 class DBClient:
@@ -89,28 +90,15 @@ def _row_to_dict(cursor, row) -> Dict[str, Any]:
     return {col: normalize(val) for col, val in zip(cols, row)}
 
 
-class PostgresPipe(Pipe):
-    @classmethod
-    def usage(cls):
-        usage = Usage(
-            name="pgres",
-            desc="Postgres query pipe; executes SQL from input record['query'].",
-            component_class=cls,
-        )
-        usage.def_arg(
-            "dbname",
-            f"~/.pjk/lookups.yaml must containing entry '{cls.__name__}-<dbname>' with host, user, password"
-        )
-        usage.def_param(
-            "header",
-            usage="emit header record before query results",
-            valid_values={"true", "false"}, default='false',
-        )
-
-        usage.def_example(expr_tokens=['myquery.sql', 'pgres:mydb'], expect=None)
-        usage.def_example(expr_tokens=["{'query': 'SELECT * from MY_TABLE;'}", 'pgres:mydb'], expect=None)
-        usage.def_example(expr_tokens=["{'query': 'SELECT * FROM pg_catalog.pg_tables;'}", 'pgres:mydb'], expect=None)
-        return usage
+class PostgresPipe(QueryPipe,Integration):
+    name = 'pgres'
+    desc = "Postgres query pipe; executes SQL from input."
+    arg0 = ("dbname", 'database name.')
+    examples = [
+        ['myquery.sql', 'pgres:mydb', '-'],
+        ["{'query': 'SELECT * from MY_TABLE;'}", 'pgres:mydb', '-'],
+        ["{'query': 'SELECT * FROM pg_catalog.pg_tables;'}", 'pgres:mydb']
+    ]
 
     def __init__(self, ptok: ParsedToken, usage: Usage):
         super().__init__(ptok, usage)
@@ -118,16 +106,14 @@ class PostgresPipe(Pipe):
         lookups = Lookups(self)
         self.dbname = usage.get_arg("dbname")
 
-        db_params = lookups.get(self.dbname)
-        self.db_host = db_params.get("host")
-        self.db_user = db_params.get("user")
-        self.db_pass = db_params.get("password")
-        self.db_port = int(db_params.get("port", 5432))
-        self.db_ssl  = bool(db_params.get("ssl", False))
+        self.db_host = self.lookup_params.get("host")
+        self.db_user = self.lookup_params.get("user")
+        self.db_pass = self.lookup_params.get("password")
+        self.db_port = int(self.lookup_params.get("port", 5432))
+        self.db_ssl  = bool(self.lookup_params.get("ssl", False))
 
-        self.query_field  = "query"   # SQL string
+        self.query_field  = usage.get_param('query_field')
         self.params_field = "params"  # optional: list/tuple (positional) or dict (named)
-        self.do_header = usage.get_param("header") == "true"
 
     def reset(self):
         # stateless across reset
@@ -139,7 +125,6 @@ class PostgresPipe(Pipe):
         Figures out result, rowcount, function automatically.
         """
         h = {
-            "query": query,
             "db": self.dbname,
             "dbhost": self.db_host,
         }
@@ -159,9 +144,9 @@ class PostgresPipe(Pipe):
             h["result"] = "ok"
             h["rowcount"] = cur.rowcount
 
-        return {"header": h}
+        return h
 
-    def __iter__(self):
+    def execute_query_returning_Q_xR_iterable(self, record):
         client = DBClient(
             host=self.db_host,
             username=self.db_user,
@@ -171,12 +156,12 @@ class PostgresPipe(Pipe):
             ssl=self.db_ssl,
         )
         try:
-            for input_record in self.left:
-                query = input_record.get(self.query_field)
-                if not query:
-                    yield {"_error": "missing query"}
-                    continue
-                params = input_record.get(self.params_field)
+            query = record.get(self.query_field)
+            if not query:
+                    record['_error'] = 'missing query'
+                    yield record
+            else:        
+                params = record.get(self.params_field)
 
                 cur = client.conn.cursor()
                 try:
@@ -190,8 +175,7 @@ class PostgresPipe(Pipe):
                             cur.execute(query, (params,))
 
                     # yield header first
-                    if self.do_header:
-                        yield self._make_header(cur, query, params)
+                    yield self._make_header(cur, query, params)
 
                     # then stream rows if it was a real SELECT with results
                     if cur.description:

python_jack_knife-0.6.2/src/pjk/integrations/snowflake_pipe.py

@@ -0,0 +1,258 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 Mike Schultz
+#
+# djk/pipes/snowflake_pipe.py
+
+import base64
+import datetime as _dt
+import uuid
+from decimal import Decimal
+from typing import Any, Dict, Optional
+
+from pjk.base import ParsedToken, Usage, TokenError, Integration
+from pjk.pipes.query_pipe import QueryPipe
+
+
+# ---------- utilities ----------
+
+def _iso_dt(x: _dt.datetime) -> str:
+    """ISO 8601; normalize UTC offset to 'Z' for UTC."""
+    s = x.isoformat()
+    return s.replace("+00:00", "Z")
+
+
+def normalize(obj: Any) -> Any:
+    """
+    Make values JSON/YAML-safe and portable (schema-agnostic):
+      - Decimal -> exact string (no sci-notation)
+      - date/datetime/time -> ISO-8601 string (datetime keeps offset; UTC -> 'Z')
+      - UUID -> string
+      - bytes -> base64 string
+      - lists/tuples/sets, dicts -> normalized recursively
+      - leaves int/float/str/bool/None as-is
+    """
+    if obj is None:
+        return None
+    if isinstance(obj, Decimal):
+        return format(obj, "f")
+    if isinstance(obj, _dt.datetime):
+        return _iso_dt(obj)
+    if isinstance(obj, (_dt.date, _dt.time)):
+        return obj.isoformat()
+    if isinstance(obj, uuid.UUID):
+        return str(obj)
+    if isinstance(obj, (bytes, bytearray, memoryview)):
+        return base64.b64encode(bytes(obj)).decode("ascii")
+    if isinstance(obj, dict):
+        return {k: normalize(v) for k, v in obj.items()}
+    if isinstance(obj, (list, tuple, set)):
+        return [normalize(v) for v in obj]
+    return obj
+
+
+def _row_to_dict(cursor, row) -> Dict[str, Any]:
+    cols = [d[0] for d in cursor.description]
+    return {col: normalize(val) for col, val in zip(cols, row)}
+
+
+def _get_any(params: Dict[str, Any], *keys: str) -> Optional[Any]:
+    """
+    Fetch a value from params using any of the provided keys,
+    trying case variants and optional SNOWFLAKE_ prefix.
+    """
+    variants = []
+    for k in keys:
+        variants.extend([
+            k, k.lower(), k.upper(),
+            f"snowflake_{k}".lower(), f"SNOWFLAKE_{k}".upper()
+        ])
+    for v in variants:
+        if v in params:
+            return params[v]
+    return None
+
+
+# ---------- client ----------
+
+class SnowflakeClient:
+    """
+    Simple connection wrapper for snowflake-connector-python.
+    One connection per client instance (safer than sharing across threads).
+    """
+    def __init__(
+        self,
+        *,
+        account: str,
+        user: str,
+        password: Optional[str] = None,
+        authenticator: Optional[str] = None,   # e.g. 'externalbrowser', 'oauth', 'snowflake'
+        role: Optional[str] = None,
+        warehouse: Optional[str] = None,
+        database: Optional[str] = None,
+        schema: Optional[str] = None
+    ):
+        import snowflake.connector  # lazy import
+
+        kwargs: Dict[str, Any] = {
+            "account": account,
+            "user": user,
+        }
+        if password:
+            kwargs["password"] = password
+        if authenticator:
+            kwargs["authenticator"] = authenticator
+        if role:
+            kwargs["role"] = role
+        if warehouse:
+            kwargs["warehouse"] = warehouse
+        if database:
+            kwargs["database"] = database
+        if schema:
+            kwargs["schema"] = schema
+
+        try:
+            self.conn = snowflake.connector.connect(**kwargs)
+            # autocommit is True by default; make explicit
+            self.conn.autocommit(True)
+            # Apply explicit USE statements as a safety net (only if provided)
+            with self.conn.cursor() as cur:
+                if role:
+                    cur.execute(f'USE ROLE "{role}"')
+                if warehouse:
+                    cur.execute(f'USE WAREHOUSE "{warehouse}"')
+                if database:
+                    cur.execute(f'USE DATABASE "{database}"')
+                if schema:
+                    cur.execute(f'USE SCHEMA "{schema}"')
+        except Exception as e:
+            print("Failed to connect to Snowflake")
+            raise e
+
+    def close(self):
+        if getattr(self, "conn", None) is not None:
+            try:
+                self.conn.close()
+            finally:
+                self.conn = None
+
+
+# ---------- pipe ----------
+
+class SnowflakePipe(QueryPipe, Integration):
+    """
+    Snowflake query pipe; executes SQL found in input record['query'] and streams rows.
+    Connection/session settings are pulled from ~/.pjk/lookups.yaml under the arg name.
+    """
+    name = 'snowflake'
+    desc = "Snowflake query pipe; executes an SQL query for each input record."
+    arg0 = ('dbname', 'database name.')
+    examples = [
+        ["{'query': 'SELECT CURRENT_ROLE();'}", "snow:EDLDB", "-"],
+        ["myquery.sql", "snow:EDLDB", "-"]
+    ]
+
+    def __init__(self, ptok: ParsedToken, usage: Usage):
+        super().__init__(ptok, usage)
+
+        self.dbname = usage.get_arg(type(self).arg0[0])
+
+        # Accept both bare keys and SNOWFLAKE_* variants in lookups.yaml
+        self.sf_account  = _get_any(self.lookup_params, "account")
+        self.sf_user     = _get_any(self.lookup_params, "user")
+        self.sf_auth     = _get_any(self.lookup_params, "authenticator")
+        self.sf_role     = _get_any(self.lookup_params, "role")
+        self.sf_wh       = _get_any(self.lookup_params, "warehouse")
+        self.sf_db       = self.dbname
+        self.sf_schema   = _get_any(self.lookup_params, "schema")
+
+        # Basic validation
+        missing = [k for k, v in [
+            ("account", self.sf_account),
+            ("user", self.sf_user),
+            ("authenticator|password", self.sf_auth or self.sf_password),
+            ("role", self.sf_role),
+            ("warehouse", self.sf_wh),
+            ("schema", self.sf_schema),
+        ] if not v]
+        if missing:
+            raise TokenError(
+                f"lookups entry '{self.dbname}' missing: {', '.join(missing)}"
+            )
+
+        self.query_field = usage.get_param('query_field')
+        self.params_field = "params"  # optional: list/tuple (positional) or dict (named)
+
+    def reset(self):
+        # stateless across reset
+        pass
+
+    def _make_header(self, cur, params=None) -> Dict[str, Any]:
+        """
+        Build a header record with query metadata and session context.
+        """
+        h: Dict[str, Any] = {
+            "db": self.dbname,
+            "account": self.sf_account,
+            "role": self.sf_role,
+            "warehouse": self.sf_wh,
+        }
+        if self.sf_db:
+            h["database"] = self.sf_db
+        if self.sf_schema:
+            h["schema"] = self.sf_schema
+        if params is not None:
+            h["params"] = params
+
+        # Snowflake's cursor.rowcount is often -1 for SELECT until fully fetched.
+        # We still include it if known (for DML it may be accurate).
+        try:
+            rc = getattr(cur, "rowcount", None)
+            if isinstance(rc, int) and rc >= 0:
+                h["rowcount"] = rc
+        except Exception:
+            pass
+
+        h["result"] = "ok"
+        return h
+
+    def execute_query_returning_Q_xR_iterable(self, record):
+        client = SnowflakeClient(
+            account=self.sf_account,
+            user=self.sf_user,
+            authenticator=self.sf_auth,
+            role=self.sf_role,
+            warehouse=self.sf_wh,
+            database=self.sf_db,
+            schema=self.sf_schema,
+        )
+        try:
+            query = record.get(self.query_field)
+            if not query:
+                record['_error'] = 'missing query'
+                yield record
+
+            else:
+                params = record.get(self.params_field)
+
+                cur = client.conn.cursor()
+                try:
+                    # Execute (supports positional or named params per DB-API)
+                    if params is None:
+                        cur.execute(query)
+                    else:
+                        if isinstance(params, (list, tuple, dict)):
+                            cur.execute(query, params)
+                        else:
+                            # single scalar -> positional 1-tuple
+                            cur.execute(query, (params,))
+
+                    yield self._make_header(cur, params)
+
+                    # Stream result rows for queries that return a result set
+                    if cur.description:
+                        for row in cur:
+                            yield _row_to_dict(cur, row)
+                finally:
+                    cur.close()
+        finally:
+            client.close()

{python_jack_knife-0.5.5 → python_jack_knife-0.6.2}/src/pjk/man_page.py

@@ -51,8 +51,9 @@ def do_all_man(registry: ComponentRegistry, no_pager: bool = True):
     cm = nullcontext() if no_pager else pager_stdout()
     with cm:
         for factory in registry.get_factories():
-            comp_type = factory.get_comp_type_name()
-            for name in factory.components.keys():
+            #comp_type = factory.get_comp_type_name()
+            component_tuples = factory.get_component_name_class_tuples() # all of them
+            for name, comp_class in component_tuples:
                 usage = factory.get_usage(name)
                 print_man(registry, name, usage)
                 print()
@@ -84,7 +85,7 @@ def do_examples(token:str, registry: ComponentRegistry):
     with cm:
         for factory in registry.get_factories():
             comp_type = factory.get_comp_type_name()
-            for name, comp_class in factory.components.items():
+            for name, comp_class in factory.get_component_name_class_tuples():
                 usage = comp_class.usage()
 
                 comp_type = usage.get_base_class(as_string=True)