Release History

v1.12.0 (2019-10-11)


  • The RunRouter can now “fill” documents that reference externally stored data. It accepts an optional handler_registry and root_map which it uses to create instances of Filler internally. The default behavior of RunRouter has not changed because it defaults to handler_registry={} and fill_or_fail=False, meaning that any external reference not found in handler_registry will be passed through unfilled. For advanced customizations—such as custom cache management—use the parameter filler_class to specifiy an API-compatible alternative to Filler.


  • The handler_registry attribute of Filler is now a read-only view. It cannot be directly mutated. Instead, use the new methods register_handler() and deregister_handler().


  • Fix cache management in Filler such that registering a new handler for a given spec clears all cached instances of the previously registered handler.

  • Fix the validation feature in DocumentRouter, which previously raised an error if used.

v1.11.2 (2019-09-03)


  • Include requirements.txt in source distribution.

  • When UnresolveableForeignKeyError is raised, it always includes a key attribute with the key in question.

v1.11.1 (2019-08-09)


  • Fix some inconsistent behavior in the Filler inplace parameter, and test it better.

v1.11.0 (2019-06-27)


  • Added new optional parameter inplace to Filler.

  • Added new methods fill_event() and fill_event_page().

  • Added rechunk_event_pages().


  • Consult the Event Descriptor document to infer which columns need to be filled if there is no explicit 'filled' key in the Event document.

v1.10.0 (2019-05-24)

This release requires jsonschema>3. Previous releases required jsonschema<3.


  • Added schema_validators using the new interface in jsonschema 3.0.


  • The counters in num_events in the RunStop document were off by one.

v1.9.0 (2019-05-01)



  • unpack_datum_page() errored when datum_kwargs were empty.

  • Fill EventPages in place, as Events are filled in place.

  • Do not assume Events and EventPages have a filled key; it is optional.

v1.8.3 (2019-03-28)


  • Add 'configuration' to EventDescriptor schema.

  • Fix path semantics and be robust against empty 'filled'.

  • Fix sequence numbers in compose_descriptor().

  • Fix a typo which made 'num_events' always empty.

v1.8.2 (2019-03-08)

Fix meta-data to include python_requires. This prevents the wheels from being installed on python < 3.6.

v1.8.0 (2019-03-05)


v1.7.0 (2019-01-03)


  • The DataKey in an EventDescriptors may contain a ‘dims’ key, providing names for each dimension of the data.

  • Convenience functions for composing valid documents have been added. These are experimental and may change in a future release in a non-backward-compatible way.