TODO.rst

TODO

• identity.record_id() should never return unhashable types!
• copy constructor (teaching __init__() to take an object might work), to be used by MultiFieldSelector([]).get()
• FieldSelector should define __or__() to return a MultiFieldSelector
• dealing with unexpectedly bad input data:
  • from_json variant/option which scrubs data which fails in any way, returning objects which could be parsed and left-over JSON which couldn't be parsed.
  • support for polymorphic JSON, either through a flag field (special field is mapped to type) or via subclass duck-typing (subclass is selected automatically based on keys seen on input)
• collections:
  • Support DictCollection key typing
  • implement SetCollection (probably as DictCollection's that map values to themselves)
• property traits for basic XML marshal support (in case the 90's calls and wants to send us some data)
• refactor all the ugly if isinstance(x, Y): blocks to use simplegeneric instead
• avro marshaling
• property traits for schema systems which number attributes, to support thrift

Untested cases

The following cases are known to be missing tests:

• the examples in the intro could do with a regression test
• JSON marshaling tests;
  • Record types with attributes which are Record types that implement json_data without deriving JsonRecord, with and without the extraneous parameter.
  • RecordList types with a member type which implements json_data
  • marshaling out native dicts/lists with Record members (marshall in will not be supported without custom json_to_initkwargs methods)
  • marshaling in & out long values
  • check json_name=None suppresses marshal out via JSON
  • using from_json with json strings (not JSON data)
  • double-check setting extraneous suppresses marshal out
• required, but lazy attributes
• del record.property and record.property = None
• FieldSelector with None components indicating "all members of a collection"
• MultiFieldSelector unspecifically needs more tests, because parts of its recursive constructor aren't reached that I thought should be by its test case. They should be reached, or the code simplified.
• Untested Exception Paths:
  • bad combinations of attribute traits
  • DiffInfo made with missing field selector properties
  • mis-use of ListProperty
  • multiple inheritance between Record types defining clashing properties