sqlcompose 0.0.0__py3-none-any.whl → 0.0.2__py3-none-any.whl

sqlcompose/__init__.py

@@ -1,6 +1,10 @@
 from sqlcompose.core.functions import load, loads
+from sqlcompose.core.circular_dependency_error import CircularDependencyError
 
 __all__ = [
     'load',
     'loads',
-]
+    'CircularDependencyError',
+]
+__package_name__ = "sqlcompose"
+__version__ = "0.0.2"

sqlcompose/__main__.py

@@ -1,30 +1,13 @@
-from os import path
-from sys import exit
-from argparse import ArgumentParser
+from sys import argv, exit, stderr, stdout
+from sqlcompose.core.app import app
 
-from sqlcompose.core.functions import load, loads
 
+if __name__ == "__main__":
+    result, code = app(argv[1:])
 
-def main():
-    try:
-        parser = ArgumentParser(prog = "sqlcompose")
-        parser.add_argument("input", type=str, help = "SQL expression or location of an SQL file")
-        pargs = parser.parse_args()
-
-        if path.isfile(pargs.input):
-            sql = load(pargs.input)
-        else:
-            sql = loads(pargs.input)
-
-        print(sql)
-
-        return
-    except SystemExit:
-        raise # let argparse print error(s)
-    except Exception as ex:
-        print(f"Unexpected error: {ex}")
-        exit(1)
-
+    if code == 0:
+        stdout.write(result)
+    else:
+        stderr.write(result)
 
-if __name__ == "__main__":
-    main()
+    exit(code)

sqlcompose/core/app.py

@@ -0,0 +1,22 @@
+from os import path
+from argparse import ArgumentParser
+
+from sqlcompose.core.functions import load, loads
+
+
+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 path.isfile(pargs.input):
+            sql = load(pargs.input)
+        else:
+            sql = loads(pargs.input)
+
+        return sql, 0
+    except SystemExit as ex:
+        return str(ex), 2
+    except Exception as ex: # pragma: no cover
+        return f"Unexpected error: {ex}", 1

sqlcompose/core/circular_dependency_error.py

@@ -0,0 +1,2 @@
+class CircularDependencyError(Exception):
+    ...

sqlcompose/core/functions.py

@@ -1,9 +1,10 @@
 from os import path
-from typing import Sequence, MutableSequence, MutableMapping, cast
+from typing import Sequence
 from os import path
 from re import compile, sub, escape, IGNORECASE
 from textwrap import indent
 
+from sqlcompose.core.circular_dependency_error import CircularDependencyError
 from sqlcompose.core.include import Include
 from sqlcompose.core.compat import fix_path, get_relative_path
 
@@ -19,7 +20,7 @@ def loads(sql: str) -> str:
     Returns:
         str: The composed query
     """
-    return cast(str, compose(sql, "SQL", path.curdir, path.curdir))
+    return compose(sql, "SQL", path.curdir, path.curdir)
 
 
 def load(filename: str) -> str:
@@ -40,7 +41,7 @@ def load(filename: str) -> str:
 
 
     with open(filename, "r", encoding="utf-8") as file:
-        return cast(str, compose(file.read(), filename, filename, path.dirname(filename)))
+        return compose(file.read(), filename, filename, path.dirname(filename))
 
 
 def compose(
@@ -49,52 +50,55 @@ def compose(
     file_path: str,
     root: str,
     level: int = 1,
-    included: MutableSequence[str] | None = None,
-    included1: MutableMapping[str, tuple[str, int]] | None = None
-) -> str | None:
+    stack: list[str] | None = None
+) -> str:
 
     file_path = fix_path(file_path)
-    included = included or []
-    included1 = included1 or {}
+    stack = stack or []
+    parent = stack[-1] if stack else None
+    name = get_relative_path(name, root)
+    index = 1
+    included: list[str] = []
     includes: list[Include] = []
-    parent = included[len(included)-2] if len(included) > 1 else None
+    stack.append(name)
 
-    if name in included and included1[name][1] == level:
-        #duplicate include at the same level - return none, to use the previously composed SQL
-        return None
-    elif name in included:
-        raise Exception(f"Circular dependency detected: File \"{get_relative_path(file_path, root)}\" has already been already included")
-    else:
-        included.append(name)
-        included1[name] = (file_path, level)
-
-    index = 1
+    if len(stack) > 1 and name in (stack[1:-1]):
+        raise CircularDependencyError
 
     for match in REGEX_INCLUDE.finditer(sql):
         file_path_inner = fix_path(path.join(path.dirname(file_path), match.group(1)))
-        try:
-            with open(file_path_inner, "r", encoding="utf-8") as file:
-                composed = compose(file.read(), match.group(1), file_path_inner, root, level=level+1)
-        except FileNotFoundError:
-            if not parent is None:
-                raise FileNotFoundError(f"Include failed: File \"{get_relative_path(file_path_inner, root)}\" which was referred to in \"{get_relative_path(parent, root)}\", was not found...")
-            else:
-                raise FileNotFoundError(f"Include failed: File \"{get_relative_path(file_path_inner, root)}\" was not found...")
-
-        if composed is not None:
-            includes.append(
-                Include(
-                    composed,
-                    f"Q_{level}_{index}",
-                    match.group(0),
-                    match.group(1)
+        if file_path_inner not in included:
+            included.append(file_path_inner)
+            try:
+                with open(file_path_inner, "r", encoding="utf-8") as file:
+                    composed = compose(
+                        file.read(),
+                        match.group(1),
+                        file_path_inner,
+                        root,
+                        level + 1,
+                        stack
+                    )
+                includes.append(
+                    Include(
+                        composed,
+                        f"Q_{level}_{index}",
+                        match.group(0),
+                        match.group(1)
+                    )
                 )
-            )
-            index = index + 1
+                index = index + 1
+            except FileNotFoundError:
+                if parent is not None:
+                    raise FileNotFoundError(f"Include failed: File \"{get_relative_path(file_path_inner, root)}\" which was referred to in \"{get_relative_path(parent, root)}\", was not found...")
+                else:
+                    raise FileNotFoundError(f"Include failed: File \"{get_relative_path(file_path_inner, root)}\" was not found...")
 
     for include in includes:
         sql = sub(escape(include.match), include.name, sql)
 
+    stack.pop()
+
     return wrap_cte_sql(includes, sql, level, name)
 
 def wrap_cte_sql(includes: Sequence[Include], sql: str, level: int, source: str) -> str:

sqlcompose/core/include.py

@@ -20,5 +20,5 @@ class Include():
         return self.__match
 
     @property
-    def source(self) -> str:
+    def source(self) -> str: # pragma: no cover
         return self.__source

{sqlcompose-0.0.0.dist-info → sqlcompose-0.0.2.dist-info}/METADATA

@@ -1,29 +1,54 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: sqlcompose
-Version: 0.0.0
-Summary: 
+Version: 0.0.2
+Summary: Composition of linked SQL files
+Author-email: Anders Madsen <anders.madsen@alphavue.com>
 License: MIT
-Author: Anders Madsen
-Author-email: anders.madsen@alphavue.com
-Requires-Python: >=3.10,<=3.13
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
+Project-URL: repository, https://github.com/apmadsen/sqlcompose
+Keywords: sql,composition,windows,linux
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 6 - Mature
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Project-URL: Repository, https://github.com/apmadsen/sqlcompose
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest>=8.3.0; extra == "test"
+Requires-Dist: pytest-cov>=6.1.0; 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)
+[![Coverage](https://github.com/apmadsen/sqlcompose/actions/workflows/python-test-coverage.yml/badge.svg)](https://github.com/apmadsen/sqlcompose/actions/workflows/python-test-coverage.yml)
+![Stable Version](https://img.shields.io/pypi/v/sqlcompose?label=stable&sort=semver&color=blue)
+![Pre-release Version](https://img.shields.io/github/v/release/apmadsen/sqlcompose?label=pre-release&include_prereleases&sort=semver&color=blue)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/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.
 
 ## Examples
 __Execute the script directly:__
-```
+```console
 sqlcompose query.sql
-sqlcompose "select * from $INCLUDE(included-query1.sql)"
+```
+```bash
+sqlcompose 'select * from $INCLUDE(included-query1.sql)' # on linux
+sqlcompose "select * from $INCLUDE(included-query1.sql)" # on windows
 ```
 
 __Import it in another script:__
@@ -84,4 +109,3 @@ WITH Q_1_1 AS (
 )
 SELECT * FROM Q_1
 ```
-

sqlcompose-0.0.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+sqlcompose/__init__.py,sha256=Qh82ZdC3xjE6-a-BnwViHMgXRGuIeO3Sdp0SMKv5Ku4,252
+sqlcompose/__main__.py,sha256=8-S7mIkyEbI2lYLhB_spSa6EAOHdSIkZqoQuFA2UNIM,244
+sqlcompose/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sqlcompose/core/app.py,sha256=3QstrdKsuTd59xtciwU9bVE8ndwC9V2wu4H_tgZU2DU,650
+sqlcompose/core/circular_dependency_error.py,sha256=3JqXYqX4Qg5QC4te2IuiqU2snC2oU--g9m1qFah4A38,49
+sqlcompose/core/compat.py,sha256=pIF8Lk-5MhwAlHD4_RCMXYOxiDyTJIA5nlbR5_Dyw0g,819
+sqlcompose/core/functions.py,sha256=13960AR1GRJsoUwfI6g53opPYEcgoCdzVE7W2mcMbOw,3622
+sqlcompose/core/include.py,sha256=0k5hyO0U_cYbj8iByIQoOF_YQb3kdRgegZVsYiMU2Vg,560
+sqlcompose-0.0.2.dist-info/licenses/LICENSE,sha256=WtJk2ScYuo_lEP42z3DYU191mO2oU8z00nPsL9KAWCQ,1063
+sqlcompose-0.0.2.dist-info/METADATA,sha256=F_iENCopEl7xrVlVBzCBPmirfWO78vcPB_BQyEuskx4,3756
+sqlcompose-0.0.2.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+sqlcompose-0.0.2.dist-info/entry_points.txt,sha256=8-odh3ht86pH5a3UaGM0CNwyVT4upBILl6HU8SVPLPs,52
+sqlcompose-0.0.2.dist-info/top_level.txt,sha256=-8g6qpTAzLcUSsbk3v6mgNbY34pJ2LIplugBVYB5Jq0,11
+sqlcompose-0.0.2.dist-info/RECORD,,

{sqlcompose-0.0.0.dist-info → sqlcompose-0.0.2.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: setuptools (80.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

sqlcompose-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sqlcompose = sqlcompose.main:main

sqlcompose-0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+sqlcompose

sqlcompose-0.0.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-sqlcompose/__init__.py,sha256=yAFSzkLv3bCZ6e4OWvws6aYjwHfLQcxhGVzK12Fs_CQ,89
-sqlcompose/__main__.py,sha256=5TpsgP8V1SC14siCyUcHdEYWm9vDwxaUtqUgCC5f_4w,691
-sqlcompose/core/compat.py,sha256=pIF8Lk-5MhwAlHD4_RCMXYOxiDyTJIA5nlbR5_Dyw0g,819
-sqlcompose/core/functions.py,sha256=eHK_STVYOGDn3dtShTa0xaasYQi220tF12bQH9qEEUI,3693
-sqlcompose/core/include.py,sha256=ejNaz2p2Lq1pUnwMxtBqE4p_hBOtG8OynqRpECLEbNQ,541
-sqlcompose-0.0.0.dist-info/LICENSE,sha256=WtJk2ScYuo_lEP42z3DYU191mO2oU8z00nPsL9KAWCQ,1063
-sqlcompose-0.0.0.dist-info/METADATA,sha256=dPh6avQdIOJ6NO20-Z3h8iRUEFM8VtVEzxSPhjcOqrk,2269
-sqlcompose-0.0.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-sqlcompose-0.0.0.dist-info/entry_points.txt,sha256=N3eGXJzvw5yx5WgFFmX0L6Nw0-ojm90OfhtlC-C6t_4,51
-sqlcompose-0.0.0.dist-info/RECORD,,

sqlcompose-0.0.0.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-sqlcompose=sqlcompose.main:main
-