Working with language strings

[glenrobson]

I've been looking at language strings particularly with labels e.g.:

manifest = Manifest(id='http://iiif.example.org/prezi/Manifest/0', type='Manifest', label={'en': 'label'})

print (manifest.label)

The problem is the label is empty. This is due to the LngString class in the skeleton only containing pass.

The relevant part of the schema is:

"lngString": {
      "title": "Language string, must have a language and value must be an array.",
      "type": "object",
      "patternProperties": {
                "^[a-zA-Z-][a-zA-Z-]*$": {
               "type": "array",
               "items": { "type": "string"}
            },
            "^none$": {
                "type": "array",
                "items": { "type": "string"}
            }
      },
     "additionalProperties": false
},

from IIIF Schema#L11 and it seems pydantic is struggling with patternProperties and how to convert them into python.

Relevant discussions on pydantics:

• JSON Schema patternProperties with Pydantic
• Support for dynamic fields equivalent to patternProperties in JSON Schema

Example lngStrings include:

# single language:
{
   'en': 'label'
}

# multiple languages: 
{
   'en': 'label',
   'cy': 'Welsh Label'
}

[glenrobson]

We think this should work with pydantic:

{
    “type”: “object”
    "propertyNames": {
            "pattern": "^[a-zA-Z-][a-zA-Z-]*$"
      }
    “additionalProperties”: {
        “Type”: “array”,
        “Items”: {  “type”:”string” }    
     }
}

We are going create a small example and create an issue with pydantic.

[giacomomarchioro]

It seems that replacing LngString with:

class LngString(Base):
    __root__: Dict[str, List[str]]

It works as expected.

I have opened an issue in koxudaxi/datamodel-code-generator#696.

[digitaldogsbody]

I will see if it's viable to monkeypatch this fix

[digitaldogsbody]

So far attempts at monkeypatching this have failed because of class inheritance - as we are patching in the helper classes as parents of the schema objects, anything they set (in this case __root__) is overridden by the value set in the schema object class.

[glenrobson]

Decided on the call to edit the skeleton document until this is fixed in pydantic.

[digitaldogsbody]

Skeleton edited - I will leave this issue open because it would still be better to find a sustainable fix that doesn't involve editing the skeleton file every time