cql2 0.4.1__cp310-abi3-macosx_11_0_arm64.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,167 @@
+from typing import Any
+from os import PathLike
+
+def parse_file(path: PathLike | str) -> Expr:
+    """Parses CQL2 from a filesystem path.
+
+    Args:
+        path (PathLike | str): The input path
+
+    Returns:
+        Expr: The CQL2 expression
+
+    Examples:
+        >>> from cql2 import Expr
+        >>> expr = Expr.parse_file("fixtures/text/example01.txt")
+    """
+
+def parse_text(s: str) -> Expr:
+    """Parses cql2-text.
+
+    Args:
+        s (str): The cql2-text
+
+    Returns:
+        Expr: The CQL2 expression
+
+    Raises:
+        ParseError: Raised if the string does not parse as cql2-text
+
+    Examples:
+        >>> from cql2 import Expr
+        >>> expr = Expr.parse_text("landsat:scene_id = 'LC82030282019133LGN00'")
+    """
+
+def parse_json(s: str) -> Expr:
+    """Parses cql2-json.
+
+    Args:
+        s (str): The cql2-json string
+
+    Returns:
+        Expr: The CQL2 expression
+
+    Raises:
+        ParseError: Raised if the string does not parse as cql2-json
+
+    Examples:
+        >>> from cql2 import Expr
+        >>> expr = Expr.parse_json('{"op":"=","args":[{"property":"landsat:scene_id"},"LC82030282019133LGN00"]}')
+    """
+
+class Expr:
+    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 matches(self, item: dict[str, Any]) -> bool:
+        """Matches this expression against an item.
+
+        Args:
+            item (dict[str, Any]): The item to match against
+
+        Returns:
+            bool: True if the expression matches the item, False otherwise
+        """
+
+    def reduce(self, item: dict[str, Any] | None = None) -> Expr:
+        """Reduces this expression against an item.
+
+        Args:
+            item (dict[str, Any] | None): The item to reduce against
+
+        Returns:
+            Expr: The reduced expression
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr("true AND true").reduce()
+            >>> expr.to_text()
+            'true'
+        """
+
+    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) -> str:
+        """Converts this cql2 expression to a SQL query.
+
+        Returns:
+            str: The SQL query
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr = Expr("landsat:scene_id = 'LC82030282019133LGN00'")
+            >>> q.query
+            '("landsat:scene_id" = $1)'
+            >>> q.params
+            ['LC82030282019133LGN00']
+        """
+
+    def __add__(self, other: Expr) -> Expr:
+        """Combines two cql2 expressions using the AND operator.
+
+        Args:
+            other (Expr): The other expression
+
+        Returns:
+            Expr: The combined expression
+
+        Examples:
+            >>> from cql2 import Expr
+            >>> expr1 = Expr("landsat:scene_id = 'LC82030282019133LGN00'")
+            >>> expr2 = Expr("landsat:cloud_cover = 10")
+            >>> expr = expr1 + expr2
+        """
+
+class ParseError(Exception):
+    """An error raised when cql2 parsing fails."""
+
+class ValidationError(Exception):
+    """An error raised when cql2 json-schema validation fails."""

cql2-0.4.1.dist-info/METADATA

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: cql2
+Version: 0.4.1
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+License-File: LICENSE
+Home-Page: https://github.com/developmentseed/cql2-rs
+Requires-Python: >=3.10

cql2-0.4.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+cql2-0.4.1.dist-info/METADATA,sha256=jsRhL9bN4G53ID3cTBULcr0XEo4sex_hHiZwrugRUQI,585
+cql2-0.4.1.dist-info/WHEEL,sha256=-lwEpi49KOTCcgx48T3fLSP8Dxynwa-iRMZNo-JZaqc,103
+cql2-0.4.1.dist-info/entry_points.txt,sha256=71myRgqcjlXJ5L8YfBsyaQS-Ef8mXeSlOCDwf1rrURo,33
+cql2-0.4.1.dist-info/licenses/LICENSE,sha256=t0LRkl7HEgDhGmOHdjpbyyLoAOmMcNfXAunBk1N18S4,1064
+cql2/__init__.py,sha256=lQIzMwXTmBW1tLuKrIKf3_nxwWMiik5UOd5CBYV22uQ,99
+cql2/__init__.pyi,sha256=LEYKGkqZwmN7ZdxObxgq07Fq3a4A2VLcAyXvCMG3kRk,4631
+cql2/cql2.abi3.so,sha256=AgGE2drsh7Najgdp8-Kk3gSw6caRwAMV90b_uXVvnNE,9118832
+cql2/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cql2-0.4.1.dist-info/RECORD,,

cql2-0.4.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.9.6)
+Root-Is-Purelib: false
+Tag: cp310-abi3-macosx_11_0_arm64

cql2-0.4.1.dist-info/entry_points.txt

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

cql2-0.4.1.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Development Seed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.