robotframework-openapitools 1.0.0b3__py3-none-any.whl → 1.0.0b5__py3-none-any.whl

openapi_libgen/spec_parser.py

@@ -1,13 +1,18 @@
-from dataclasses import dataclass
 from os import getenv
 from string import Template
-from typing import Any, Generator
+from typing import Generator
 
 from robot.utils import is_truthy
 
 from openapi_libgen.parsing_utils import remove_unsafe_characters_from_string
+from OpenApiLibCore.models import (
+    ObjectSchema,
+    OpenApiObject,
+    OperationObject,
+    PathItemObject,
+    SchemaObjectTypes,
+)
 from OpenApiLibCore.parameter_utils import get_safe_name_for_oas_name
-from OpenApiLibCore.value_utils import python_type_by_json_type_name
 
 KEYWORD_TEMPLATE = r"""@keyword
     {signature}
@@ -36,78 +41,29 @@ class BodyTemplate(Template):
 BODY_TEMPLATE = BodyTemplate(BODY_TEMPLATE_)
 
 
-@dataclass
-class OperationDetails:
+class OperationDetails(OperationObject):
     path: str
     method: str
-    parameters: list[dict[str, Any]]
-    request_body: dict[str, Any]
-    summary: str
-    description: str
-    operation_id: str | None = (
-        None  # operationId MUST be unique within the spec, so no default ""
-    )
 
 
-@dataclass
-class ParameterDetails:
-    type: str
-    name: str
-    schema: dict[str, Any]
-
-
-@dataclass
-class BodyDetails:
-    schema: dict[str, Any]
-
-
-def get_path_items(paths: dict[str, Any]) -> Generator[OperationDetails, None, None]:
-    for path, operation_items in paths.items():
-        for method, method_item in operation_items.items():
+def get_path_items(
+    paths: dict[str, PathItemObject],
+) -> Generator[OperationDetails, None, None]:
+    for path, path_item_object in paths.items():
+        operations = path_item_object.get_operations()
+        for method, operation_object in operations.items():
             operation_details = OperationDetails(
                 path=path,
                 method=method,
-                operation_id=method_item.get("operationId", None),
-                parameters=method_item.get("parameters", []),
-                request_body=method_item.get("requestBody", {}),
-                summary=method_item.get("summary"),
-                description=method_item.get("description"),
+                operationId=operation_object.operationId,
+                parameters=operation_object.parameters,
+                requestBody=operation_object.requestBody,
+                summary=operation_object.summary,
+                description=operation_object.description,
             )
             yield operation_details
 
 
-def get_parameter_details(
-    operation_details: OperationDetails,
-) -> list[ParameterDetails]:
-    def _get_parameter_details(
-        data: OperationDetails,
-    ) -> Generator[ParameterDetails, None, None]:
-        for param_data in data.parameters:
-            name = param_data["name"]
-            type = param_data["in"]
-            if not (schema := param_data.get("schema", {})):
-                content = param_data["content"]
-                for _, media_data in content.items():
-                    schema = media_data["schema"]
-
-            yield ParameterDetails(
-                type=type,
-                name=name,
-                schema=schema,
-            )
-
-    return list(_get_parameter_details(data=operation_details))
-
-
-def get_body_details(operation_details: OperationDetails) -> BodyDetails | None:
-    if not (body_data := operation_details.request_body):
-        return None
-    content = body_data["content"]
-    if not (schema := content.get("application/json")):
-        return None
-    return BodyDetails(schema=schema["schema"])
-
-
 def get_keyword_signature(operation_details: OperationDetails) -> str:
     USE_SUMMARY_AS_KEYWORD_NAME = getenv("USE_SUMMARY_AS_KEYWORD_NAME")
     EXPAND_BODY_ARGUMENTS = getenv("EXPAND_BODY_ARGUMENTS")
@@ -116,21 +72,19 @@ def get_keyword_signature(operation_details: OperationDetails) -> str:
         keyword_name = remove_unsafe_characters_from_string(
             operation_details.summary
         ).lower()
-    elif operation_details.operation_id:
+    elif operation_details.operationId:
         keyword_name = remove_unsafe_characters_from_string(
-            operation_details.operation_id
+            operation_details.operationId
         ).lower()
     else:
         keyword_name = remove_unsafe_characters_from_string(
             f"{operation_details.method}_{operation_details.path}"
-        )
-
-    parameters = get_parameter_details(operation_details=operation_details)
-    path_parameters = [p for p in parameters if p.type == "path"]
-    query_parameters = [p for p in parameters if p.type == "query"]
-    header_parameters = [p for p in parameters if p.type == "header"]
+        ).lower()
 
-    body_details = get_body_details(operation_details=operation_details)
+    parameters = operation_details.parameters or []
+    path_parameters = [p for p in parameters if p.in_ == "path" and p.schema_]
+    query_parameters = [p for p in parameters if p.in_ == "query" and p.schema_]
+    header_parameters = [p for p in parameters if p.in_ == "header" and p.schema_]
 
     argument_parts: list[str] = []
     # Keep track of the already used argument names. From the OAS:
@@ -139,34 +93,21 @@ def get_keyword_signature(operation_details: OperationDetails) -> str:
     keyword_argument_names: set[str] = set()
 
     for parameter in path_parameters:
-        if "anyOf" in parameter.schema:
-            parameter_python_type = "Any"
-        else:
-            parameter_json_type = parameter.schema["type"]
-            parameter_python_type = python_type_by_json_type_name(
-                parameter_json_type
-            ).__name__
-        annotation = f"{parameter_python_type} = UNSET"
+        annotation = f"{parameter.schema_.annotation_string} = UNSET"  # type: ignore[union-attr]
         safe_name = get_safe_name_for_oas_name(parameter.name)
         keyword_argument_names.add(safe_name)
         argument = f", {safe_name}: {annotation}"
         argument_parts.append(argument)
     arguments = "".join(argument_parts)
 
-    if body_details:
-        body_json_type = body_details.schema["type"]
-        body_python_type = python_type_by_json_type_name(body_json_type).__name__
-        if body_python_type == "dict" and is_truthy(EXPAND_BODY_ARGUMENTS):
-            body_properties = body_details.schema["properties"]
-            for property_name, property_data in body_properties.items():
-                if "anyOf" in property_data:
-                    property_python_type = "Any"
-                else:
-                    property_json_type = property_data["type"]
-                    property_python_type = python_type_by_json_type_name(
-                        property_json_type
-                    ).__name__
-                annotation = f"{property_python_type} = UNSET"
+    if operation_details.requestBody and operation_details.requestBody.schema_:
+        schema = operation_details.requestBody.schema_
+        if isinstance(schema, ObjectSchema) and is_truthy(EXPAND_BODY_ARGUMENTS):
+            body_properties: dict[str, SchemaObjectTypes] = getattr(
+                schema.properties, "root", {}
+            )
+            for property_name, property_schema in body_properties.items():
+                annotation = f"{property_schema.annotation_string} = UNSET"
                 safe_name = get_safe_name_for_oas_name(property_name)
                 if safe_name in keyword_argument_names:
                     safe_name = "body_" + safe_name
@@ -174,19 +115,12 @@ def get_keyword_signature(operation_details: OperationDetails) -> str:
                 argument = f", {safe_name}: {annotation}"
                 arguments += argument
         else:
-            annotation = f"{body_python_type} = UNSET"
+            annotation = f"{schema.annotation_string} = UNSET"
             argument = f", body: {annotation}"
             arguments += argument
 
     for parameter in query_parameters:
-        if "anyOf" in parameter.schema:
-            parameter_python_type = "Any"
-        else:
-            parameter_json_type = parameter.schema["type"]
-            parameter_python_type = python_type_by_json_type_name(
-                parameter_json_type
-            ).__name__
-        annotation = f"{parameter_python_type} = UNSET"
+        annotation = f"{parameter.schema_.annotation_string} = UNSET"  # type: ignore[union-attr]
         safe_name = get_safe_name_for_oas_name(parameter.name)
         if safe_name in keyword_argument_names:
             safe_name = "query_" + safe_name
@@ -195,14 +129,7 @@ def get_keyword_signature(operation_details: OperationDetails) -> str:
         arguments += argument
 
     for parameter in header_parameters:
-        if "anyOf" in parameter.schema:
-            parameter_python_type = "Any"
-        else:
-            parameter_json_type = parameter.schema["type"]
-            parameter_python_type = python_type_by_json_type_name(
-                parameter_json_type
-            ).__name__
-        annotation = f"{parameter_python_type} = UNSET"
+        annotation = f"{parameter.schema_.annotation_string} = UNSET"  # type: ignore[union-attr]
         safe_name = get_safe_name_for_oas_name(parameter.name)
         if safe_name in keyword_argument_names:
             safe_name = "header_" + safe_name
@@ -220,8 +147,8 @@ def get_keyword_body(data: OperationDetails) -> str:
     return BODY_TEMPLATE.safe_substitute(path_value=data.path, method_value=data.method)
 
 
-def get_keyword_data(openapi_spec: dict[str, Any]) -> Generator[str, None, None]:
-    for path_item in get_path_items(openapi_spec["paths"]):
+def get_keyword_data(openapi_object: OpenApiObject) -> Generator[str, None, None]:
+    for path_item in get_path_items(openapi_object.paths):
         signature = get_keyword_signature(path_item)
         body = get_keyword_body(path_item)
         yield KEYWORD_TEMPLATE.format(signature=signature, body=body)

{robotframework_openapitools-1.0.0b3.dist-info → robotframework_openapitools-1.0.0b5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robotframework-openapitools
-Version: 1.0.0b3
+Version: 1.0.0b5
 Summary: A set of Robot Framework libraries to test APIs for which the OAS is available.
 License: Apache License
                                     Version 2.0, January 2004
@@ -220,6 +220,7 @@ Requires-Dist: Jinja2 (>=3.1.2)
 Requires-Dist: black (>=24.1.0)
 Requires-Dist: openapi-core (>=0.19.0)
 Requires-Dist: prance[cli] (>=23)
+Requires-Dist: pydantic (>=2.11.0)
 Requires-Dist: requests (>=2.31.0)
 Requires-Dist: rich_click (>=1.7.0)
 Requires-Dist: robotframework (>=6.0.0,!=7.0.0)

robotframework_openapitools-1.0.0b5.dist-info/RECORD

@@ -0,0 +1,40 @@
+OpenApiDriver/__init__.py,sha256=YjHr-j8g9KwRriNCw_ABvCEbUEp118J70xeJ_t7qcas,1453
+OpenApiDriver/openapi_executors.py,sha256=uVXECVQV6cn7dwJ1so_A736f_ziPUi55094UKA2SNoE,12721
+OpenApiDriver/openapi_reader.py,sha256=1M3nFRRLgD3Vepiru_jqYgVrnkRznFpR7lzdUKetxYw,4340
+OpenApiDriver/openapidriver.libspec,sha256=0wDFhYoYqsP8lfkgVZ5IVokpmwAtb8k3EFeQL6_s26s,26481
+OpenApiDriver/openapidriver.py,sha256=vypR00YZS3ygGfFxdUedLdCm_f_bWDLMpD1vb49-O0A,15321
+OpenApiDriver/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+OpenApiLibCore/__init__.py,sha256=CGfgD0W2GcRDc5Q-tDpWk4IDpUmdCSZVPZ18a_KN-co,1733
+OpenApiLibCore/annotations.py,sha256=YmvWKTbhyxRk2aWFra3v-3p30e96TFJ-CV9f3X90rPs,238
+OpenApiLibCore/data_generation/__init__.py,sha256=NJViPQGHkczF2gxfS0wE2vE3wCRU9ixDEwHPMZApu6A,206
+OpenApiLibCore/data_generation/body_data_generation.py,sha256=GkoQec3hEbpRr_hMwFJjFDjACQ776Uj3x3bhmB4TJVo,8348
+OpenApiLibCore/data_generation/data_generation_core.py,sha256=MUjMJR5luhuPIU9fO5DflJhB0a6LVrHHoTqpEajXqxM,7938
+OpenApiLibCore/data_invalidation.py,sha256=UqCQe62fkTUQdYofbVpBBS11kFeOsN6DJHCRFy0FC9w,11158
+OpenApiLibCore/dto_base.py,sha256=r7tek0Ui-Zl05Dk1jXAUT00SfcUuN7mprXolHSMXMaI,9313
+OpenApiLibCore/dto_utils.py,sha256=-mpG2tsjRuldDH9hms1hay6kDNNvVXl7XzLu8RUxjIg,4173
+OpenApiLibCore/localized_faker.py,sha256=-Z3ry6V7xIkmAlUq70a1L_OspAPZTDFt4RFo3zj4Llo,2205
+OpenApiLibCore/models.py,sha256=EfSxhcY78qTVyzWp4wHLE5h1kYR4QhjGQ-mkmIwgxg4,22813
+OpenApiLibCore/oas_cache.py,sha256=Z2v0mn6JwKchbUKojYVt9sXi8Mc4LoENtN_ekTUtzfI,387
+OpenApiLibCore/openapi_libcore.libspec,sha256=YQUtfd21f2UKKGPItrhqkDzS7Enk_z6hAwiXgxE9O4M,44120
+OpenApiLibCore/openapi_libcore.py,sha256=P2Uxd5QNM8bFKPHnNPl-Kjh-3Qf_3oKTn1frbD-FxRg,36070
+OpenApiLibCore/parameter_utils.py,sha256=Df1RajxtZNLD5UDFEBxprxKpGiUn52SeG04Ms96JnDA,3527
+OpenApiLibCore/path_functions.py,sha256=8WW4BA14hNDx4dD_F40EGZSgDWO3yk5CxhrjqGpIkeU,8002
+OpenApiLibCore/path_invalidation.py,sha256=RIf6pZIszz13nfuIQzOzK8sXZCrFSmEbXivfpc1jGRg,1435
+OpenApiLibCore/protocols.py,sha256=qvCLUohC8OZhTxtabYPLJE0gGWB9L6GHwdGT1T8zKpM,1072
+OpenApiLibCore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+OpenApiLibCore/request_data.py,sha256=KK-pPyfZUJGh9uPNUrvYb-DxumPGH9vcqJ_bdKJnmYw,8887
+OpenApiLibCore/resource_relations.py,sha256=38Cd9FVvV0FCiTMc5uQleRVyQFbvnGaoiXOruKcOpag,1773
+OpenApiLibCore/validation.py,sha256=xdWLaYslwlbBesaBzJfoQeCuseiCSZyCdFC7JLGqGQQ,14977
+OpenApiLibCore/value_utils.py,sha256=6DcTSpYlo_moAY04K45iSvREQXtO5d9IK8ln5RAaims,7545
+openapi_libgen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openapi_libgen/command_line.py,sha256=rWByjZDPYYra6WOsINL2zj5Ny3YSIXiTrhRjSBA4FRE,2380
+openapi_libgen/generator.py,sha256=tO-ZKVqk9s5lx0Pz7Mzq5ChiZp-hOVomrrI3yiCqU_g,2767
+openapi_libgen/parsing_utils.py,sha256=ORJJq8QNPMFUI_shdzeRFYydyy9YsEm0TaWrpqqZubI,1039
+openapi_libgen/spec_parser.py,sha256=lfYwwmGO0gsZH5gHttccxIxltI-2JSAAJma0k03tmRg,6414
+openapi_libgen/templates/__init__.jinja,sha256=92OFwNzeO7lEiUBv04GfjKXA1088V7GbeneASBShbmc,102
+openapi_libgen/templates/library.jinja,sha256=tIwJuGerOUJmMt928P_38MMfcnSHZqcPDPEJ56R6wT0,952
+robotframework_openapitools-1.0.0b5.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+robotframework_openapitools-1.0.0b5.dist-info/METADATA,sha256=cAM9pwMYq_C2u-ZE-79_w-gmamnhSHrLpC5Ps3zYTck,19102
+robotframework_openapitools-1.0.0b5.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+robotframework_openapitools-1.0.0b5.dist-info/entry_points.txt,sha256=_yd5PITEJf85hIEsrRkkWxXePf_O9YOOUjON3TYLy0c,69
+robotframework_openapitools-1.0.0b5.dist-info/RECORD,,

robotframework_openapitools-1.0.0b3.dist-info/RECORD

@@ -1,37 +0,0 @@
-OpenApiDriver/__init__.py,sha256=YjHr-j8g9KwRriNCw_ABvCEbUEp118J70xeJ_t7qcas,1453
-OpenApiDriver/openapi_executors.py,sha256=NsHhcP6CM3DsQgxqOcKhpAAOM0zjhMmCsrEygIxJleY,12534
-OpenApiDriver/openapi_reader.py,sha256=BPD_T8PUjfB-NBajogErI2ATmzlUGFJT8Nx5WpM5N5Y,4478
-OpenApiDriver/openapidriver.libspec,sha256=O5gfWifWEvOmZ8sJoEdGcsP6Wak2zHYdEVB1TPIub6Y,28220
-OpenApiDriver/openapidriver.py,sha256=vypR00YZS3ygGfFxdUedLdCm_f_bWDLMpD1vb49-O0A,15321
-OpenApiDriver/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-OpenApiLibCore/__init__.py,sha256=R6n4FTEz0IGD_LehKkOFSQrlt9Bk4Ugl3OicsZ_h84I,1775
-OpenApiLibCore/annotations.py,sha256=zfWwItXzECBezyQKoom9BLfrRFlU1u4jOF7NEgEAuQQ,135
-OpenApiLibCore/data_generation/__init__.py,sha256=KYBoMeFsa4fzb6E-BsQBykCGwt54NvXthXiy9VNwQBc,303
-OpenApiLibCore/data_generation/body_data_generation.py,sha256=c887DfNMghHFyu3omUDxA0SkaQtMaNiWYNM3YREbbEQ,8903
-OpenApiLibCore/data_generation/data_generation_core.py,sha256=N6hgyc2WHnPfIRwqdUwmT9XSGM2P-l88K2kblk0VCeA,8413
-OpenApiLibCore/data_invalidation.py,sha256=HSzbeJnzxrlS2NlPfXnCRXvGzGzXvBwiaJ3WXxrZOSw,10503
-OpenApiLibCore/dto_base.py,sha256=m41QZyL6ChIcC3DcBCpDFkok5wpCZ6K9gjmADyMGOWc,12132
-OpenApiLibCore/dto_utils.py,sha256=5dvMYM2Nt9gXq6GGTGJjU5Z75x9p9ky-1V01aLTZgX8,3177
-OpenApiLibCore/oas_cache.py,sha256=Z2v0mn6JwKchbUKojYVt9sXi8Mc4LoENtN_ekTUtzfI,387
-OpenApiLibCore/openapi_libcore.libspec,sha256=5NrzbwAsk-qUs504hu0DLjtvDhYJfgpvWiqjSPksGZg,53175
-OpenApiLibCore/openapi_libcore.py,sha256=30FtvsNHkfWZhz55bJq8bnWiHKvX6dEbGyLhbdNAtqY,36257
-OpenApiLibCore/parameter_utils.py,sha256=_P2GRc_teIixTgPsRgCxY2Bj6nsZq41GoSOhVgfXE0Y,3251
-OpenApiLibCore/path_functions.py,sha256=757f655yLg5HzvXxlOIQ76i48gK91Ct7KM-D9OAEA3A,8055
-OpenApiLibCore/path_invalidation.py,sha256=2iYjkskMV-7lWu_id_LbVIiumffMWZicqoIKeewqpFA,1539
-OpenApiLibCore/protocols.py,sha256=N9HxH9SqNuzWTyOGQuyEGfyorHZyYkehlBsyPse5jtQ,763
-OpenApiLibCore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-OpenApiLibCore/request_data.py,sha256=jm6HnTG4xvQfSeYPMIMzowlSi7cuU3XqDGTQ6FdKnUY,10644
-OpenApiLibCore/resource_relations.py,sha256=Qp5TBNSArLaDfAqcjC5xiHwlB1h4hgAFIfuJnBg5Yxw,1710
-OpenApiLibCore/validation.py,sha256=uVPgg3k5X1ww4u4-glqC2szSL1qsvqgnCUoqUMjpnek,20067
-OpenApiLibCore/value_utils.py,sha256=M4k5m0YW1B20-6KD0f9-5xMERWKG8ncu2-5ahC2_VzU,19208
-openapi_libgen/__init__.py,sha256=9ZfgPSI8AUAcJ59hBRZE1VImhMVRyt6G_w1nYIPORgQ,1543
-openapi_libgen/command_line.py,sha256=GppzNAAMomd0Dl5c5HGK8chDQw-kaIztD0hqQ2iUEXE,2783
-openapi_libgen/parsing_utils.py,sha256=d_N-v619SR6iyolz65IGN12H5wMUA8dzPuG1l7rv5gg,821
-openapi_libgen/spec_parser.py,sha256=2swZDlr8pHkNHCaLZMkl9fZbi9GWDFfnstPbLB12jTU,8792
-openapi_libgen/templates/__init__.jinja,sha256=92OFwNzeO7lEiUBv04GfjKXA1088V7GbeneASBShbmc,102
-openapi_libgen/templates/library.jinja,sha256=tIwJuGerOUJmMt928P_38MMfcnSHZqcPDPEJ56R6wT0,952
-robotframework_openapitools-1.0.0b3.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-robotframework_openapitools-1.0.0b3.dist-info/METADATA,sha256=d99DolkNRk-sYtseHrh82lY2MJHZW6wLpJvZTpMfsUk,19067
-robotframework_openapitools-1.0.0b3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-robotframework_openapitools-1.0.0b3.dist-info/entry_points.txt,sha256=_yd5PITEJf85hIEsrRkkWxXePf_O9YOOUjON3TYLy0c,69
-robotframework_openapitools-1.0.0b3.dist-info/RECORD,,