pycep-parser 0.7.0.dev7__tar.gz → 0.7.0.dev8__tar.gz

{pycep_parser-0.7.0.dev7 → pycep_parser-0.7.0.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycep-parser
-Version: 0.7.0.dev7
+Version: 0.7.0.dev8
 Summary: A Python based Bicep parser
 Keywords: bicep,parser,lark
 Author: Anton Grübel

{pycep_parser-0.7.0.dev7 → pycep_parser-0.7.0.dev8}/pycep/bicep.lark

@@ -10,6 +10,7 @@ element: "targetScope" "=" QUOTED_INTERPOLATION
        | [decorators] "resource" STRING type_api_pair [EXISTING] "=" resource_value     -> resource
        | [decorators] "module" STRING module_path "=" module_value                      -> module
        | [decorators] "type" STRING "=" type_value                                      -> custom_type
+       | [decorators] "func" _func_statement                                            -> custom_func
 
 ?value: _NEWLINE? "null"                      -> null
       | _NEWLINE? "true"                      -> true
@@ -30,6 +31,8 @@ element: "targetScope" "=" QUOTED_INTERPOLATION
 
 _import_statement: (("{" import_alias ("," import_alias)* "}" | import_alias) "from" QUOTED_INTERPOLATION | QUOTED_INTERPOLATION)
 
+_func_statement: STRING "(" (STRING data_type ("," STRING data_type)*)? ")" data_type "=>" value_brackets
+
 // element values
 
 ?var_value: value_brackets | loop

{pycep_parser-0.7.0.dev7 → pycep_parser-0.7.0.dev8}/pycep/transformer.py

@@ -63,7 +63,7 @@ class BicepToJson(Transformer[Token, pycep_typing.BicepJson]):
                 # very unlikely this will happen in a real Bicep file, but in test files possible
                 continue
             for key, value in arg.items():
-                result.setdefault(key, {})[value["__name__"]] = value["__attrs__"]  # ty: ignore[non-subscriptable, no-matching-overload]
+                result.setdefault(key, {})[value["__name__"]] = value["__attrs__"]  # ty: ignore[not-subscriptable, no-matching-overload]
 
         return result
 
@@ -356,6 +356,38 @@ class BicepToJson(Transformer[Token, pycep_typing.BicepJson]):
 
         return result
 
+    @v_args(meta=True)
+    def custom_func(
+        self,
+        meta: Meta,
+        args: tuple[
+            list[pycep_typing.Decorator] | None,
+            Token,
+            pycep_typing.PossibleValue,
+            pycep_typing.PossibleValue,
+        ],
+    ) -> pycep_typing.FunctionResponse:
+        decorators, name, *arg_type_pairs, return_type, expression = args
+
+        result: pycep_typing.FunctionResponse = {
+            "functions": {
+                "__name__": str(name),
+                "__attrs__": {
+                    "decorators": decorators or [],
+                    # TODO: change `zip` to `itertools.pairwise` when updating to Python 3.10
+                    "args": {str(arg_name): arg_type for arg_name, arg_type in zip(*[iter(arg_type_pairs)] * 2)},
+                    "type": return_type,
+                    "expression": expression,
+                },
+            }
+        }
+
+        if self.add_line_numbers:
+            result["functions"]["__attrs__"]["__start_line__"] = meta.line
+            result["functions"]["__attrs__"]["__end_line__"] = meta.end_line
+
+        return result
+
     ####################
     #
     # element type extras

{pycep_parser-0.7.0.dev7 → pycep_parser-0.7.0.dev8}/pycep/typing.py

@@ -10,7 +10,7 @@ PossibleNoneValue: TypeAlias = "PossibleValue | None"
 ModulePath: TypeAlias = "LocalModulePath | BicepRegistryModulePath | BicepRegistryAliasModulePath | TemplateSpecModulePath | TemplateSpecAliasModulePath"
 ModuleDetail: TypeAlias = "_LocalModulePathDetail | _BicepRegistryModulePathDetail | _BicepRegistryAliasModulePathDetail | _TemplateSpecModulePathDetail | _TemplateSpecAliasModulePathDetail"
 LoopType: TypeAlias = "LoopArray | LoopArrayIndex | LoopObject | LoopRange"
-ElementResponse: TypeAlias = "ImportResponse | ParamResponse | VarResponse | ResourceResponse | ModuleResponse | OutputResponse | TypeResponse | ExtensionResponse"
+ElementResponse: TypeAlias = "ImportResponse | ParamResponse | VarResponse | ResourceResponse | ModuleResponse | OutputResponse | TypeResponse | ExtensionResponse | FunctionResponse"
 Decorator: TypeAlias = "DecoratorAllowed | DecoratorBatchSize | DecoratorDescription | DecoratorExport | DecoratorMinLength | DecoratorMaxLength | DecoratorMinValue | DecoratorMaxValue | DecoratorMetadata | DecoratorSealed | DecoratorSecure | UnknownDecorator"
 
 ComparisonOperators: TypeAlias = "GreaterThanOrEquals | GreaterThan | LessThanOrEquals | LessThan | Equals | NotEquals | EqualsCaseInsensitive | NotEqualsCaseInsensitive"
@@ -209,8 +209,34 @@ class ApiTypeVersion(TypedDict):
     api_version: str
 
 
+TypeAttributes: TypeAlias = VariableAttributes
+
+
+class _Types(TypedDict):
+    __name__: str
+    __attrs__: TypeAttributes
+
+
 class TypeResponse(TypedDict):
-    types: _Variables
+    types: _Types
+
+
+class FunctionAttributes(TypedDict):
+    decorators: list[Decorator]
+    args: dict[str, str]
+    type: str
+    expression: PossibleValue
+    __start_line__: NotRequired[int]
+    __end_line__: NotRequired[int]
+
+
+class _Functions(TypedDict):
+    __name__: str
+    __attrs__: FunctionAttributes
+
+
+class FunctionResponse(TypedDict):
+    functions: _Functions
 
 
 ####################
@@ -1337,6 +1363,9 @@ class PropertyAccessor(TypedDict):
 class BicepJson(TypedDict):
     globals: GlobalsAttributes
     imports: NotRequired[dict[str, ImportAttributes]]
+    extensions: NotRequired[dict[str, ExtensionAttributes]]
+    types: NotRequired[dict[str, VariableAttributes]]
+    functions: NotRequired[dict[str, FunctionAttributes]]
     parameters: NotRequired[dict[str, ParameterAttributes]]
     variables: NotRequired[dict[str, VariableAttributes]]
     resources: NotRequired[dict[str, ResourceAttributes]]

{pycep_parser-0.7.0.dev7 → pycep_parser-0.7.0.dev8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pycep-parser"
-version = "0.7.0.dev7"
+version = "0.7.0.dev8"
 description = "A Python based Bicep parser"
 authors = [
     { name = "Anton Grübel", email = "anton.gruebel@gmail.com" }
@@ -39,7 +39,7 @@ dev = [
     "assertpy>=1.1,<2.0",
     "prek>=0.2.25,<0.3.0",
     "pytest>=8.4.2,<9.0.0",
-    "ty>=0.0.7,<0.1.0",
+    "ty>=0.0.8,<0.1.0",
 ]
 
 [build-system]

pycep_parser-0.7.0.dev8/tests/examples/basic/07-func/main.bicep

@@ -0,0 +1,27 @@
+// https://docs.azure.cn/en-us/azure-resource-manager/bicep/user-defined-functions
+
+// definition
+func buildUrl(https bool, hostname string, path string) string => '${https ? 'https' : 'http'}://${hostname}${empty(path) ? '' : '/${path}'}'
+
+func sayHelloString(name string) string => 'Hi ${name}!'
+
+func sayHelloObject(name string) object => {
+  hello: 'Hi ${name}!'
+}
+
+func nameArray(name string) array => [
+  name
+]
+
+func addNameArray(name string) array => [
+  'Mary'
+  'Bob'
+  name
+]
+
+// usage
+output azureUrl string = buildUrl(true, 'microsoft.com', 'azure')
+output greetingArray array = map(['Evie', 'Casper'], name => sayHelloString(name))
+output greetingObject object = sayHelloObject('John')
+output nameArray array = nameArray('John')
+output addNameArray array = addNameArray('John')

pycep_parser-0.7.0.dev8/tests/examples/basic/07-func/result.json

@@ -0,0 +1,140 @@
+{
+  "globals": {
+    "scope": {
+      "value": "resourceGroup"
+    }
+  },
+  "functions": {
+    "buildUrl": {
+      "decorators": [],
+      "args": {
+        "https": "bool",
+        "hostname": "string",
+        "path": "string"
+      },
+      "type": "string",
+      "expression": "${https ? 'https' : 'http'}://${hostname}${empty(path) ? '' : '/${path}'}"
+    },
+    "sayHelloString": {
+      "decorators": [],
+      "args": {
+        "name": "string"
+      },
+      "type": "string",
+      "expression": "Hi ${name}!"
+    },
+    "sayHelloObject": {
+      "decorators": [],
+      "args": {
+        "name": "string"
+      },
+      "type": "object",
+      "expression": {
+        "hello": "Hi ${name}!"
+      }
+    },
+    "nameArray": {
+      "decorators": [],
+      "args": {
+        "name": "string"
+      },
+      "type": "array",
+      "expression": [
+        "name"
+      ]
+    },
+    "addNameArray": {
+      "decorators": [],
+      "args": {
+        "name": "string"
+      },
+      "type": "array",
+      "expression": [
+        "Mary",
+        "Bob",
+        "name"
+      ]
+    }
+  },
+  "outputs": {
+    "azureUrl": {
+      "decorators": [],
+      "type": "string",
+      "value": {
+        "function": {
+          "type": "buildUrl",
+          "parameters": {
+            "arg_1": true,
+            "arg_2": "microsoft.com",
+            "arg_3": "azure"
+          }
+        }
+      }
+    },
+    "greetingArray": {
+      "decorators": [],
+      "type": "array",
+      "value": {
+        "function": {
+          "type": "map",
+          "parameters": {
+            "arg_1": [
+              "Evie",
+              "Casper"
+            ],
+            "arg_2": {
+              "type": "lambda_expression",
+              "detail": {
+                "var_1": "name",
+                "expression": {
+                  "function": {
+                    "type": "sayHelloString",
+                    "parameters": {
+                      "arg_1": "name"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "greetingObject": {
+      "decorators": [],
+      "type": "object",
+      "value": {
+        "function": {
+          "type": "sayHelloObject",
+          "parameters": {
+            "arg_1": "John"
+          }
+        }
+      }
+    },
+    "nameArray": {
+      "decorators": [],
+      "type": "array",
+      "value": {
+        "function": {
+          "type": "nameArray",
+          "parameters": {
+            "arg_1": "John"
+          }
+        }
+      }
+    },
+    "addNameArray": {
+      "decorators": [],
+      "type": "array",
+      "value": {
+        "function": {
+          "type": "addNameArray",
+          "parameters": {
+            "arg_1": "John"
+          }
+        }
+      }
+    }
+  }
+}

{pycep_parser-0.7.0.dev7 → pycep_parser-0.7.0.dev8}/tests/test_parse_general.py

@@ -87,6 +87,19 @@ def test_parse_type() -> None:
     assert_that(result).is_equal_to(expected_result)
 
 
+def test_parse_func() -> None:
+    # given
+    sub_dir_path = EXAMPLES_DIR / "basic/07-func"
+    file_path = sub_dir_path / "main.bicep"
+    expected_result = json.loads((sub_dir_path / "result.json").read_text())
+
+    # when
+    result = BICEP_PARSER.parse(file_path=file_path)
+
+    # then
+    assert_that(result).is_equal_to(expected_result)
+
+
 def test_parse_param_decorator() -> None:
     # given
     sub_dir_path = EXAMPLES_DIR / "complex/01-param-decorator"