@@ -25,6 +25,89 @@ Eric Larson (EL), Demian Wassermann, Stephan Gerhard and Ross Markello (RM).
25
25
26
26
References like "pr/298" refer to github pull request numbers.
27
27
28
+ 5.0.0 (Monday 9 January 2023)
29
+ =============================
30
+
31
+ New feature release in the 5.0.x series.
32
+
33
+ New features
34
+ ------------
35
+ * :class: `~nibabel.filebasedimages.SerializableImage ` now has
36
+ :meth: `~nibabel.filebasedimages.SerializableImage.to_stream() ` and
37
+ :meth: `~nibabel.filebasedimages.SerializableImage.from_stream() ` methods to
38
+ read/write streams implementing the :class: `~io.IOBase ` interface. A
39
+ :meth: `~nibabel.filebasedimages.SerializableImage.from_url() ` method
40
+ enables loading images from URLs. (pr/1129) (CM, reviewed by MB)
41
+ * :class: `~nibabel.streamlines.trk.TrkFile ` supports TRKv3, an
42
+ undocumented but generally compatible variant of TRKv2. (pr/1125) (CM)
43
+
44
+ Enhancements
45
+ ------------
46
+ * Support multiline header fields in :class: `~nibabel.streamlines.tck.TCKFile `
47
+ (pr/1175) (CM, reviewed by Matt Cieslak)
48
+ * Make layout order an initialization parameter of
49
+ :class: `~nibabel.arrayproxy.ArrayProxy ` (pr/1131) (CM, reviewed by MB)
50
+ * Initial support for type annotations. (pr/1115, pr/1178) (CM, reviewed by
51
+ Zvi Baratz)
52
+
53
+ Bug fixes
54
+ ---------
55
+ * Handle extension/file-format mismatches implemented incompletely in pr/1013
56
+ (pr/1138) (CM, reviewed by Thomas Phil)
57
+ * Improve handling of invalid TCK files, which could sometimes cause an
58
+ infinite loop (pr/1140) (Anibal Solon, reviewed by CM)
59
+ * Clean up ECAT test case that left filehandle open and failed to use class
60
+ variables (pr/1155) (Dimitri Papadopoulos, reviewed by CM)
61
+
62
+ Maintenance
63
+ -----------
64
+ * Simplify TCK reading code by assuming files are open in binary mode
65
+ (pr/1142) (Anibal Solon, reviewed by MC, CM)
66
+ * Code support for tests covering deprecated functionality (pr/1159) (CM)
67
+ * Miscellaneous code cleanups (pr/1148, pr/1149, pr/1153, pr/1154, pr/1156)
68
+ (Dimitri Papadopoulos, reviewed by CM)
69
+ * Update CI to build, test and deploy PyPI artifacts (pr/1134) (CM, reviewed
70
+ by MB)
71
+ * Transition from ``setup.cfg `` to ``pyproject.toml `` package configuration
72
+ (pr/1133) (CM, reviewed by MB)
73
+ * Addressed race conditions preventing running tests with pytest-xdist _.
74
+ (pr/1157, pr/1158) (CM, reviewed by Christian Haselgrove)
75
+ * Apply blue _ and isort _ auto-formatters and provide pre-commit _ configuration
76
+ to reduce human burden of style guidelines. (pr/1124, pr/1165, pr/1169)
77
+ (CM and Zvi Baratz)
78
+ * Manage versioning with setuptools_scm _ (pr/1171) (CM, reviewed by Zvi Baratz)
79
+ * Reduce installed package size by excluding very large test file (pr/1176)
80
+ (CM, reviewed by Zvi Baratz)
81
+
82
+ API changes and deprecations
83
+ ----------------------------
84
+ * Passing an ``int64 `` array to :class: `~nibabel.nifti1.Nifti1Image ` without a
85
+ header or dtype argument will raise a ``ValueError ``. (pr/1173) (CM)
86
+ * :class: `nibabel.tmpdirs.TemporaryDirectory ` is deprecated in favor of
87
+ :class: `tempfile.TemporaryDirectory `. (pr/1172) (CM, reviewed by Zvi
88
+ Baratz)
89
+ * The ``nisext `` package is deprecated and will be removed in NiBabel 6.0.
90
+ (pr/1170) (CM, reviewed by MB)
91
+ * Drop support for Python 3.7, Numpy < 1.19 (pr/1177) (CM)
92
+ * The following deprecated functions and methods will now raise
93
+ ``ExpiredDeprecationError ``\s
94
+
95
+ * :func: `nibabel.loadsave.read_img_data `
96
+ * :meth: `nibabel.dataobj_images.DataobjImage.get_data `
97
+ * :func: `nibabel.loadsave.guessed_image_type `
98
+ * :func: `nibabel.onetime.setattr_on_read `
99
+ * :func: `nibabel.orientations.flip_axis `
100
+
101
+ * Modules, classes and functions that expired at 4.0 were fully removed.
102
+ ``ExpiredDeprecationError ``\s will now be ``AttributeError ``\s .
103
+
104
+ .. _blue : https://blue.readthedocs.io
105
+ .. _isort : https://pycqa.github.io/isort/
106
+ .. _pre-commit : https://pre-commit.com/
107
+ .. _pytest-xdist : https://pytest-xdist.readthedocs.io
108
+ .. _setuptools_scm : https://github.com/pypa/setuptools_scm
109
+
110
+
28
111
4.0.2 (Wednesday 31 August 2022)
29
112
================================
30
113
0 commit comments