promql-parser 0.4.2__cp313-cp313-win_amd64.whl

promql_parser/__init__.py

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

promql_parser/__init__.pyi

@@ -0,0 +1,269 @@
+"""PromQL Lexer and Parser
+
+The goal of this project is to build a PromQL lexer and parser capable of
+parsing PromQL that conforms with [Prometheus Query](https://prometheus.io/docs/prometheus/latest/querying/basics/).
+
+## Example
+
+The parser entry point is `promql_parser.parse`, which takes a string slice of PromQL
+and returns the parse result as an AST (`promql_parser.Expr`).
+
+```python
+import promql_parser
+
+promql = 'http_requests_total{environment=~"staging|testing|development",method!="GET"} offset 5m'
+expr = promql_parser.parse(promql)
+print(f"Prettify:\n{expr.prettify()}")
+print(f"AST:\n{expr}")
+```
+
+This outputs:
+
+```text
+Prettify:
+http_requests_total{environment=~"staging|testing|development",method!="GET"} offset 5m
+
+AST:
+VectorSelector(VectorSelector { name: Some("http_requests_total"), matchers: Matchers { matchers: [Matcher { op: Re(staging|testing|development), name: "environment", value: "staging|testing|development" }, Matcher { op: NotEqual, name: "method", value: "GET" }] }, offset: Some(Pos(300s)), at: None })
+```
+
+## PromQL compliance
+
+This library declares compatible with [prometheus v2.45.0](https://github.com/prometheus/prometheus/tree/v2.45.0),
+which isreleased at 2023-06-23. Any revision on PromQL after this commit is not guaranteed.
+"""
+
+from datetime import datetime, timedelta
+from enum import Enum
+from typing import Any, List, Optional, final
+
+def parse(input: str) -> Expr:
+    """Parse the given query literal to an AST."""
+    ...
+
+def parse_duration(duration: str) -> timedelta:
+    """Parse a string into a duration.
+
+    Assumes that a year always has 365d, a week always has 7d,
+    and a day always has 24h.
+
+    Basic usage:
+
+    ```python
+    from datetime import timedelta
+    import promql_parser
+
+    assert promql_parser.parse_duration("1h") == timedelta(seconds=3600);
+    assert promql_parser.parse_duration("4d") == timedelta(seconds=3600 * 24 * 4)
+    assert promql_parser.parse_duration("4d1h") == timedelta(seconds=3600 * 97)
+    ```
+    """
+    ...
+
+def display_duration(delta: timedelta) -> str:
+    """Display Duration in Prometheus format"""
+    ...
+
+class Expr:
+    @staticmethod
+    def parse(input: str) -> Any: ...
+    def prettify(self) -> str: ...
+
+@final
+class AggregateExpr(Expr):
+    """An aggregation operation on a Vector.
+
+    Attributes:
+      op: The used aggregation operation.
+      expr: The Vector expression over which is aggregated.
+      param: Parameter used by some aggregators.
+      modifier: An optional modifier for some operations like sum.
+    """
+
+    op: TokenType
+    expr: Expr
+    param: Optional[Any]
+    modifier: Optional[AggModifier]
+
+@final
+class TokenType:
+    pass
+
+@final
+class AggModifier:
+    type: AggModifierType
+    labels: List[str]
+
+@final
+class AggModifierType(Enum):
+    By: Any
+    Without: Any
+
+@final
+class UnaryExpr(Expr):
+    """An unary operation on another expression."""
+
+    expr: Expr
+
+@final
+class BinaryExpr(Expr):
+    """A binary expression between two child expressions.
+
+    Attributes:
+      op: The operation of the expression.
+      lhs: The operands on the left side of the operator.
+      rhs: The operands on the right side of the operator.
+      modifier: An optional modifier.
+    """
+
+    op: TokenType
+    lhs: Expr
+    rhs: Expr
+    modifier: Optional[BinModifier]
+
+@final
+class BinModifier:
+    """Binary expression modifier
+
+    Attributes:
+      card:
+        The matching behavior for the operation if both operands are Vectors.
+        If they are not this field is None.
+      matching: on/ignoring on labels. Like a + b, no match modified is needed.
+      return_bool: If a comparison operator, return 0/1 rather than filtering.
+    """
+
+    card: VectorMatchCardinality
+    matching: Optional[LabelModifier]
+    return_bool: bool
+
+@final
+class LabelModifier:
+    """LabelModifier acts as
+
+    # Aggregation Modifier
+
+    - Exclude means `ignoring`
+    - Include means `on`
+
+    # Vector Match Modifier
+
+    - Exclude means `without` removes the listed labels from the result vector,
+    while all other labels are preserved in the output.
+    - Include means `by` does the opposite and drops labels that are not listed in the by clause,
+    even if their label values are identical between all elements of the vector.
+
+    If empty listed labels, meaning no grouping
+    """
+
+    type: LabelModifierType
+    labels: List[str]
+
+@final
+class LabelModifierType(Enum):
+    Include: Any
+    Exclude: Any
+
+@final
+class VectorMatchCardinality(Enum):
+    """The label list provided with the group_left or group_right modifier contains
+    additional labels from the "one"-side to be included in the result metrics."""
+
+    OneToOne: Any
+    ManyToOne: Any
+    OneToMany: Any
+    ManyToMany: Any
+
+@final
+class ParenExpr(Expr):
+    """Wraps an expression so it cannot be disassembled as a consequence of operator precedence."""
+
+    expr: Expr
+
+@final
+class SubqueryExpr(Expr):
+    """A subquery."""
+
+    expr: Expr
+    offset: Optional[timedelta]
+    at: Optional[AtModifier]
+    range: Optional[timedelta]
+    step: Optional[timedelta]
+
+@final
+class AtModifier:
+    type: AtModifierType
+    at: Optional[datetime]
+
+@final
+class AtModifierType(Enum):
+    Start: Any
+    End: Any
+    At: Any
+
+@final
+class NumberLiteral(Expr):
+    """A number literal."""
+
+    val: float
+
+@final
+class StringLiteral(Expr):
+    """A string literal."""
+
+    val: str
+
+@final
+class MatchOp(Enum):
+    Equal: Any
+    NotEqual: Any
+    Re: Any
+    NotRe: Any
+
+@final
+class Matcher:
+    op: MatchOp
+    name: str
+    value: str
+
+@final
+class Matchers:
+    matchers: List[Matcher]
+    or_matchers: List[List[Matcher]]
+
+@final
+class VectorSelector(Expr):
+    """A Vector selection."""
+
+    name: Optional[str]
+    matchers: Matchers
+    offset: Optional[timedelta]
+    at: Optional[AtModifier]
+
+@final
+class MatrixSelector(Expr):
+    """A Matrix selection."""
+
+    vector_selector: VectorSelector
+    range: timedelta
+
+@final
+class Call(Expr):
+    """A call to a Prometheus function."""
+
+    func: Function
+    args: List[Any]
+
+@final
+class ValueType(Enum):
+    Vector: Any
+    Scalar: Any
+    Matrix: Any
+    String: Any
+
+@final
+class Function:
+    name: str
+    arg_types: List[ValueType]
+    variadic: bool
+    return_type: ValueType

promql_parser-0.4.2.dist-info/METADATA

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: promql-parser
+Version: 0.4.2
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE
+Summary: PromQL Parser for Python
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Source Code, https://github.com/messense/py-promql-parser
+
+# py-promql-parser
+
+![CI](https://github.com/messense/py-promql-parser/workflows/CI/badge.svg)
+[![PyPI](https://img.shields.io/pypi/v/promql-parser.svg)](https://pypi.org/project/promql-parser)
+
+[promql-parser](https://github.com/GreptimeTeam/promql-parser) Python binding, a PromQL parser for Python.
+
+## Installation
+
+```bash
+pip install promql-parser
+```
+
+## Usage
+
+```python
+import promql_parser
+
+ast = promql_parser.parse('prometheus_http_requests_total{code="200", job="prometheus"}')
+print(ast)
+```
+
+## License
+
+This work is released under the MIT license. A copy of the license is provided in the [LICENSE](./LICENSE) file.
+

promql_parser-0.4.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+promql_parser-0.4.2.dist-info/METADATA,sha256=NR8Kd1_gdIbfvQOhY1CPs9o9VMMHQwaon49zWZhmWdE,1129
+promql_parser-0.4.2.dist-info/WHEEL,sha256=futlocXTKIczW-hie_n6w--bAT-euhL-NVZjIAlXTFQ,96
+promql_parser-0.4.2.dist-info/licenses/LICENSE,sha256=1oF4gRKKrXP17iJXIPlgRzmm8gKXEiRL_pi3hC1kqYw,1107
+promql_parser/__init__.py,sha256=S_WJxolC7EN5itz4Z99Ml5faJ58UDXvlnVtiSvstGDM,135
+promql_parser/__init__.pyi,sha256=-qwXr0MKSHDOEg3IA-prq9bJlz3jfBvWk4Njti7Sjhk,6530
+promql_parser/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+promql_parser/promql_parser.cp313-win_amd64.pyd,sha256=IZ2xuS-P5sasud53JYyLZPyOABehKMbN_wVPIP4b9ws,2909184
+promql_parser-0.4.2.dist-info/RECORD,,

promql_parser-0.4.2.dist-info/WHEEL

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

promql_parser-0.4.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present Messense Lv
+
+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.