Add typing to API arguments (#1076)

* Add typing information

* Rebase

* Passs datetimes not strings

* Rebase

* Handle 3.7

* pre-commit fixes

* Use extension everywhere

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: therve

.generator/conftest.py

@@ -187,7 +187,7 @@ def unique(request):
 TIME_FORMATTER = {
     "now": "datetime.now()",
     "timestamp": "{sret}.timestamp()",
-    "isoformat": '{sret}.isoformat(timespec="seconds")',
+    "isoformat": "{sret}",
     "units": {
         "s": "({sret} + relativedelta(seconds={num}))",
         "m": "({sret} + relativedelta(minutes={num}))",

.generator/src/generator/openapi.py

@@ -113,13 +113,19 @@ def get_type_for_items(schema):
     return name
 
 
-def get_type_for_parameter(parameter):
+def get_type_for_parameter(parameter, typing=False):
     """Return Python type name for the parameter."""
     if "content" in parameter:
         assert "in" not in parameter
         for content in parameter["content"].values():
-            return type_to_python(content["schema"])
-    return type_to_python(parameter.get("schema"))
+            data = type_to_python(content["schema"])
+            if typing:
+                data = data.replace("[", "List[")
+            return data
+    data = type_to_python(parameter.get("schema"))
+    if typing:
+        data = data.replace("[", "List[")
+    return data
 
 
 def get_enum_type(schema):

.generator/src/generator/templates/api.j2

@@ -1,5 +1,7 @@
 {% include "api_info.j2" %}
+from __future__ import annotations
 
+from typing import Any, Dict, List, Union
 
 from {{ package }}.api_client import ApiClient, Endpoint as _Endpoint
 from {{ package }}.model_utils import (
@@ -9,6 +11,8 @@ from {{ package }}.model_utils import (
     get_attribute_from_path,
     file_type,
     none_type,
+    UnsetType,
+    unset,
 )
 {%- for model in get_api_models(operations) %}
 from {{ package }}.{{ version }}.model.{{ model|safe_snake_case }} import {{ model }}
@@ -134,7 +138,8 @@ class {{ classname }}:
 {% endfor %}
 
 {%- for path, method, operation in operations|sort(attribute="2.operationId") %}
-    def {{ operation.operationId|safe_snake_case }}(self, {% for name, parameter in operation|parameters if parameter.required %}{{name|attribute_name}}, {% endfor %}**kwargs):
+{%- set returnType = operation|return_type %}
+    def {{ operation.operationId|safe_snake_case }}(self, {% for name, parameter in operation|parameters if parameter.required %}{{name|attribute_name}}: {{ get_type_for_parameter(parameter, typing=True) }}, {% endfor %}{% for name, parameter in operation|parameters if not parameter.required %}{% if loop.first %}*, {% endif %}{{name|attribute_name}}: Union[{{ get_type_for_parameter(parameter, typing=True) }}, UnsetType]=unset, {% endfor %}) -> {% if returnType %}{{ returnType.replace("[", "List[") }}{% else %}None{% endif %}:
         """{{ operation.summary|indent(8) }}.
 {% if operation.description %}
         {{ operation.description|docstring|indent(8) }}
@@ -153,8 +158,14 @@ class {{ classname }}:
 {%- set returnType = operation|return_type %}
         :rtype: {% if returnType %}{{ returnType }}{% else %}None{% endif %}
         """
-{%- for name, parameter in operation|parameters if parameter.required %}
+        kwargs: Dict[str, Any] = {}
+{%- for name, parameter in operation|parameters %}
+{%- if not parameter.required %}
+        if {{ name|attribute_name }} is not unset:
+            kwargs["{{ name|attribute_name }}"] = {{ name|attribute_name }}
+{%- else %}
         kwargs["{{ name|attribute_name }}"] = {{ name|attribute_name }}
+{%- endif %}
 {% endfor %}
         return self._{{ operation.operationId|safe_snake_case }}_endpoint.call_with_http_info(**kwargs)
     {%- if operation["x-pagination"] %}

.generator/src/generator/templates/model_utils.j2

@@ -1,6 +1,7 @@
 {% include "api_info.j2" %}
 
 from datetime import date, datetime
+import enum
 import inspect
 import io
 import os
@@ -9,6 +10,7 @@ import re
 import tempfile
 from types import MappingProxyType
 from typing import Collection, Mapping, Union
+from typing_extensions import Final
 
 from dateutil.parser import parse
 
@@ -24,6 +26,12 @@ file_type = io.IOBase
 empty_dict = MappingProxyType({})  # type: ignore
 
 
+class UnsetType(enum.Enum):
+    unset = 0
+
+unset: Final = UnsetType.unset
+
+
 def convert_js_args_to_python_args(fn):
     from functools import wraps
 

examples/v1/logs/ListLogs_235998668.py

@@ -15,9 +15,9 @@
     query="host:Test*",
     sort=LogsSort("asc"),
     time=LogsListRequestTime(
-        _from=(datetime.now() + relativedelta(hours=-1)).isoformat(timespec="seconds"),
+        _from=(datetime.now() + relativedelta(hours=-1)),
         timezone="Europe/Paris",
-        to=datetime.now().isoformat(timespec="seconds"),
+        to=datetime.now(),
     ),
 )
 

examples/v1/usage-metering/GetHourlyUsageAttribution.py

@@ -13,7 +13,7 @@
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_hourly_usage_attribution(
-        start_hr=(datetime.now() + relativedelta(days=-3)).isoformat(timespec="seconds"),
+        start_hr=(datetime.now() + relativedelta(days=-3)),
         usage_type=HourlyUsageAttributionUsageType("infra_host_usage"),
     )
 

examples/v1/usage-metering/GetIncidentManagement.py

@@ -11,8 +11,8 @@
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_incident_management(
-        start_hr=(datetime.now() + relativedelta(days=-5)).isoformat(timespec="seconds"),
-        end_hr=(datetime.now() + relativedelta(days=-3)).isoformat(timespec="seconds"),
+        start_hr=(datetime.now() + relativedelta(days=-5)),
+        end_hr=(datetime.now() + relativedelta(days=-3)),
     )
 
     print(response)

examples/v1/usage-metering/GetIngestedSpans.py

@@ -11,8 +11,8 @@
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_ingested_spans(
-        start_hr=(datetime.now() + relativedelta(days=-5)).isoformat(timespec="seconds"),
-        end_hr=(datetime.now() + relativedelta(days=-3)).isoformat(timespec="seconds"),
+        start_hr=(datetime.now() + relativedelta(days=-5)),
+        end_hr=(datetime.now() + relativedelta(days=-3)),
     )
 
     print(response)

examples/v1/usage-metering/GetMonthlyUsageAttribution.py

@@ -15,7 +15,7 @@
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_monthly_usage_attribution(
-        start_month=(datetime.now() + relativedelta(days=-3)).isoformat(timespec="seconds"),
+        start_month=(datetime.now() + relativedelta(days=-3)),
         fields=MonthlyUsageAttributionSupportedMetrics("infra_host_usage"),
     )
 

examples/v1/usage-metering/GetMonthlyUsageAttribution_3849653599.py

@@ -20,7 +20,7 @@
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_monthly_usage_attribution(
-        start_month=(datetime.now() + relativedelta(days=-3)).isoformat(timespec="seconds"),
+        start_month=(datetime.now() + relativedelta(days=-3)),
         fields=MonthlyUsageAttributionSupportedMetrics("infra_host_usage"),
         next_record_id=MONTHLY_USAGE_ATTRIBUTION_METADATA_PAGINATION_NEXT_RECORD_ID,
     )