vtlengine 1.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

vtlengine/AST/Grammar/tokens.py

@@ -8,150 +8,162 @@ Vtl Token centralized.
 """
 
 # General
-PASSIGN = '<-'
-ASSIGN = ':='
-MEMBERSHIP = '#'
-LPAREN = '('
-RLPAREN = ')'
-COMMA = ','
-COLON = ':'
-SCOLON = ';'
+PASSIGN = "<-"
+ASSIGN = ":="
+MEMBERSHIP = "#"
+LPAREN = "("
+RLPAREN = ")"
+COMMA = ","
+COLON = ":"
+SCOLON = ";"
 # Numeric operators.
-PLUS = '+'
-MINUS = '-'
-MULT = '*'
-DIV = '/'
-MOD = 'mod'
-ROUND = 'round'
-TRUNC = 'trunc'
-CEIL = 'ceil'
-FLOOR = 'floor'
-ABS = 'abs'
-EXP = 'exp'
-LN = 'ln'
-POWER = 'power'
-LOG = 'log'
-SQRT = 'sqrt'
+PLUS = "+"
+MINUS = "-"
+MULT = "*"
+DIV = "/"
+MOD = "mod"
+ROUND = "round"
+TRUNC = "trunc"
+CEIL = "ceil"
+FLOOR = "floor"
+ABS = "abs"
+EXP = "exp"
+LN = "ln"
+POWER = "power"
+LOG = "log"
+SQRT = "sqrt"
+RANDOM = "random"
 # Boolean operators.
-AND = 'and'
-OR = 'or'
-XOR = 'xor'
-NOT = 'not'
+AND = "and"
+OR = "or"
+XOR = "xor"
+NOT = "not"
 # Comparison operators.
-EQ = '='
-NEQ = '<>'
-GT = '>'
-GTE = '>='
-LT = '<'
-LTE = '<='
-BETWEEN = 'between'
-IN = 'in'
-NOT_IN = 'not_in'
-CHARSET_MATCH = 'match_characters'
-ISNULL = 'isnull'
-EXISTS_IN = 'exists_in'
+EQ = "="
+NEQ = "<>"
+GT = ">"
+GTE = ">="
+LT = "<"
+LTE = "<="
+BETWEEN = "between"
+IN = "in"
+NOT_IN = "not_in"
+CHARSET_MATCH = "match_characters"
+ISNULL = "isnull"
+EXISTS_IN = "exists_in"
 # String operators.
-CONCAT = '||'
-TRIM = 'trim'
-RTRIM = 'rtrim'
-LTRIM = 'ltrim'
-UCASE = 'upper'
-LCASE = 'lower'
-SUBSTR = 'substr'
-REPLACE = 'replace'
-INSTR = 'instr'
-LEN = 'length'
+CONCAT = "||"
+TRIM = "trim"
+RTRIM = "rtrim"
+LTRIM = "ltrim"
+UCASE = "upper"
+LCASE = "lower"
+SUBSTR = "substr"
+REPLACE = "replace"
+INSTR = "instr"
+LEN = "length"
 # Set operators.
-UNION = 'union'
-INTERSECT = 'intersect'
-SETDIFF = 'setdiff'
-SYMDIFF = 'symdiff'
+UNION = "union"
+INTERSECT = "intersect"
+SETDIFF = "setdiff"
+SYMDIFF = "symdiff"
 # Conditional Operators.
-IF = 'if'
-THEN = 'then'
-ELSE = 'else'
-NVL = 'nvl'
+IF = "if"
+THEN = "then"
+ELSE = "else"
+CASE = "case"
+NVL = "nvl"
 # Clause Operators.
-FILTER = 'filter'
-CALC = 'calc'
-AGGREGATE = 'aggr'
-KEEP = 'keep'
-DROP = 'drop'
-RENAME = 'rename'
-PIVOT = 'pivot'
-UNPIVOT = 'unpivot'
-SUBSPACE = 'sub'
+FILTER = "filter"
+CALC = "calc"
+AGGREGATE = "aggr"
+KEEP = "keep"
+DROP = "drop"
+RENAME = "rename"
+PIVOT = "pivot"
+UNPIVOT = "unpivot"
+SUBSPACE = "sub"
 # Time Operators.
-PERIOD_INDICATOR = 'period_indicator'
-FILL_TIME_SERIES = 'fill_time_series'
-FLOW_TO_STOCK = 'flow_to_stock'
-STOCK_TO_FLOW = 'stock_to_flow'
-TIMESHIFT = 'timeshift'
-TIME_AGG = 'time_agg'
-CURRENT_DATE = 'current_date'
+PERIOD_INDICATOR = "period_indicator"
+FILL_TIME_SERIES = "fill_time_series"
+FLOW_TO_STOCK = "flow_to_stock"
+STOCK_TO_FLOW = "stock_to_flow"
+TIMESHIFT = "timeshift"
+TIME_AGG = "time_agg"
+CURRENT_DATE = "current_date"
+DATE_DIFF = "date_diff"
+DATE_ADD = "date_add"
+YEAR = "year"
+MONTH = "month"
+DAYOFMONTH = "dayofmonth"
+DAYOFYEAR = "dayofyear"
+DAYTOYEAR = "daytoyear"
+DAYTOMONTH = "daytomonth"
+YEARTODAY = "yeartoday"
+MONTHTODAY = "monthtoday"
 # Join Operators.
-INNER_JOIN = 'inner_join'
-LEFT_JOIN = 'left_join'
-CROSS_JOIN = 'cross_join'
-FULL_JOIN = 'full_join'
+INNER_JOIN = "inner_join"
+LEFT_JOIN = "left_join"
+CROSS_JOIN = "cross_join"
+FULL_JOIN = "full_join"
 # Hierarchical aggregation.
-HIERARCHY = 'hierarchy'
+HIERARCHY = "hierarchy"
 # Aggregate and analytic Operators.
-COUNT = 'count'
-MIN = 'min'
-MAX = 'max'
-MEDIAN = 'median'
-SUM = 'sum'
-AVG = 'avg'
-STDDEV_POP = 'stddev_pop'
-STDDEV_SAMP = 'stddev_samp'
-VAR_POP = 'var_pop'
-VAR_SAMP = 'var_samp'
-FIRST_VALUE = 'first_value'
-LAST_VALUE = 'last_value'
-LAG = 'lag'
-LEAD = 'lead'
-RANK = 'rank'
-RATIO_TO_REPORT = 'ratio_to_report'
+COUNT = "count"
+MIN = "min"
+MAX = "max"
+MEDIAN = "median"
+SUM = "sum"
+AVG = "avg"
+STDDEV_POP = "stddev_pop"
+STDDEV_SAMP = "stddev_samp"
+VAR_POP = "var_pop"
+VAR_SAMP = "var_samp"
+FIRST_VALUE = "first_value"
+LAST_VALUE = "last_value"
+LAG = "lag"
+LEAD = "lead"
+RANK = "rank"
+RATIO_TO_REPORT = "ratio_to_report"
 # Data validation Operators.
-CHECK_DATAPOINT = 'check_datapoint'
-CHECK_HIERARCHY = 'check_hierarchy'
-CHECK = 'check'
+CHECK_DATAPOINT = "check_datapoint"
+CHECK_HIERARCHY = "check_hierarchy"
+CHECK = "check"
 # Role Operators.
-IDENTIFIER = 'identifier'
-MEASURE = 'measure'
-ATTRIBUTE = 'attribute'
-VIRAL_ATTRIBUTE = 'viral'
+IDENTIFIER = "identifier"
+MEASURE = "measure"
+ATTRIBUTE = "attribute"
+VIRAL_ATTRIBUTE = "viral"
 # Other Operators.
-TO = 'to'
-AS = 'as'
-USING = 'using'
-OPTIONAL = '_'
-HAVING = 'having'
-WHEN = 'when'
+TO = "to"
+AS = "as"
+USING = "using"
+OPTIONAL = "_"
+HAVING = "having"
+WHEN = "when"
 # Helping Tokens
-GROUP_BY = 'group by'
-GROUP_EXCEPT = 'group except'
-GROUP_ALL = 'group all'
-CAST = 'cast'
-INVALID = 'invalid'
-ALL = 'all'
-ALL_MEASURES = 'all_measures'
-COMPUTED = 'computed'
-DATASET = 'dataset'
-DATASET_PRIORITY = 'dataset_priority'
-RULE = 'rule'
-RULE_PRIORITY = 'rule_priority'
-NON_NULL = 'non_null'
-NON_ZERO = 'non_zero'
-PARTIAL_NULL = 'partial_null'
-PARTIAL_ZERO = 'partial_zero'
-ALWAYS_NULL = 'always_null'
-ALWAYS_ZERO = 'always_zero'
-APPLY = 'apply'
+GROUP_BY = "group by"
+GROUP_EXCEPT = "group except"
+GROUP_ALL = "group all"
+CAST = "cast"
+INVALID = "invalid"
+ALL = "all"
+ALL_MEASURES = "all_measures"
+COMPUTED = "computed"
+DATASET = "dataset"
+DATASET_PRIORITY = "dataset_priority"
+RULE = "rule"
+RULE_PRIORITY = "rule_priority"
+NON_NULL = "non_null"
+NON_ZERO = "non_zero"
+PARTIAL_NULL = "partial_null"
+PARTIAL_ZERO = "partial_zero"
+ALWAYS_NULL = "always_null"
+ALWAYS_ZERO = "always_zero"
+APPLY = "apply"
 # Defined operators.
-OPERATOR = 'operator'
-EVAL = 'eval'
+OPERATOR = "operator"
+EVAL = "eval"
 # External.
 SQLITE = '"sqlite"'
 EXTERNAL = [SQLITE]

vtlengine/AST/VtlVisitor.py

@@ -5,6 +5,7 @@ from vtlengine.AST.Grammar.parser import Parser
 
 # This class defines a complete generic visitor for a parse tree produced by Parser.
 
+
 class VtlVisitor(ParseTreeVisitor):
 
     # Visit a parse tree produced by Parser#start.
@@ -61,6 +62,10 @@ class VtlVisitor(ParseTreeVisitor):
     def visitIfExpr(self, ctx: Parser.IfExprContext):
         return self.visitChildren(ctx)
 
+    # Visit a parse tree produced by Parser#caseExpr.
+    def visitCaseExpr(self, ctx: Parser.CaseExprContext):
+        return self.visitChildren(ctx)
+
     # Visit a parse tree produced by Parser#clauseExpr.
     def visitClauseExpr(self, ctx: Parser.ClauseExprContext):
         return self.visitChildren(ctx)
@@ -89,6 +94,10 @@ class VtlVisitor(ParseTreeVisitor):
     def visitIfExprComp(self, ctx: Parser.IfExprCompContext):
         return self.visitChildren(ctx)
 
+    # Visit a parse tree produced by Parser#caseExprComp.
+    def visitCaseExprComp(self, ctx: Parser.CaseExprCompContext):
+        return self.visitChildren(ctx)
+
     # Visit a parse tree produced by Parser#comparisonExprComp.
     def visitComparisonExprComp(self, ctx: Parser.ComparisonExprCompContext):
         return self.visitChildren(ctx)
@@ -146,8 +155,9 @@ class VtlVisitor(ParseTreeVisitor):
         return self.visitChildren(ctx)
 
     # Visit a parse tree produced by Parser#conditionalFunctionsComponents.
-    def visitConditionalFunctionsComponents(self,
-                                            ctx: Parser.ConditionalFunctionsComponentsContext):
+    def visitConditionalFunctionsComponents(
+        self, ctx: Parser.ConditionalFunctionsComponentsContext
+    ):
         return self.visitChildren(ctx)
 
     # Visit a parse tree produced by Parser#aggregateFunctionsComponents.
@@ -335,8 +345,9 @@ class VtlVisitor(ParseTreeVisitor):
         return self.visitChildren(ctx)
 
     # Visit a parse tree produced by Parser#unaryWithOptionalNumericComponent.
-    def visitUnaryWithOptionalNumericComponent(self,
-                                               ctx: Parser.UnaryWithOptionalNumericComponentContext):
+    def visitUnaryWithOptionalNumericComponent(
+        self, ctx: Parser.UnaryWithOptionalNumericComponentContext
+    ):
         return self.visitChildren(ctx)
 
     # Visit a parse tree produced by Parser#binaryNumericComponent.
@@ -396,7 +407,7 @@ class VtlVisitor(ParseTreeVisitor):
         return self.visitChildren(ctx)
 
     # Visit a parse tree produced by Parser#periodAtomComponent.
-    def visitPeriodAtomComponent(self, ctx: Parser.PeriodAtomComponentContext):
+    def visitTimeUnaryAtomComponent(self, ctx: Parser.PeriodAtomComponentContext):
         return self.visitChildren(ctx)
 
     # Visit a parse tree produced by Parser#fillTimeAtomComponent.

vtlengine/AST/__init__.py

@@ -6,6 +6,7 @@ Description
 -----------
 Basic AST nodes.
 """
+
 from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Type, Union
 
@@ -39,9 +40,7 @@ class AST:
         return f"<{name}({', '.join(out)})>"
 
     def toJSON(self):
-        base = {
-            'class_name': self.__class__.__name__
-        }
+        base = {"class_name": self.__class__.__name__}
         for k in self.__all_annotations().keys():
             v = self.__getattribute__(k)
             base[k] = v
@@ -75,6 +74,7 @@ class PersistentAssignment(Assignment):
     """
     PersistentAssignment: (left, op, right)
     """
+
     pass
 
 
@@ -85,6 +85,7 @@ class VarID(AST):
     The Var node is constructed out of ID token.
     Could be: DATASET or a COMPONENT.
     """
+
     value: Any
 
 
@@ -105,7 +106,8 @@ class UnaryOp(AST):
 class BinOp(AST):
     """
     BinOp: (left, op, right)
-    op types: "+", "-", "*", "/",MOD, MEMBERSHIP, PIVOT, UNPIVOT, LOG, POWER, CHARSET_MATCH, NVL, MOD
+    op types: "+", "-", "*", "/",MOD, MEMBERSHIP, PIVOT, UNPIVOT, LOG,
+    POWER, CHARSET_MATCH, NVL, MOD
     """
 
     left: AST
@@ -217,7 +219,7 @@ class Collection(AST):
     name: str
     type: str
     children: List[AST]
-    kind: str = 'Set'
+    kind: str = "Set"
 
 
 @dataclass
@@ -233,9 +235,9 @@ class Windowing(AST):
     """
 
     type_: str
-    start: int
+    start: str
     start_mode: str
-    stop: int
+    stop: Union[int, str]
     stop_mode: str
 
 
@@ -245,7 +247,7 @@ class OrderBy(AST):
     order: str
 
     def __post_init__(self):
-        if self.order not in ['asc', 'desc']:
+        if self.order not in ["asc", "desc"]:
             raise ValueError(f"Invalid order: {self.order}")
 
 
@@ -254,13 +256,14 @@ class Analytic(AST):
     """
     Analytic: (op, operand, partition_by, order_by, params)
 
-    op: SUM, AVG, COUNT, MEDIAN, MIN, MAX, STDDEV_POP, STDDEV_SAMP, VAR_POP, VAR_SAMP, FIRST_VALUE, LAST_VALUE, LAG,
-        LEAD, RATIO_TO_REPORT
+    op: SUM, AVG, COUNT, MEDIAN, MIN, MAX, STDDEV_POP, STDDEV_SAMP, VAR_POP, VAR_SAMP,
+        FIRST_VALUE, LAST_VALUE, LAG, LEAD, RATIO_TO_REPORT
 
     partition_by: List of components.
     order_by: List of components + mode (ASC, DESC).
     params: Windowing clause (no need to validate them) or Scalar Item in LAG/LEAD.
     """
+
     op: str
     operand: Optional[AST]
     window: Optional[Windowing] = None
@@ -307,6 +310,7 @@ class Aggregation(AST):
 
     grouping types: 'group by', 'group except', 'group all'.
     """
+
     op: str
     operand: Optional[AST] = None
     grouping_op: Optional[str] = None
@@ -334,11 +338,31 @@ class If(AST):
     """
     If: (condition, thenOp, elseOp)
     """
+
     condition: AST
     thenOp: AST
     elseOp: AST
 
 
+class CaseObj:
+    condition: AST
+    thenOp: AST
+
+    def __init__(self, condition: AST, thenOp: AST):
+        self.condition = condition
+        self.thenOp = thenOp
+
+
+@dataclass
+class Case(AST):
+    """
+    Case: (condition, thenOp, elseOp)
+    """
+
+    cases: List[CaseObj]
+    elseOp: AST
+
+
 @dataclass
 class Validation(AST):
     """
@@ -358,6 +382,7 @@ class ComponentType(AST):
     """
     ComponentType: (data_type, role)
     """
+
     name: str
     data_type: Optional[Type[ScalarType]] = None
     role: Optional[Role] = None
@@ -400,8 +425,9 @@ class Argument(AST):
     """
     Argument: (name, type_, default)
     """
+
     name: str
-    type_: ScalarType
+    type_: Type[ScalarType]
     default: Optional[AST]
 
 
@@ -423,6 +449,7 @@ class DefIdentifier(AST):
     """
     DefIdentifier: (value, kind)
     """
+
     value: str
     kind: str
 
@@ -432,6 +459,7 @@ class DPRIdentifier(AST):
     """
     DefIdentifier: (value, kind, alias)
     """
+
     value: str
     kind: str
     alias: Optional[str] = None
@@ -444,6 +472,7 @@ class HRBinOp(AST):
     HRBinOp: (left, op, right)
     op types: '+','-', '=', '>', '<', '>=', '<='.
     """
+
     left: DefIdentifier
     op: str
     right: DefIdentifier
@@ -529,4 +558,5 @@ class NoOp(AST):
     """
     NoOp: ()
     """
+
     pass

vtlengine/DataTypes/NumericTypesHandling.py

@@ -1,8 +1,9 @@
 import operator
 from decimal import Decimal
+from typing import Union
 
 
-def decimal_add(a, b):
+def decimal_add(a: Union[float, int], b: Union[float, int]) -> float:
     """
     Adds two numbers, if they are floats, converts them to Decimal and then to float
     :param a: first number
@@ -16,21 +17,21 @@ def decimal_add(a, b):
     return operator.add(a, b)
 
 
-def decimal_sub(a, b):
+def decimal_sub(a: Union[float, int], b: Union[float, int]) -> float:
     if isinstance(a, float) and isinstance(b, float):
         decimal_value = Decimal(a) - Decimal(b)
         return float(decimal_value)
     return operator.sub(a, b)
 
 
-def decimal_mul(a, b):
+def decimal_mul(a: Union[float, int], b: Union[float, int]) -> float:
     if isinstance(a, float) and isinstance(b, float):
         decimal_value = Decimal(a) * Decimal(b)
         return float(decimal_value)
     return operator.mul(a, b)
 
 
-def decimal_div(a, b):
+def decimal_div(a: Union[float, int], b: Union[float, int]) -> float:
     if isinstance(a, float) and isinstance(b, float):
         decimal_value = Decimal(a) / Decimal(b)
         return float(decimal_value)