Changelog

1.0.0b1

Warning

Several important breaking changes were introduced in this version.

  • Main modules cannot be imported directly from top-level restio module anymore. You will now need to import from the submodules directly (e.g. what used to be from restio import BaseModel should now be from restio.model import BaseModel, and so on).

  • Added support for descriptors using the base type Field (restio.fields.Field). The following types of Fields are natively available (please visit Fields for all details):

    • IntField
    • StrField
    • BoolField
    • TupleField
    • FrozenSetField
    • ModelField
    • TupleModelField
    • FrozenSetModelField

  • Behavior of BaseModel has been refactored to support Field. The side effect is that dataclasses are no longer supported, and classes should use the descriptor protocol to define fields that must be tracked by restio. As part of that:

    • PrimaryKey and ValueKey have been removed, in favor of Field(pk=True).
    • mdataclass has been removed.
    • BaseModel.pre_setup_model and BaseModel.post_setup_model have been removed.
    • Model dependencies are now tracked via fields with depends_on=True.
    • BaseModel.get_keys() method has been replaced for the property BaseModel.primary_keys, which now returns a dictionary.
    • A new model state UNBOUND has been introduced. All new instances of a model will by default have this state until it is added to a transaction.

  • BaseDAO now contains an internal attribute transaction of type Transaction. This field will always contain the instance of the transaction to which the DAO instance is bound.

  • Transaction.get now requires keyword-only arguments to be provided when passing primary keys. Calls with missing primary keys will fail immediately.

  • Transaction.get will no longer return None when no models are found by the DAO or in the cache. Instead, a RuntimeError will be raised.

  • Transaction.get and Transaction.query will no longer automatically register model dependencies (children). This is done to encourage the use of the Transaction from within the DAOs or queries when retrieving multiple models at the same time.

  • In queries, the use of the self keyword (that received the injected Transaction instance) has been replaced by an optional keyword-only argument transaction.

  • Transaction.query will now always return tuple as a result, regardless of the return type of the query.

  • @query-annotated functions should now return any Iterable type. The order of the results is preserved in the tuple returned by Transaction.query.

  • Type-hinting should now work better than before.

  • The old concept of mutability (indicating if a field can change or not within the premises of restio) has been droped from the framework. From now on, when we refer to mutable attributes/fields we literally mean the general concept of mutability.

  • Documentation have been completely refactored to include latest changes and more practical examples. The old examples have been removed.

  • A number of bugs have been fixed.

0.3.0 & older

<not available>