sqlcompose 0.0.4a1__tar.gz → 0.0.4a2__tar.gz

{sqlcompose-0.0.4a1/src/sqlcompose.egg-info → sqlcompose-0.0.4a2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: sqlcompose
-Version: 0.0.4a1
-Summary: Composition of linked SQL files
+Version: 0.0.4a2
+Summary: Composition of SQL files
 Author-email: Anders Madsen <anders.madsen@alphavue.com>
 License-Expression: MIT
 Project-URL: repository, https://github.com/apmadsen/sqlcompose
@@ -29,6 +29,7 @@ License-File: LICENSE
 Provides-Extra: test
 Requires-Dist: pytest>=8.3.0; extra == "test"
 Requires-Dist: pytest-cov>=6.1.0; extra == "test"
+Requires-Dist: pytest-mock>=3.15; extra == "test"
 Dynamic: license-file
 
 [![Test](https://github.com/apmadsen/sqlcompose/actions/workflows/python-test.yml/badge.svg)](https://github.com/apmadsen/sqlcompose/actions/workflows/python-test.yml)
@@ -38,19 +39,33 @@ Dynamic: license-file
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sqlcompose)
 [![PyPI Downloads](https://static.pepy.tech/badge/sqlcompose/week)](https://pepy.tech/projects/sqlcompose)
 
-# sqlcompose: Composition of linked SQL files
-sqlcompose allows you to compose sql files from multiple files by introducing `INCLUDE` keywords. The SQL output is composed as CTE's or Common Table Expressions.
+# sqlcompose: Composition of SQL files
+sqlcompose lets you to compose sql files from multiple files by introducing `$INCLUDE` keywords. The SQL output is composed as CTE's or Common Table Expressions.
+
+Using composition, you reduce both complexity and duplication of code thus adhering to the DRY principle.
+
+### SQL Dialect
+sqlcompose outputs SQL as standard ANSI SQL. Note though, that no validation is done on either the input or the output.
 
 ## Examples
-__Execute the script directly:__
-```console
+
+### 1. Execute the script with the filename as an argument and output to the console:
+```bash
 sqlcompose query.sql
 ```
+
+### 2. Pipe data into application and output to a file
+```bash
+cat query.sql | sqlcompose > output.sql
+```
+
+### 3. Execute the script with SQL string as argument
 ```bash
 sqlcompose 'select * from $INCLUDE(included-query1.sql)'
 ```
+> NOTE: Different consoles have different limitations, so you may have to switch from single to double quotes to allow for using the dollar sign.
 
-__Import it in another script:__
+### 4. Import it in another python application or package
 ```python
 from sqlcompose import load, loads
 # method 1 : loading from a file

{sqlcompose-0.0.4a1 → sqlcompose-0.0.4a2}/README.md

@@ -5,19 +5,33 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sqlcompose)
 [![PyPI Downloads](https://static.pepy.tech/badge/sqlcompose/week)](https://pepy.tech/projects/sqlcompose)
 
-# sqlcompose: Composition of linked SQL files
-sqlcompose allows you to compose sql files from multiple files by introducing `INCLUDE` keywords. The SQL output is composed as CTE's or Common Table Expressions.
+# sqlcompose: Composition of SQL files
+sqlcompose lets you to compose sql files from multiple files by introducing `$INCLUDE` keywords. The SQL output is composed as CTE's or Common Table Expressions.
+
+Using composition, you reduce both complexity and duplication of code thus adhering to the DRY principle.
+
+### SQL Dialect
+sqlcompose outputs SQL as standard ANSI SQL. Note though, that no validation is done on either the input or the output.
 
 ## Examples
-__Execute the script directly:__
-```console
+
+### 1. Execute the script with the filename as an argument and output to the console:
+```bash
 sqlcompose query.sql
 ```
+
+### 2. Pipe data into application and output to a file
+```bash
+cat query.sql | sqlcompose > output.sql
+```
+
+### 3. Execute the script with SQL string as argument
 ```bash
 sqlcompose 'select * from $INCLUDE(included-query1.sql)'
 ```
+> NOTE: Different consoles have different limitations, so you may have to switch from single to double quotes to allow for using the dollar sign.
 
-__Import it in another script:__
+### 4. Import it in another python application or package
 ```python
 from sqlcompose import load, loads
 # method 1 : loading from a file

{sqlcompose-0.0.4a1 → sqlcompose-0.0.4a2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "sqlcompose"
 dynamic = ["version"]
-description = "Composition of linked SQL files"
+description = "Composition of SQL files"
 keywords = ["sql", "composition", "windows", "linux"]
 readme = "README.md"
 authors = [
@@ -28,7 +28,9 @@ classifiers = [
     "Topic :: Software Development :: Libraries",
     "Typing :: Typed"
 ]
-dependencies = []
+dependencies = [
+
+]
 requires-python = ">= 3.10, < 3.15"
 
 [project.urls]
@@ -41,6 +43,7 @@ repository = "https://github.com/apmadsen/sqlcompose"
 test = [
     "pytest>=8.3.0",
     "pytest-cov>=6.1.0",
+    "pytest-mock>=3.15"
 ]
 
 [tool.setuptools-git-versioning]
@@ -48,4 +51,4 @@ enabled = true
 
 [build-system]
 requires = ["setuptools >= 77.0.3", "setuptools-git-versioning >= 2.1.0"]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"

sqlcompose-0.0.4a2/src/sqlcompose/core/app.py

@@ -0,0 +1,30 @@
+from argparse import ArgumentParser
+
+from sqlcompose.core.functions import load, loads
+from sqlcompose.core.compat import is_file, get_piped_input
+from sqlcompose.core.file_not_found_err import FileNotFoundErr
+
+
+def app(args: list[str]) -> tuple[str, int]:
+    try:
+        from sys import stdin # iport must be done here to allow for test patching
+
+        if not stdin.isatty() and ( piped := get_piped_input(stdin) ):
+            sql = loads(piped)
+        else:
+            parser = ArgumentParser(prog = "sqlcompose")
+            parser.add_argument("input", type=str, help = "SQL expression or location of an SQL file")
+            pargs = parser.parse_args(args)
+
+            if is_file(pargs.input):
+                sql = load(pargs.input)
+            else:
+                sql = loads(pargs.input)
+
+        return sql, 0
+    except SystemExit as ex:
+        return str(ex), 2
+    except (FileNotFoundErr, FileNotFoundError) as ex:
+        return str(ex), 3
+    except Exception as ex: # pragma: no cover
+        return f"Unexpected error: {ex}", 1

{sqlcompose-0.0.4a1 → sqlcompose-0.0.4a2}/src/sqlcompose/core/compat.py

@@ -1,5 +1,7 @@
 from os import path, sep
+from typing import TextIO
 from re import compile
+from threading import Thread, Event
 
 RX_FILE = compile(r"^[\w,\s-]+\.[A-Za-z]{3}$")
 WINDOWS_PATH_SEP = "\\"
@@ -42,3 +44,32 @@ def is_file(text: str) -> bool:
         return True
 
     return False
+
+def get_piped_input(pipe: TextIO) -> str:
+    """Reads input from pipe (usually sys.stdin) without blocking.
+    """
+    output: list[str] = []
+    ev_started = Event()
+    ev_done = Event()
+
+    def fn(output: list[str]):
+        try:
+            ev_started.set()
+            output.append(pipe.read())
+        except OSError:
+            pass
+        finally:
+            ev_done.set()
+
+    thread = Thread(target = fn, args = (output,))
+    thread.start()
+
+    ev_started.wait()
+
+    if ev_done.wait(0.1): # if there is in fact anything in the pipe, we expect it to be read within 0.1 second
+        thread.join()
+    else:
+        pass # pragma: no cover
+        # the thread will block indefinitely, nothing to do about it
+
+    return output[0] if any(output) else ""

{sqlcompose-0.0.4a1 → sqlcompose-0.0.4a2/src/sqlcompose.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: sqlcompose
-Version: 0.0.4a1
-Summary: Composition of linked SQL files
+Version: 0.0.4a2
+Summary: Composition of SQL files
 Author-email: Anders Madsen <anders.madsen@alphavue.com>
 License-Expression: MIT
 Project-URL: repository, https://github.com/apmadsen/sqlcompose
@@ -29,6 +29,7 @@ License-File: LICENSE
 Provides-Extra: test
 Requires-Dist: pytest>=8.3.0; extra == "test"
 Requires-Dist: pytest-cov>=6.1.0; extra == "test"
+Requires-Dist: pytest-mock>=3.15; extra == "test"
 Dynamic: license-file
 
 [![Test](https://github.com/apmadsen/sqlcompose/actions/workflows/python-test.yml/badge.svg)](https://github.com/apmadsen/sqlcompose/actions/workflows/python-test.yml)
@@ -38,19 +39,33 @@ Dynamic: license-file
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sqlcompose)
 [![PyPI Downloads](https://static.pepy.tech/badge/sqlcompose/week)](https://pepy.tech/projects/sqlcompose)
 
-# sqlcompose: Composition of linked SQL files
-sqlcompose allows you to compose sql files from multiple files by introducing `INCLUDE` keywords. The SQL output is composed as CTE's or Common Table Expressions.
+# sqlcompose: Composition of SQL files
+sqlcompose lets you to compose sql files from multiple files by introducing `$INCLUDE` keywords. The SQL output is composed as CTE's or Common Table Expressions.
+
+Using composition, you reduce both complexity and duplication of code thus adhering to the DRY principle.
+
+### SQL Dialect
+sqlcompose outputs SQL as standard ANSI SQL. Note though, that no validation is done on either the input or the output.
 
 ## Examples
-__Execute the script directly:__
-```console
+
+### 1. Execute the script with the filename as an argument and output to the console:
+```bash
 sqlcompose query.sql
 ```
+
+### 2. Pipe data into application and output to a file
+```bash
+cat query.sql | sqlcompose > output.sql
+```
+
+### 3. Execute the script with SQL string as argument
 ```bash
 sqlcompose 'select * from $INCLUDE(included-query1.sql)'
 ```
+> NOTE: Different consoles have different limitations, so you may have to switch from single to double quotes to allow for using the dollar sign.
 
-__Import it in another script:__
+### 4. Import it in another python application or package
 ```python
 from sqlcompose import load, loads
 # method 1 : loading from a file

{sqlcompose-0.0.4a1 → sqlcompose-0.0.4a2}/src/sqlcompose.egg-info/requires.txt

@@ -2,3 +2,4 @@
 [test]
 pytest>=8.3.0
 pytest-cov>=6.1.0
+pytest-mock>=3.15

{sqlcompose-0.0.4a1 → sqlcompose-0.0.4a2}/tests/test_app.py

@@ -1,7 +1,10 @@
 # ruff: noqa
 # pyright: basic
-from os import path
+from os import path, chdir, curdir
+from sys import stdin
+from io import StringIO
 from pytest import fixture, raises as assert_raises
+from pytest_mock import MockerFixture
 
 from sqlcompose.core.app import app
 
@@ -29,3 +32,17 @@ def test_sql():
     result, code = app([f"SELECT * FROM $INCLUDE({path.join('tests', 'main-query.sql')})"])
     assert len(result) > 0
     assert code == 0
+
+def test_pipe(mocker: MockerFixture):
+    chdir("tests")
+    try:
+        with open("main-query.sql", "rt", encoding="utf8") as input:
+            mocker.patch(f"sys.stdin", input)
+            try:
+                result, code = app([])
+                assert len(result) > 0
+                assert code == 0
+            finally:
+                mocker.resetall()
+    finally:
+        chdir("..")

sqlcompose-0.0.4a1/src/sqlcompose/core/app.py

@@ -1,25 +0,0 @@
-from argparse import ArgumentParser
-
-from sqlcompose.core.functions import load, loads
-from sqlcompose.core.compat import is_file
-from sqlcompose.core.file_not_found_err import FileNotFoundErr
-
-
-def app(args: list[str]) -> tuple[str, int]:
-    try:
-        parser = ArgumentParser(prog = "sqlcompose")
-        parser.add_argument("input", type=str, help = "SQL expression or location of an SQL file")
-        pargs = parser.parse_args(args)
-
-        if is_file(pargs.input):
-            sql = load(pargs.input)
-        else:
-            sql = loads(pargs.input)
-
-        return sql, 0
-    except SystemExit as ex:
-        return str(ex), 2
-    except (FileNotFoundErr, FileNotFoundError) as ex:
-        return str(ex), 3
-    except Exception as ex: # pragma: no cover
-        return f"Unexpected error: {ex}", 1