cql2 0.2.0__cp39-none-win_amd64.whl

cql2/__init__.py

@@ -0,0 +1,5 @@
+from .cql2 import *
+
+__doc__ = cql2.__doc__
+if hasattr(cql2, "__all__"):
+    __all__ = cql2.__all__

cql2/__init__.pyi

@@ -0,0 +1,98 @@
+from typing import Any
+from os import PathLike
+
+class SqlQuery:
+    """A SQL query"""
+
+    query: str
+    """The query, with parameterized fields."""
+
+    params: list[str]
+    """The parameters, to use for binding."""
+
+class Expr:
+    @staticmethod
+    def from_path(path: PathLike | str) -> Expr:
+        """Reads CQL2 from a filesystem path.
+
+        Args:
+            path (PathLike | str): The input path
+
+        Returns:
+            Expr: The CQL2 expression
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr.from_path("fixtures/text/example01.txt")
+        """
+
+    def __init__(self, cql2: str | dict[str, Any]) -> None:
+        """A CQL2 expression.
+
+        The cql2 can either be a cql2-text string, a cql2-json string, or a
+        cql2-json dictionary.
+
+        Args:
+            cql2 (str | dict[str, Any]): The input CQL2
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr("landsat:scene_id = 'LC82030282019133LGN00'")
+            >>> expr = Expr({"op":"=","args":[{"property":"landsat:scene_id"},"LC82030282019133LGN00"]})
+        """
+
+    def validate(self) -> None:
+        """Validates this expression using json-schema.
+
+        Raises:
+            ValidationError: Raised if the validation fails
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr("landsat:scene_id = 'LC82030282019133LGN00'")
+            >>> expr.validate()
+        """
+
+    def to_json(self) -> dict[str, Any]:
+        """Converts this cql2 expression to a cql2-json dictionary.
+
+        Returns:
+            dict[str, Any]: The cql2-json
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr("landsat:scene_id = 'LC82030282019133LGN00'")
+            >>> expr.to_json()
+            {'op': '=', 'args': [{'property': 'landsat:scene_id'}, 'LC82030282019133LGN00']}
+        """
+
+    def to_text(self) -> str:
+        """Converts this cql2 expression to cql2-text.
+
+        Returns:
+            str: The cql2-text
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr({"op":"=","args":[{"property":"landsat:scene_id"},"LC82030282019133LGN00"]})
+            >>> expr.to_text()
+            '("landsat:scene_id" = \'LC82030282019133LGN00\')'
+        """
+
+    def to_sql(self) -> SqlQuery:
+        """Converts this cql2 expression to a SQL query.
+
+        Returns:
+            SqlQuery: The SQL query and parameters
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr("landsat:scene_id = 'LC82030282019133LGN00'")
+            >>> q.query
+            '("landsat:scene_id" = $1)'
+            >>> q.params
+            ['LC82030282019133LGN00']
+        """
+
+class ValidationError(Exception):
+    """An error raised when cql2 json-schema validation fails."""

cql2-0.2.0.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.3
+Name: cql2
+Version: 0.2.0
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Summary: Parse, validate, and convert Common Query Language (CQL2) text and JSON
+Keywords: cql2
+Home-Page: https://github.com/developmentseed/cql2-rs
+Author: David Bitner <bitner@dbspatial.com>
+Author-email: David Bitner <bitner@dbspatial.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Source Code, https://github.com/developmentseed/cql2-rs
+
+# cql2
+
+Python library and command-line interface (CLI) for parsing and converting [Common Query Language (CQL2)](https://www.ogc.org/standard/cql2/), with Rust under the hood.
+
+## Usage
+
+```shell
+pip install cql2
+```
+
+Then:
+
+```python
+expr = Expr("landsat:scene_id = 'LC82030282019133LGN00'")
+# or
+expr = Expr.from_path("fixtures/text/example01.txt")
+
+s = expr.to_text()
+d = expr.to_json()
+sql = expr.to_sql()
+print("SQL query:", sql.query)
+print("SQL params:", sql.params)
+```
+
+Or from via the command-line interface:
+
+```shell
+$ cql2 -o json "landsat:scene_id = 'LC82030282019133LGN00'"
+{"op":"=","args":[{"property":"landsat:scene_id"},"LC82030282019133LGN00"]}
+```
+
+## Developing
+
+To install the package to your virtual environment and test:
+
+```shell
+maturin develop --uv -m python/Cargo.toml && pytest python
+```
+
+## More information
+
+This package is part of [cql2-rs](https://github.com/developmentseed/cql2-rs/), see that repo for license and contributing information.
+

cql2-0.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+cql2-0.2.0.dist-info/METADATA,sha256=et9Y2UMQT4ZDAQ9tHr7K14ebDysFId2sRpA2LYJ3qq0,1669
+cql2-0.2.0.dist-info/WHEEL,sha256=lukeIsDTsE1YVI71QKxojI1jBuBmCbLW3hTRwIrKSOQ,94
+cql2-0.2.0.dist-info/entry_points.txt,sha256=71myRgqcjlXJ5L8YfBsyaQS-Ef8mXeSlOCDwf1rrURo,33
+cql2/__init__.py,sha256=lQIzMwXTmBW1tLuKrIKf3_nxwWMiik5UOd5CBYV22uQ,99
+cql2/__init__.pyi,sha256=miTY8X4iZPkrK0mDwAOCYeraooLIF15Dbe41j2xgJSU,2932
+cql2/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cql2/cql2.cp39-win_amd64.pyd,sha256=qA1vjjFISUTBO-7vvdy5fT_MzCO4FU3usYuSF5SW8e0,4515328
+cql2-0.2.0.dist-info/RECORD,,

cql2-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.7.4)
+Root-Is-Purelib: false
+Tag: cp39-none-win_amd64

cql2-0.2.0.dist-info/entry_points.txt

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