CHANGELOG.rst 7.32 KB
Newer Older
Paul McCarthy's avatar
Paul McCarthy committed
1
2
This document contains the ``fsleyes-props`` release history in reverse
chronological order.
Paul McCarthy's avatar
Paul McCarthy committed
3
4


5
6
7
8
9
10
11
12
13
14
15
16
17

1.7.3 (Wednesday April 21st 2021)
---------------------------------


Changed
^^^^^^^

* Fixed deprecated usage of the ``matplotilb.cm.cmap_d`` colour map
  dictionary.


1.7.2 (Saturday March 27th 2021)
Paul McCarthy's avatar
Paul McCarthy committed
18
19
20
21
22
23
24
25
26
27
28
--------------------------------


Changed
^^^^^^^

* The :class:`.Color` property type now accepts any value that is accepted by
  the `matplotlib.to_rgba
  <https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.to_rgba.html>`_
  function.
* Properties of type The :class:`.Int` and :class:`.Real` can be set to
Paul McCarthy's avatar
Paul McCarthy committed
29
  ``None`` (unless ``required=True and allowInvalid=False``).
Paul McCarthy's avatar
Paul McCarthy committed
30
31


Paul McCarthy's avatar
Paul McCarthy committed
32
33
34
35
36
37
38
39
40
41
42
1.7.1 (Tuesday March 9th 2021)
------------------------------


Changed
^^^^^^^


* The ``fsleyes-props`` API documentation is now hosted at
  https://open.win.ox.ac.uk/pages/fsl/fsleyes/props/
* ``fsleyes-props`` is now tested against Python 3.7, 3.8, and 3.9.
Paul McCarthy's avatar
Paul McCarthy committed
43
* Removed ``six`` as a dependency.
Paul McCarthy's avatar
Paul McCarthy committed
44
45


Paul McCarthy's avatar
Paul McCarthy committed
46
47
1.7.0 (Tuesday May 26th 2020)
-----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
48
49
50
51
52
53
54
55
56


Added
^^^^^


* Added a short-hand alias for :class:`.HasProperties` - ``HasProps``.


Paul McCarthy's avatar
Paul McCarthy committed
57
58
59
60
61
62
63
64
65
66
67
1.6.7 (Friday October 4th 2019)
-------------------------------


Changed
^^^^^^^


* Minor GTK3 compatibility fixes.


Paul McCarthy's avatar
Paul McCarthy committed
68
69
70
71
72
73
74
75
76
77
78
79
80
1.6.6 (Wednesday September 18th 2019)
-------------------------------------


Changed
^^^^^^^


* ``fsleyes-props`` is no longer tested against Python 2.7-3.5, but is now
  tested against Python 3.6-3.8, and GTK3.



Paul McCarthy's avatar
Paul McCarthy committed
81
82
83
84
85
86
87
88
89
90
91
1.6.5 (Monday January 7th 2019)
-------------------------------


Changed
^^^^^^^


* Removed the ``deprecation`` library as a dependency.


Paul McCarthy's avatar
Paul McCarthy committed
92
93
94
95
96
97
98
99
100
101
102
103
104
1.6.4 (Friday October 5th 2018)
-------------------------------


Changed
^^^^^^^


* Development (test and documentation dependencies) are no longer listed
  in ``setup.py`` - they now need to be installed manually.
* Removed conda build infrastructure.


Paul McCarthy's avatar
Paul McCarthy committed
105
106
107
108
109
110
111
112
113
114
115
1.6.3 (Thursday July 5th 2018)
------------------------------


Changed
^^^^^^^


* Removed ``pytest-runner`` as a dependency.


Paul McCarthy's avatar
Paul McCarthy committed
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
1.6.2 (Tuesday June 5th 2018)
-----------------------------


Added
^^^^^


* The :mod:`.serialise` module now has support for :class:`.Array` property
  types.


Fixed
^^^^^


* Fixed a regression in the :class:`.SyncableHasProperties` class.


Paul McCarthy's avatar
Paul McCarthy committed
135
136
1.6.1 (Friday May 11th 2018)
----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153


Fixed
^^^^^


* Fixed an issue in the behaviour of the :meth:`.HasProperties.addProperty`
  method and the :mod:`.syncable` module, with handling of class hierarchies.


Deprecated
^^^^^^^^^^

* Deprecated the :class:`.PropertyOwner` metaclass - property initialisation
  now occurs at the instance level within :meth:`.HasProperties.__new__`.


Paul McCarthy's avatar
Paul McCarthy committed
154
155
1.6.0 (Thursday May 3rd 2018)
-----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
156
157
158
159
160
161
162
163
164
165


Changed
^^^^^^^


* Adjustment to the :mod:`.widgets_choice` module needed due to changes
  in the :class:`.BitmapRadioBox` API.


Paul McCarthy's avatar
Paul McCarthy committed
166
167
1.5.1 (Wednesday March 7th 2018)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
168
169
170
171
172
173
174
175
176


Changed
^^^^^^^


* Adjustments to the ``conda`` package build and deployment process.


Paul McCarthy's avatar
Paul McCarthy committed
177
178
1.5.0 (Tuesday February 27th 2018)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
179
180
181
182
183


* A new class, the :class:`.PropCache`, has been added. This class will
  automatically cache property values based on changes to other property
  values.
Paul McCarthy's avatar
Paul McCarthy committed
184
185
* Small adjustments to layout of :class:`.Group` classes in the :mod:`.build`
  module.
Paul McCarthy's avatar
Paul McCarthy committed
186
187


Paul McCarthy's avatar
Paul McCarthy committed
188
1.4.0 (Monday January 8th 2018)
Paul McCarthy's avatar
Paul McCarthy committed
189
-------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
190
191
192
193


* The :class:`.ColourMap` widget no longer complains when its property is
  set to a colour map that is registered with ``matplotlib``, but not with
Paul McCarthy's avatar
Paul McCarthy committed
194
195
196
197
  the property. The error message when an unknown colour map is specified
  has also been improved.
* The :func:`.cli._Choice` function allows additional arguments to be
  passed through to the ``ArgumentParser.add_argument`` method.
Paul McCarthy's avatar
Paul McCarthy committed
198
199


Paul McCarthy's avatar
Paul McCarthy committed
200
1.3.1 (Wednesday January 3rd 2018)
Paul McCarthy's avatar
Paul McCarthy committed
201
202
203
204
205
206
207
208
----------------------------------


* Fixed issue in :mod:`.syncable` where sync property change listeners were
  not being called after calls to :meth:`.syncToParent` or
  :meth:`.unsyncFromParent`.


Paul McCarthy's avatar
Paul McCarthy committed
209
1.3.0 (Wednesday January 3rd 2018)
Paul McCarthy's avatar
Paul McCarthy committed
210
211
212
213
214
215
216
217
218
----------------------------------


* The :class:`SyncableHasProperties` raises a custom error type, instead of a
  ``RuntimeError``, when an illegal attempt is made to synchronise or
  unsynchronise a property.


1.2.5 (Wednesday December 6th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
219
220
221
222
223
224
225
-----------------------------------


* Fixed a problem with the API documentation build failing again.
* Unit tests are now run against wxPython 3.0.2.0.


Paul McCarthy's avatar
Paul McCarthy committed
226
227
1.2.4 (Thursday November 9th 2017)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
228
229
230
231
232
233


* Fixed use of deprecated ``fsl.utils.async`` module from the ``fslpy``
  library.


Paul McCarthy's avatar
Paul McCarthy committed
234
235
236
1.2.3 (Thursday October 26th 2017)
-----------------------------------

Paul McCarthy's avatar
Paul McCarthy committed
237

Paul McCarthy's avatar
Paul McCarthy committed
238
239
* Fixed a problem with the API documentation build failing.

Paul McCarthy's avatar
Paul McCarthy committed
240

Paul McCarthy's avatar
Paul McCarthy committed
241
242
1.2.2 (Saturday October 21st 2017)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
243
244


Paul McCarthy's avatar
Paul McCarthy committed
245
246
247
* :mod:`.cli` custom transform functions can now raise a :exc:`.SkipArgument`
  exception to indicate that the argument shouid be skipped, either when
  applying or generating arguments.
Paul McCarthy's avatar
Paul McCarthy committed
248
249
250
251
252
253


1.2.1 (Thursday September 21st 2017)
------------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
254
255
256
* :func:`.cli.generateArguments` function wraps string values in quotes.
* :func:`.cli.generateArguments` allows extra arguments to be passed through
  to custom transform functions.
Paul McCarthy's avatar
Paul McCarthy committed
257
258
259
260
261
262


1.2.0 (Monday September 11th 2017)
----------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
263
264
* Deprecated ``get``/``setConstraint`` in favour of ``get``/``setAttribute``,
  on :class:`.HasProperties` and :class:`.PropertyBase` classes.
Paul McCarthy's avatar
Paul McCarthy committed
265
266
267
268
269
270


1.1.2 (Friday August 25th 2017)
-------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
271
* Even more adjustement to :class:`.PropertyValueList` item notification/
Paul McCarthy's avatar
Paul McCarthy committed
272
273
274
275
276
277
278
  synchronisation.


1.1.1 (Thursday August 24th 2017)
---------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
279
* Further adjustement to :class:`.PropertyValueList` item notification/
Paul McCarthy's avatar
Paul McCarthy committed
280
281
282
283
284
285
286
  synchronisation.


1.1.0 (Wednesday August 23rd 2017)
----------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
287
* :meth:`.HasProperties.__init__` now accepts ``kwargs`` which allow initial
Paul McCarthy's avatar
Paul McCarthy committed
288
  property values to be set.
Paul McCarthy's avatar
Paul McCarthy committed
289
290
291
292
293
* :class:`.SyncableHasProperties` has new/renamed methods ``detachFromParent``
  and ``detachAllFromParent``, allowing individual properties to be
  permanently un-synchronised.
* Bugfix to :class:`.PropertyValueList.getLast`
* :func:`.suppress.skip` function has option to ignore non-existent/deleted
Paul McCarthy's avatar
Paul McCarthy committed
294
  listeners.
Paul McCarthy's avatar
Paul McCarthy committed
295
* Fix to :class:`.PropertyValueList` item notification.
Paul McCarthy's avatar
Paul McCarthy committed
296
297
298
299
300
301
302



1.0.4 (Thursday August 10th 2017)
---------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
303
304
* New function :func:`.makeListWidget`, which creates a widget for a specific
  item in a property value list.
Paul McCarthy's avatar
Paul McCarthy committed
305
306
307
308
309
310


1.0.3 (Friday July 14th 2017)
-----------------------------


Paul McCarthy's avatar
Paul McCarthy committed
311
312
* Bug fix to :mod:`fsleyes_props.bindable` - could potentially pass GC'd
  functions to the :mod:`.callqueue`.
Paul McCarthy's avatar
Paul McCarthy committed
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
* Tweaks to CI build process


1.0.2 (Thursday June 8th 2017)
------------------------------


* Added CI build script
* Fixed some unit tests.


1.0.1 (Sunday June 4th 2017)
----------------------------


* Adjustments to pypi package metadata.


1.0.0 (Saturday May 27th 2017)
------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
335
* ``props`` renamed to :mod:`fsleyes_props`
Paul McCarthy's avatar
Paul McCarthy committed
336
* ``pwidgets`` removed (moved to separate project ``fsleyes-widgets``)
Paul McCarthy's avatar
Paul McCarthy committed
337
338
339
340
341
* Removed :class:`.WeakFunctionRef` - this is now defined in the ``fslpy``
  project.
* Removed :class:`.Bounds` centering logic
* Adjusted :class:`.CallQueue` interface to allow arbitrary arguments to be
  passed through to queued functions.
Paul McCarthy's avatar
Paul McCarthy committed
342
343
344
345
346
347
348


0.10.1 (Thursday April 20th 2017)
---------------------------------


* First public release as part of FSL 5.0.10