terminusdb-client-python icon indicating copy to clipboard operation
terminusdb-client-python copied to clipboard

Python schema doesn't accept optional attributes of types ```List``` and ```Set```

Open micgor32 opened this issue 1 year ago • 3 comments

Describe the bug The Python schema.py does not allow attributes to be the type of List or Set, when they are meant to be optional.

To Reproduce When I try to commit the following code using tdbpy commit:

class Organization(DocumentTemplate):
    name: Optional[str]
    id: Optional[str]
    identifier: Optional[Identifier]
    additionalIdentifiers: Optional[Identifier]
    address: Optional[Address]
    contactPoint: Optional[ContactPoint]
    roles: Optional[List[str]]

I get the following error message:

Error logs

Traceback (most recent call last):
  File "/home/micgor32/.local/bin/tdbpy", line 8, in <module>
    sys.exit(tdbpy())
             ^^^^^^^
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/click/core.py", line 1055, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/click/core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/terminusdb_client/scripts/scripts.py", line 361, in commit
    schema_obj.commit(client, commit_msg=message, full_replace=True)
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/terminusdb_client/schema/schema.py", line 676, in commit
    client.insert_document(
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/terminusdb_client/client/Client.py", line 1248, in insert_document
    result = json.loads(_finish_response(result))
                        ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/micgor32/.local/pipx/venvs/terminusdb-client/lib/python3.11/site-packages/terminusdb_client/woql_utils.py", line 52, in _finish_response
    raise DatabaseError(request_response)
terminusdb_client.errors.DatabaseError: Type error for json{'@class':"xsd:string",'@type':"List"} which should be text
{
    "api:message": "Type error for json{'@class':\"xsd:string\",'@type':\"List\"} which should be text",
    "api:status": "api:failure",
    "system:witnesses": [
        {
            "@type": "vio:ViolationWithDatatypeObject",
            "vio:literal": "json{'@class':\"xsd:string\",'@type':\"List\"}",
            "vio:message": "Type error for json{'@class':\"xsd:string\",'@type':\"List\"} which should be text",
            "vio:type": "text"
        }
    ]
}

Same happens when roles: Optional[List[str]] is changed to roles: Optional[Set[str]].

Expected behavior I would expect the changes to be accepted and added to the schema.

System information (please complete the following information):

  • OS: Docker
  • terminus-client-python 10.2.3

micgor32 avatar Jun 26 '23 11:06 micgor32

I'll take a look at this now. The Set is always optional, so it should allow this, and for List it is never optional, so you probably need to use an Array if it is.

GavinMendelGleason avatar Jun 28 '23 11:06 GavinMendelGleason

This error needs to be more informative too.

GavinMendelGleason avatar Jun 28 '23 11:06 GavinMendelGleason

We can have a work around for this where Optional[List[...]] is converted to and from Array potentially. Not sure what the best behaviour is.

GavinMendelGleason avatar Jul 13 '23 12:07 GavinMendelGleason