Mercurial > hg > orthanc-python
annotate NEWS @ 180:ddf3e987827f java-code-model
created Python documentation for the Orthanc interface
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 02 Jul 2024 12:30:16 +0200 |
parents | a5162d8bd2d4 |
children | f34f3a149c22 |
rev | line source |
---|---|
160
a5162d8bd2d4
Added Windows builder for Python 3.12
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
158
diff
changeset
|
1 Pending changes in the mainline |
a5162d8bd2d4
Added Windows builder for Python 3.12
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
158
diff
changeset
|
2 =============================== |
a5162d8bd2d4
Added Windows builder for Python 3.12
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
158
diff
changeset
|
3 |
180
ddf3e987827f
created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
160
diff
changeset
|
4 * Created Python documentation for the Orthanc interface, check out "orthanc.pyi" |
160
a5162d8bd2d4
Added Windows builder for Python 3.12
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
158
diff
changeset
|
5 * Added Windows builder for Python 3.12 |
a5162d8bd2d4
Added Windows builder for Python 3.12
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
158
diff
changeset
|
6 |
a5162d8bd2d4
Added Windows builder for Python 3.12
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
158
diff
changeset
|
7 |
158 | 8 Version 4.2 (2024-05-16) |
9 ======================== | |
14 | 10 |
137
cc0765aae484
fix signature of orthanc.RestOutput.SendHttpStatus()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
135
diff
changeset
|
11 * Fix signature of "orthanc.RestOutput.SendHttpStatus()" |
152 | 12 * Added orthanc.RegisterMoveCallback2() that takes 4 callbacks like the |
13 original C SDK function. This allows you to implement a correct handling | |
14 of the C-Move sub-operations count in the GetMoveSize(). The ApplyMove() | |
15 must now handle a single sub-operation at a time. | |
16 The legacy orthanc.RegisterMoveCallback() always considers that there is a single | |
17 sub-operation and we have observed modalities complaining that the number of | |
18 sub-operations was not matching the number of instances sent. | |
137
cc0765aae484
fix signature of orthanc.RestOutput.SendHttpStatus()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
135
diff
changeset
|
19 |
135 | 20 |
21 Version 4.1 (2023-08-30) | |
22 ======================== | |
23 | |
24 * New function from the SDK wrapped in Python: | |
119
cf6decdf9e15
wrapped new SDK callback: orthanc.RegisterStorageCommitmentScpCallback()
Alain Mazy <am@osimis.io>
parents:
118
diff
changeset
|
25 - orthanc.RegisterStorageCommitmentScpCallback() |
124
35c0b2fc751c
added configuration section "Python" and option "DisplayMemoryUsage"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
26 * New configuration section "Python" to group settings related to the plugin: |
35c0b2fc751c
added configuration section "Python" and option "DisplayMemoryUsage"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
27 - "Python.Path" is an alias for global option "PythonScript" |
35c0b2fc751c
added configuration section "Python" and option "DisplayMemoryUsage"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
28 - "Python.Verbose" is an alias for global option "PythonVerbose" |
35c0b2fc751c
added configuration section "Python" and option "DisplayMemoryUsage"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
29 * New configuration option "Python.DisplayMemoryUsage" to periodically |
35c0b2fc751c
added configuration section "Python" and option "DisplayMemoryUsage"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
30 display memory allocations that stem from Python plugins |
35c0b2fc751c
added configuration section "Python" and option "DisplayMemoryUsage"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
31 |
131 | 32 Maintenance |
33 ----------- | |
34 | |
135 | 35 * Fix memory leaks when a python script calls orthanc.RestApiPost() and sibling |
36 methods, in IncomingHttpRequestFilter and in the CMove callback. | |
112
b3a18e333f93
integration 4.0->mainline
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
37 * New builders for Windows: Supporting 32 / 64bit with Python 3.9 / 3.10 / 3.11 |
b3a18e333f93
integration 4.0->mainline
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
109
diff
changeset
|
38 |
109 | 39 |
40 Version 4.0 (2022-02-23) | |
41 ======================== | |
42 | |
107
461dfb859ac7
upgrade to Orthanc SDK 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
101
diff
changeset
|
43 => Minimum SDK version: 1.10.0 <= |
461dfb859ac7
upgrade to Orthanc SDK 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
101
diff
changeset
|
44 |
461dfb859ac7
upgrade to Orthanc SDK 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
101
diff
changeset
|
45 * New functions from the SDK wrapped in Python: |
96
627b8a19fb9f
orthanc.RegisterIncomingCStoreInstanceFilter()
Alain Mazy <am@osimis.io>
parents:
93
diff
changeset
|
46 - orthanc.RegisterIncomingCStoreInstanceFilter() |
99
465bf098554b
new callback: orthanc.RegisterReceivedInstanceCallback()
Alain Mazy <am@osimis.io>
parents:
96
diff
changeset
|
47 - orthanc.RegisterReceivedInstanceCallback() |
93 | 48 |
101 | 49 |
93 | 50 Version 3.4 (2021-08-31) |
51 ======================== | |
52 | |
91
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
81
diff
changeset
|
53 * On Orthanc stopping, wait for all the queued events to have been processed |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
81
diff
changeset
|
54 * Docker-based builder scripts distinguishing Debian buster and bullseye |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
81
diff
changeset
|
55 |
81 | 56 |
57 Version 3.3 (2021-08-12) | |
58 ======================== | |
59 | |
79
068551520123
New Python function: "orthanc.RegisterStorageArea()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
77
diff
changeset
|
60 * New Python function: "orthanc.RegisterStorageArea()" |
77
e7ff5efb100d
Custom exception "orthanc.OrthancException" is raised instead of "ValueError"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
61 * Custom exception "orthanc.OrthancException" is raised instead of "ValueError" |
e7ff5efb100d
Custom exception "orthanc.OrthancException" is raised instead of "ValueError"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
62 |
71 | 63 |
64 Version 3.2 (2021-06-11) | |
65 ======================== | |
66 | |
63
32de70a1e4c7
New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
60
diff
changeset
|
67 * New functions from the SDK wrapped in Python: |
32de70a1e4c7
New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
60
diff
changeset
|
68 - orthanc.CreateDicom() |
65
4da5ce3468b4
new wrapped functions: CreateImageFromBuffer(), DicomInstance.GetInstanceData() and Image.GetImageBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
64
diff
changeset
|
69 - orthanc.CreateImageFromBuffer() |
4da5ce3468b4
new wrapped functions: CreateImageFromBuffer(), DicomInstance.GetInstanceData() and Image.GetImageBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
64
diff
changeset
|
70 - orthanc.DicomInstance.GetInstanceData() |
64
091fb1903bfc
new wrapped function: orthanc.RegisterWorklistCallback() and orthanc.WorklistAnswers.WorklistAddAnswer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
63
diff
changeset
|
71 - orthanc.FindQuery.GetFindQueryTagElement() |
091fb1903bfc
new wrapped function: orthanc.RegisterWorklistCallback() and orthanc.WorklistAnswers.WorklistAddAnswer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
63
diff
changeset
|
72 - orthanc.FindQuery.GetFindQueryTagGroup() |
65
4da5ce3468b4
new wrapped functions: CreateImageFromBuffer(), DicomInstance.GetInstanceData() and Image.GetImageBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
64
diff
changeset
|
73 - orthanc.Image.GetImageBuffer() |
66
6fc445793796
new wrapped function: orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
65
diff
changeset
|
74 - orthanc.LookupDictionary() |
63
32de70a1e4c7
New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
60
diff
changeset
|
75 - orthanc.RegisterFindCallback() |
32de70a1e4c7
New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
60
diff
changeset
|
76 - orthanc.RegisterMoveCallback() |
64
091fb1903bfc
new wrapped function: orthanc.RegisterWorklistCallback() and orthanc.WorklistAnswers.WorklistAddAnswer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
63
diff
changeset
|
77 - orthanc.RegisterWorklistCallback() |
091fb1903bfc
new wrapped function: orthanc.RegisterWorklistCallback() and orthanc.WorklistAnswers.WorklistAddAnswer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
63
diff
changeset
|
78 - orthanc.WorklistAnswers.WorklistAddAnswer() |
63
32de70a1e4c7
New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
60
diff
changeset
|
79 |
67 | 80 NB: SDK coverage is about 87% (138 functions wrapped in Python vs. 158 in SDK) |
81 | |
60 | 82 |
83 Version 3.1 (2021-01-22) | |
84 ======================== | |
85 | |
57
46fe70776d61
Fix possible deadlock with "orthanc.RegisterOnChangeCallback()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
54
diff
changeset
|
86 * Fix possible deadlock with "orthanc.RegisterOnChangeCallback()" |
58
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
87 * During Orthanc shutdown, wait for all the pending events to have been processed |
57
46fe70776d61
Fix possible deadlock with "orthanc.RegisterOnChangeCallback()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
54
diff
changeset
|
88 |
54 | 89 |
90 Version 3.0 (2020-12-09) | |
91 ======================== | |
92 | |
49
9e466631660a
ugrade to Orthanc SDK 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
47
diff
changeset
|
93 => Minimum SDK version: 1.8.1 <= |
9e466631660a
ugrade to Orthanc SDK 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
47
diff
changeset
|
94 |
50
70abe3ebbbfc
New Python function: "orthanc.RegisterIncomingHttpRequestFilter()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
49
diff
changeset
|
95 * New Python function: "orthanc.RegisterIncomingHttpRequestFilter()" |
47
42de8b600c0c
Support of Apple OS X
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
45
diff
changeset
|
96 * Support of Apple OS X |
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
43
diff
changeset
|
97 * Fix issue #185 (segfaults on non-UTF8 special characters in request URI) |
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
43
diff
changeset
|
98 |
43 | 99 |
100 Version 2.0 (2020-07-08) | |
101 ======================== | |
102 | |
41
393d2da0722a
upgrade to Orthanc SDK 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
103 => Minimum SDK version: 1.7.2 <= |
393d2da0722a
upgrade to Orthanc SDK 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
104 |
43 | 105 * Wrapped more functions |
22
04b8a44b2717
adding patch.exe command-line tool for MSVC
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
106 * Fix compilation using Visual Studio |
28
b2bbb516056e
The "Calling Python..." info logs are disabled if "PythonVerbose" is "false"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
107 * The "Calling Python..." info logs are disabled if "PythonVerbose" is "false" |
33
ce5b6116e6cd
New builders for Windows: Supporting 32 / 64bit with Python 2.7 / 3.7 / 3.8
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
28
diff
changeset
|
108 * New builders for Windows: Supporting 32 / 64bit with Python 2.7 / 3.7 / 3.8 |
36
fd58eb5749ed
CMake simplification using DownloadOrthancFramework.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
33
diff
changeset
|
109 * Support of dynamic linking against the system-wide Orthanc framework library |
22
04b8a44b2717
adding patch.exe command-line tool for MSVC
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
14
diff
changeset
|
110 |
67 | 111 NB: SDK coverage is about 75% (119 functions wrapped in Python vs. 157 in SDK) |
112 | |
14 | 113 |
114 Version 1.0 (2020-04-01) | |
115 ======================== | |
116 | |
41
393d2da0722a
upgrade to Orthanc SDK 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
117 => Minimum SDK version: 1.5.7 <= |
393d2da0722a
upgrade to Orthanc SDK 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
118 |
14 | 119 * Initial release |