|
| 1 | +######### |
| 2 | +Changelog |
| 3 | +######### |
| 4 | + |
| 5 | +Version 1.4.1 |
| 6 | +============= |
| 7 | + |
| 8 | +* Fix: uregistered bug in trace.TraceConfig - redundant `flags` definition. |
| 9 | +* New: Documentation now contains `Dash` / `Zeal` docset. |
| 10 | + |
| 11 | +Version 1.4.0 |
| 12 | +============= |
| 13 | + |
| 14 | +* Upgrade to protobuf 4.21.1. As this upgrade has consequences, please read |
| 15 | + https://developers.google.com/protocol-buffers/docs/news/2022-05-06#python-updates |
| 16 | + |
| 17 | +Version 1.3.1 |
| 18 | +============= |
| 19 | + |
| 20 | +* `~firebird.base.buffer` module: |
| 21 | + |
| 22 | + - Added `.MemoryBuffer.write_sized_string` for symetry with `.read_sized_string`. |
| 23 | + - Now `.MemoryBuffer` string functions has also `errors` parameter in addition to `encoding`. |
| 24 | + |
| 25 | +* `~firebird.base.config` module: |
| 26 | + |
| 27 | + - Direct assignment to `.Config` option raises a `ValueError` exception with message |
| 28 | + "Cannot assign values to option itself, use `option.value` instead". |
| 29 | + |
| 30 | +Version 1.3.0 |
| 31 | +============= |
| 32 | + |
| 33 | +* `~firebird.base.config` module: |
| 34 | + |
| 35 | + - Layout produced by `.get_config()` was changed. |
| 36 | + - `.Config` has new constructor keyword-only argument `description`. |
| 37 | + - Fix: uregistered bug in config.ListOption - value and default was the same instance |
| 38 | + |
| 39 | +Version 1.2.0 |
| 40 | +============= |
| 41 | + |
| 42 | +* Build scheme changed to `PEP 517`. |
| 43 | +* Various changes to documentation and type hint adjustments. |
| 44 | +* `~firebird.base.config` module: |
| 45 | + |
| 46 | + - **BREAKING CHANGE**: `.ApplicationDirectoryScheme` was replaced by |
| 47 | + `~firebird.base.config.DirectoryScheme` class, and |
| 48 | + `~firebird.base.config.get_directory_scheme()` has changed signature. |
| 49 | + - Directory scheme was reworked and now also supports concept of HOME directory. |
| 50 | + - New MacOS directory scheme support. As I don't have access to MacOS, this support |
| 51 | + should be considered EXPERIMENTAL. Any feedback about it's correctness is welcome. |
| 52 | + - Added: New `.Config` constructor keyword-only `bool` argument `optional` and |
| 53 | + associated `~Config.optional` read-only property. |
| 54 | + - Added: `.Config.has_value()` function. |
| 55 | + - New class: `.PathOption` for Configuration options with `pathlib.Path` value. |
| 56 | +* `~firebird.base.protobuf` module: |
| 57 | + |
| 58 | + - Added: function `.get_message_factory`. |
| 59 | +* `~firebird.base.signal` module: |
| 60 | + |
| 61 | + - Fix: Bug in `eventsocket` signature handling. |
| 62 | +* `~firebird.base.trace` module: |
| 63 | + |
| 64 | + - Added: `apply_to_descendants` boolean configuration option to apply configuration also |
| 65 | + to all registered descendant classes. The default value is `True`. |
| 66 | + |
| 67 | +Version 1.1.0 |
| 68 | +============= |
| 69 | + |
| 70 | +* New module: `signal` - Callback system based on Signals and Slots, and "Delphi events" |
| 71 | +* `~firebird.base.types` module: |
| 72 | + |
| 73 | + - `~firebird.base.types.load` function now supports `object_name[.object_name...]` |
| 74 | + specifications instead single `object_name`. |
| 75 | +* `~firebird.base.config` module: |
| 76 | + |
| 77 | + - New class `.ApplicationDirectoryScheme` |
| 78 | + - `~firebird.base.config.Config.load_config()`: raises error when section is missing, |
| 79 | + better error handling when exception is raised while loading options |
| 80 | + - `~firebird.base.config.PyCallableOption` `signature` argument could be |
| 81 | + `inspect.Signature` or Callable |
| 82 | + - Introduced `.PROTO_CONFIG` constant with fully qualified name for `ConfigProto` protobuf |
| 83 | + - Optional argument `to_default` in `~firebird.base.config.Option.clear()` is now keyword-only. |
| 84 | +* `~firebird.base.logging` module: |
| 85 | + |
| 86 | + - `.get_logging_id()` uses `__qualname__` instead `__name__` |
| 87 | +* `~firebird.base.protobuf` module: |
| 88 | + |
| 89 | + - Added direct support for key well-known data types `Empty`, `Any`, `Duration`, |
| 90 | + `Timestamp`, `Struct`, `Value`, `ListValue` and `FieldMask`. They are automatically |
| 91 | + registered. New constants 'PROTO_<type>' with fully qualified names. |
| 92 | + - `~firebird.base.protobuf.create_message()` has new optional `serialized` argument with |
| 93 | + `bytes` that should be parsed into newly created message instance. |
| 94 | + - New functions `~firebird.base.protobuf.struct2dict()` and `~firebird.base.protobuf.dict2struct()` |
| 95 | +* `~firebird.base.trace` module: |
| 96 | + |
| 97 | + - `~firebird.base.trace.TraceFlag` value `DISABLED` was renamed to `NONE`. |
| 98 | + - Added support for trace configuration based on `~firebird.base.config`, using new |
| 99 | + classes `~firebird.base.trace.BaseTraceConfig`, `~firebird.base.trace.TracedMethodConfig`, |
| 100 | + `~firebird.base.trace.TracedClassConfig` and `~firebird.base.trace.TraceConfig`. |
| 101 | + - New methods in `~firebird.base.trace.TraceManager`: |
| 102 | + |
| 103 | + - `~firebird.base.trace.TraceManager.load_config()` to update trace from configuration. |
| 104 | + - `~firebird.base.trace.TraceManager.set_flag()` and |
| 105 | + `~firebird.base.trace.TraceManager.clear_flag()`. |
| 106 | +* `~firebird.base.types` module: |
| 107 | + |
| 108 | + - `~firebird.base.types.MIME` now handles access to properties more efficiently and faster. |
| 109 | + - New function `~firebird.base.types.load()`. |
| 110 | +* Changes in documentation. |
| 111 | + |
| 112 | +Version 1.0.0 |
| 113 | +============= |
| 114 | + |
| 115 | +* Documentation: new examples for :doc:`trace`, :doc:`logging` and :doc:`hooks` |
| 116 | +* Documentation: adjustments to css |
| 117 | +* DataList is now generic class |
| 118 | +* `.DataList.extract()` has new 'copy' argument. |
| 119 | + |
| 120 | +Version 0.6.1 |
| 121 | +============= |
| 122 | + |
| 123 | +* Promoted to stable |
| 124 | +* More documentation |
| 125 | + |
| 126 | +Version 0.6.0 |
| 127 | +============= |
| 128 | + |
| 129 | +* New module: `~firebird.base.strconv` - Data conversion from/to string |
| 130 | +* New module: `~firebird.base.trace` - Trace/audit for class instances |
| 131 | +* Reworked module: `~firebird.base.config` - Classes for configuration definitions |
| 132 | + |
| 133 | + - New class: `.ConfigOption` - Configuration option with `Config` value |
| 134 | + - New class: `.ConfigListOption` - Configuration option with list of `Config` values |
| 135 | + - New class: `.DataclassOption` - Configuration option with a dataclass value |
| 136 | +* Changed module: `~firebird.base.types` |
| 137 | + |
| 138 | + - New class: `.MIME` - MIME type specification |
| 139 | + - New class: `.PyExpr` - Source code for Python expression |
| 140 | + - New class: `.PyCode` - Python source code |
| 141 | + - New class: `.PyCallable` - Source code for Python callable |
| 142 | + - Removed function: str2bool |
| 143 | +* Changed module: `~firebird.base.logging` |
| 144 | + |
| 145 | + - Trace/audit functionality removed (into new module `~firebird.base.trace`) |
| 146 | + |
| 147 | +Version 0.5.0 |
| 148 | +============= |
| 149 | + |
| 150 | +Initial release. |
0 commit comments