feat: Serialize model query parameters with `style=form, explode=true` BNCH-18023 #39

forest-benchling · 2021-01-26T15:40:25Z

When I pulled this change into openapi-specs and made the changes in https://github.com/benchling/openapi-specs/pull/138, the generated code looked like this:

def _get_kwargs(
    *,
    client: Client,
    next_token: Union[Unset, None, str] = UNSET,
    page_size: Union[Unset, None, int] = 50,
    sort: Union[Unset, None, ListCustomEntitiesSort] = ListCustomEntitiesSort.MODIFIEDATDESC,
    modified_at: Union[Unset, None, str] = UNSET,
    name: Union[Unset, None, str] = UNSET,
    name_includes: Union[Unset, None, str] = UNSET,
    folder_id: Union[Unset, None, str] = UNSET,
    mentioned_in: Union[Unset, None, List[str]] = UNSET,
    project_id: Union[Unset, None, str] = UNSET,
    registry_id: Union[Unset, None, str] = UNSET,
    schema_id: Union[Unset, None, str] = UNSET,
    schema_field: Union[Unset, None, ListCustomEntitiesSchemaField] = UNSET,
    archive_reason: Union[Unset, None, str] = UNSET,
    mentions: Union[Unset, None, List[str]] = UNSET,
    ids: Union[Unset, None, str] = UNSET,
    entity_registry_idsany_of: Union[Unset, None, str] = UNSET,
) -> Dict[str, Any]:
    url = "{}/custom-entities".format(client.base_url)

    headers: Dict[str, Any] = client.get_headers()

    json_sort: Union[Unset, None, int] = UNSET
    if not isinstance(sort, Unset):
        json_sort = sort.value if sort else None

    json_mentioned_in: Union[Unset, None, List[Any]] = UNSET
    if not isinstance(mentioned_in, Unset):
        if mentioned_in is None:
            json_mentioned_in = None
        else:
            json_mentioned_in = mentioned_in

    json_schema_field: Union[Unset, None, Dict[str, Any]] = UNSET
    if not isinstance(schema_field, Unset):
        json_schema_field = schema_field.to_dict() if schema_field else None

    json_mentions: Union[Unset, None, List[Any]] = UNSET
    if not isinstance(mentions, Unset):
        if mentions is None:
            json_mentions = None
        else:
            json_mentions = mentions

    params: Dict[str, Any] = {}
    if not isinstance(next_token, Unset) and next_token is not None:
        params["nextToken"] = next_token
    if not isinstance(page_size, Unset) and page_size is not None:
        params["pageSize"] = page_size
    if not isinstance(json_sort, Unset) and json_sort is not None:
        params["sort"] = json_sort
    if not isinstance(modified_at, Unset) and modified_at is not None:
        params["modifiedAt"] = modified_at
    if not isinstance(name, Unset) and name is not None:
        params["name"] = name
    if not isinstance(name_includes, Unset) and name_includes is not None:
        params["nameIncludes"] = name_includes
    if not isinstance(folder_id, Unset) and folder_id is not None:
        params["folderId"] = folder_id
    if not isinstance(json_mentioned_in, Unset) and json_mentioned_in is not None:
        params["mentionedIn"] = json_mentioned_in
    if not isinstance(project_id, Unset) and project_id is not None:
        params["projectId"] = project_id
    if not isinstance(registry_id, Unset) and registry_id is not None:
        params["registryId"] = registry_id
    if not isinstance(schema_id, Unset) and schema_id is not None:
        params["schemaId"] = schema_id
    if not isinstance(json_schema_field, Unset) and json_schema_field is not None:
        params.update(json_schema_field)
    if not isinstance(archive_reason, Unset) and archive_reason is not None:
        params["archiveReason"] = archive_reason
    if not isinstance(json_mentions, Unset) and json_mentions is not None:
        params["mentions"] = json_mentions
    if not isinstance(ids, Unset) and ids is not None:
        params["ids"] = ids
    if not isinstance(entity_registry_idsany_of, Unset) and entity_registry_idsany_of is not None:
        params["entityRegistryIds.anyOf"] = entity_registry_idsany_of

    return {
        "url": url,
        "headers": headers,
        "cookies": client.get_cookies(),
        "timeout": client.get_timeout(),
        "params": params,
    }

This should allow us to do schema field queries with by passing in a dict

{
	"schemaField.field1": "value1",
	"schemaField.field2": "value2",
}

forest-benchling · 2021-01-26T16:20:23Z

openapi_python_client/parser/properties/model_property.py

@@ -20,6 +20,7 @@ class ModelProperty(Property):
    _json_type_string: ClassVar[str] = "Dict[str, Any]"

    template: ClassVar[str] = "model_property.pyi"
+    is_dict: ClassVar[bool] = True


not that happy with this, but couldn't think of a better way

We might want a more broad type here in the future, as arrays and other might need more special handling but honestly this is "good enough" for now.

What is this for, to tell if the property is a ModelProperty?

Other places on the codegen check if property.template is set to tell if it's a templated (modeled) property (as opposed to a primitive one). Maybe something similar could be used here?

Yeah. Right now it only applies to ModelProperties, not any other type of property.

bowenwr · 2021-01-26T19:29:31Z

openapi_python_client/parser/properties/model_property.py

@@ -20,6 +20,7 @@ class ModelProperty(Property):
    _json_type_string: ClassVar[str] = "Dict[str, Any]"

    template: ClassVar[str] = "model_property.pyi"
+    is_dict: ClassVar[bool] = True


We might want a more broad type here in the future, as arrays and other might need more special handling but honestly this is "good enough" for now.

packyg

What is the style=form, expload=true referenced in the PR title?

packyg · 2021-01-26T19:34:47Z

openapi_python_client/parser/properties/model_property.py

@@ -20,6 +20,7 @@ class ModelProperty(Property):
    _json_type_string: ClassVar[str] = "Dict[str, Any]"

    template: ClassVar[str] = "model_property.pyi"
+    is_dict: ClassVar[bool] = True


What is this for, to tell if the property is a ModelProperty?

Other places on the codegen check if property.template is set to tell if it's a templated (modeled) property (as opposed to a primitive one). Maybe something similar could be used here?

packyg · 2021-01-26T19:41:28Z

openapi_python_client/templates/endpoint_macros.pyi

+            {% set property_name = "json_" + property.python_name if property.template else property.python_name %}
+if {% if not property.required %}not isinstance({{ property_name }}, Unset) and {% endif %}{{ property_name }} is not None:
+            {% if property.is_dict %}
+    params.update({{ property_name }})


Does this do the prefixing as expected?

I think I would expect something like

Suggested change

params.update({{ property_name }})

params.update({

f"{property.name}.{p}": v, for p, v in {{ property_name }}.items()

})

in order for it to build the params with e.g. schemaField.Plasmid=seq_XYZ instead of just Plasmid=seq_XYZ

It does not handle the prefixing. According to the OpenAPI spec, the parameter name itself does not show up at all in the serialization.

See https://swagger.io/specification/ under "Style Examples"

forest-benchling · 2021-01-26T22:42:10Z

What is the style=form, expload=true referenced in the PR title?

Sorry, it's a bit abstruse, it's OpenAPI terminology for how to serialize query parameters. And is currently the default (and only) behavior in openapi-python-client. @packyg

forest-benchling · 2021-01-27T14:37:20Z

Commit history got messed up because I changed the base from upstream to main-0.v.7.3. Will redo this

packyg

Just the one thing

packyg · 2021-01-27T20:32:21Z

openapi_python_client/parser/properties/model_property.py

@@ -27,6 +27,7 @@ class ModelProperty(Property):
    additional_properties: Union[bool, Property]

    template: ClassVar[str] = "model_property.pyi"
+    json_is_dict: ClassVar[bool] = True


You should add this classvar to the parent class to be consistent:

json_is_dict: ClassVar[bool] = False

It's not erroring now because Jinja is permissive, but if you were to do property.json_is_dict outside of a template, it would error for non-model properties.

forest-benchling changed the title ~~Explode~~ feat: Explode BNCH-18023 Jan 26, 2021

forest-benchling changed the title ~~feat: Explode BNCH-18023~~ feat: Serialize model query parameters with style=form, explode=true BNCH-18023 Jan 26, 2021

forest-benchling requested review from bowenwr and packyg January 26, 2021 16:19

forest-benchling commented Jan 26, 2021

View reviewed changes

bowenwr approved these changes Jan 26, 2021

View reviewed changes

packyg reviewed Jan 26, 2021

View reviewed changes

forest-benchling requested a review from packyg January 26, 2021 22:42

forest-benchling force-pushed the forest-model-property branch from d5073d9 to 2ad8d29 Compare January 27, 2021 14:34

Base automatically changed from forest-model-property to main-v.0.7.3 January 27, 2021 14:35

forest-benchling changed the title ~~feat: Serialize model query parameters with style=form, explode=true BNCH-18023~~ feat: Serialize serializing model query parameters with style=form, explode=true BNCH-18023 Jan 27, 2021

Serialize model query params

7424688

forest-benchling force-pushed the forest-explode branch from 04f43f0 to 7424688 Compare January 27, 2021 14:40

forest-benchling changed the title ~~feat: Serialize serializing model query parameters with style=form, explode=true BNCH-18023~~ feat: Serialize model query parameters with style=form, explode=true BNCH-18023 Jan 27, 2021

packyg approved these changes Jan 27, 2021

View reviewed changes

Address comment

5700bb1

forest-benchling merged commit b0109cd into main-v.0.7.3 Jan 27, 2021

forest-benchling deleted the forest-explode branch January 27, 2021 22:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Serialize model query parameters with `style=form, explode=true` BNCH-18023 #39

feat: Serialize model query parameters with `style=form, explode=true` BNCH-18023 #39

forest-benchling commented Jan 26, 2021 •

edited

Loading

forest-benchling Jan 26, 2021

bowenwr Jan 26, 2021

packyg Jan 26, 2021

forest-benchling Jan 26, 2021

bowenwr Jan 26, 2021

packyg left a comment

packyg Jan 26, 2021

packyg Jan 26, 2021

forest-benchling Jan 26, 2021

forest-benchling commented Jan 26, 2021 •

edited

Loading

forest-benchling commented Jan 27, 2021

packyg left a comment

packyg Jan 27, 2021 •

edited

Loading

feat: Serialize model query parameters with style=form, explode=true BNCH-18023 #39

feat: Serialize model query parameters with style=form, explode=true BNCH-18023 #39

Conversation

forest-benchling commented Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

packyg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forest-benchling commented Jan 26, 2021 • edited Loading

forest-benchling commented Jan 27, 2021

packyg left a comment

Choose a reason for hiding this comment

packyg Jan 27, 2021 • edited Loading

Choose a reason for hiding this comment

feat: Serialize model query parameters with `style=form, explode=true` BNCH-18023 #39

feat: Serialize model query parameters with `style=form, explode=true` BNCH-18023 #39

forest-benchling commented Jan 26, 2021 •

edited

Loading

forest-benchling commented Jan 26, 2021 •

edited

Loading

packyg Jan 27, 2021 •

edited

Loading