Support tuples in forms

[WolfDWyc]

fixes #24

[samuelcolvin]

Looks good, but you need to fix submission - at the moment data is being converted in unflatten into something like this:

    model_data: {
        'profile_pic': <starlette.datastructures.UploadFile object at 0x1084ac090>,
        'dob': '2023-12-01',
        'size': {
            'width': '123',
            'height': '321',
        },
        'address': {
            0: 'foobar',
            1: 'x',
            2: 'y',
        },

In terms of solving this, I see two routes:

• unflatten taking the model and working out if the field is a tuple
• assume that if all keys are completely numeric, then the dict should be converted to a list - this will probably be mucher easier

I think best to wait until we have #66 so you can add tests

[WolfDWyc]

I agree the second solution is simpler, but it appears I have an issue:
If the tuple contains optional values (like the one in the demo), and they aren't passed, we need to know how to fill the list with None values.

This then gets complicated, because we need to check for each value if it's optional - and if so, fill it with a None if it's not provided. Then this gets even more complicated since model fields can't be optional (SizeModel | None has no effect), so they shouldn't actually be filled.

What do you think @samuelcolvin? Do I have to go for the second option? Or can the frontend somehow return null for optional values instead of omitting them?

[samuelcolvin]

Well, I guess the least bad option is to pass the model to unflatten, then use its JSON Schema to work out how many elements that tuple needs to have and pack the resultant list/tuple with None.

It might be quickest (in terms of writing code at least, if not performance) to call our existing function to flatten the JSON Schema and get a dict of {field_key: tuple_length/None}.

I hope that helps.

[samuelcolvin]

Or we could just error and say it's not possible unless all fields are required as a first solution.

[WolfDWyc]

I think that initial solution is much better for now. I think most use cases for tuples are gonna be something such as X, Y, Z and won't require optionals.

I implemented this and updated the demo accordingly.

[samuelcolvin]

looking good, but needs tests now we have the machinery in place for tests.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4274a8d) 87.71% compared to head (3e7641c) 94.01%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #52      +/-   ##
==========================================
+ Coverage   87.71%   94.01%   +6.29%     
==========================================
  Files          11       11              
  Lines         700      718      +18     
==========================================
+ Hits          614      675      +61     
+ Misses         86       43      -43     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[WolfDWyc]

Sorry I haven't been able to finish this myself and you had to step in @samuelcolvin, something popped up. Thank you for completing it!

[samuelcolvin]

No problem, thanks for your work