Skip to content

Commit 3f53d5c

Browse files
authored
Merge branch 'master' into fix-rfsg-examples-default-value
2 parents 7db9c46 + b5ffa43 commit 3f53d5c

File tree

24 files changed

+188
-235
lines changed

24 files changed

+188
-235
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1692,6 +1692,7 @@
16921692
- Added
16931693
- Changed
16941694
- Fix default value for option string in examples to be empty and make resource name as required input
1695+
- Fixed the return type of `get_all_script_names` and `get_all_named_waveform_names` to remove the size parameter and return a list of strings instead of a comma-separated string
16951696
- Removed
16961697

16971698
#### [nirfsg] 1.0.0 - 2025-08-05

build/helper/codegen_helper.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ def get_ctype_variable_declaration_snippet(parameter, parameters, ivi_dance_step
257257
module_name = '_visatype'
258258

259259
# Use _complextype.py file for complex parameter
260-
if parameter['complex_type'] is not None:
260+
if parameter.get('complex_array_representation') is not None:
261261
module_name = '_complextype'
262262

263263
if parameter['is_string'] is True:
@@ -368,7 +368,7 @@ def _get_ctype_variable_definition_snippet_for_scalar(parameter, parameters, ivi
368368
# Parameter denotes the size of another (the "corresponding") parameter.
369369
# Interleaved array length is going to be double the length of number of samples.
370370
# This is used for complex waveforms, where the real and imaginary parts are interleaved in the array.
371-
if corresponding_buffer_parameters[0]['complex_type'] == 'interleaved':
371+
if corresponding_buffer_parameters[0].get('complex_array_representation') == 'interleaved_real_number_array':
372372
definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}) // 2) # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
373373
else:
374374
definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2})) # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
@@ -435,7 +435,7 @@ def _get_ctype_variable_definition_snippet_for_buffers(parameter, parameters, iv
435435
definition = None
436436

437437
if parameter['numpy'] is True and use_numpy_array is True:
438-
if parameter['complex_type'] is None:
438+
if parameter.get('complex_array_representation') is None:
439439
definition = '_get_ctypes_pointer_for_buffer(value={}) # case B510'.format(parameter['python_name'])
440440
else:
441441
definition = '_get_ctypes_pointer_for_buffer(value={}, library_type={}.{}) # case B510'.format(parameter['python_name'], module_name, parameter['ctypes_type'])

build/helper/metadata_add_all.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -126,16 +126,16 @@ def _add_ctypes_type(parameter, config):
126126
parameter['ctypes_type_library_call'] = module_name + parameter['ctypes_type']
127127

128128

129-
def _add_complex_type(parameter):
130-
'''Adds a complex_type parameter to the metadata for complex numbers'''
131-
if 'complex_type' not in parameter:
132-
parameter['complex_type'] = None
129+
def _add_complex_array_representation(parameter):
130+
'''Adds a complex_array_representation parameter to the metadata for complex numbers'''
131+
if 'complex_array_representation' not in parameter:
132+
parameter['complex_array_representation'] = None
133133

134134

135-
def _add_array_dimension(parameter):
136-
'''Adds a array_dimension parameter to the metadata for multi dimensional arrays'''
137-
if 'array_dimension' not in parameter:
138-
parameter['array_dimension'] = 1
135+
def _add_array_dimensions(parameter):
136+
'''Adds a array_dimensions parameter to the metadata for multi dimensional arrays'''
137+
if 'array_dimensions' not in parameter:
138+
parameter['array_dimensions'] = 1
139139

140140

141141
def _add_numpy_info(parameter, parameters, config):
@@ -462,8 +462,8 @@ def add_all_function_metadata(functions, config):
462462
_add_python_type(p, config)
463463
_add_ctypes_variable_name(p)
464464
_add_ctypes_type(p, config)
465-
_add_complex_type(p)
466-
_add_array_dimension(p)
465+
_add_complex_array_representation(p)
466+
_add_array_dimensions(p)
467467
_add_numpy_info(p, functions[f]['parameters'], config)
468468
_add_default_value_name(p)
469469
_add_default_value_name_for_docs(p, config['module_name'])

build/helper/metadata_filters.py

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'skip_all_except_numpy_parameters': False,
2020
'mechanism': 'fixed, passed-in, len',
2121
'python_api_list': True,
22-
'skip_all_except_complex_type_parameters': False,
22+
'skip_all_except_complex_array_representation_parameters': False,
2323
},
2424
ParameterUsageOptions.SESSION_METHOD_PASSTHROUGH_CALL: {
2525
'skip_session_handle': True,
@@ -34,7 +34,7 @@
3434
'skip_all_except_numpy_parameters': False,
3535
'mechanism': 'fixed, passed-in, len',
3636
'python_api_list': True,
37-
'skip_all_except_complex_type_parameters': False,
37+
'skip_all_except_complex_array_representation_parameters': False,
3838
},
3939
ParameterUsageOptions.SESSION_NUMPY_INTO_METHOD_DECLARATION: {
4040
'skip_session_handle': True,
@@ -49,7 +49,7 @@
4949
'skip_all_except_numpy_parameters': False,
5050
'mechanism': 'fixed, passed-in',
5151
'python_api_list': False,
52-
'skip_all_except_complex_type_parameters': False,
52+
'skip_all_except_complex_array_representation_parameters': False,
5353
},
5454
ParameterUsageOptions.INTERPRETER_NUMPY_INTO_METHOD_DECLARATION: {
5555
'skip_session_handle': True,
@@ -64,7 +64,7 @@
6464
'skip_all_except_numpy_parameters': False,
6565
'mechanism': 'fixed, passed-in',
6666
'python_api_list': False,
67-
'skip_all_except_complex_type_parameters': False,
67+
'skip_all_except_complex_array_representation_parameters': False,
6868
},
6969
ParameterUsageOptions.SESSION_METHOD_CALL: {
7070
'skip_session_handle': True,
@@ -79,7 +79,7 @@
7979
'skip_all_except_numpy_parameters': False,
8080
'mechanism': 'fixed, passed-in',
8181
'python_api_list': True,
82-
'skip_all_except_complex_type_parameters': False,
82+
'skip_all_except_complex_array_representation_parameters': False,
8383
},
8484
ParameterUsageOptions.DOCUMENTATION_SESSION_METHOD: {
8585
'skip_session_handle': True,
@@ -94,7 +94,7 @@
9494
'skip_all_except_numpy_parameters': False,
9595
'mechanism': 'any',
9696
'python_api_list': True,
97-
'skip_all_except_complex_type_parameters': False,
97+
'skip_all_except_complex_array_representation_parameters': False,
9898
},
9999
ParameterUsageOptions.LIBRARY_METHOD_DECLARATION: {
100100
'skip_session_handle': False,
@@ -109,7 +109,7 @@
109109
'skip_all_except_numpy_parameters': False,
110110
'mechanism': 'any',
111111
'python_api_list': True,
112-
'skip_all_except_complex_type_parameters': False,
112+
'skip_all_except_complex_array_representation_parameters': False,
113113
},
114114
ParameterUsageOptions.LIBRARY_METHOD_CALL: {
115115
'skip_session_handle': False,
@@ -124,7 +124,7 @@
124124
'skip_all_except_numpy_parameters': False,
125125
'mechanism': 'any',
126126
'python_api_list': True,
127-
'skip_all_except_complex_type_parameters': False,
127+
'skip_all_except_complex_array_representation_parameters': False,
128128
},
129129
ParameterUsageOptions.GRPC_REQUEST_PARAMETERS: {
130130
'skip_session_handle': False,
@@ -139,7 +139,7 @@
139139
'skip_all_except_numpy_parameters': False,
140140
'mechanism': 'any',
141141
'python_api_list': True,
142-
'skip_all_except_complex_type_parameters': False,
142+
'skip_all_except_complex_array_representation_parameters': False,
143143
},
144144
ParameterUsageOptions.CTYPES_ARGTYPES: {
145145
'skip_session_handle': False,
@@ -154,7 +154,7 @@
154154
'skip_all_except_numpy_parameters': False,
155155
'mechanism': 'any',
156156
'python_api_list': True,
157-
'skip_all_except_complex_type_parameters': False,
157+
'skip_all_except_complex_array_representation_parameters': False,
158158
},
159159
ParameterUsageOptions.INTERPRETER_METHOD_DECLARATION: {
160160
'skip_session_handle': True,
@@ -169,7 +169,7 @@
169169
'skip_all_except_numpy_parameters': False,
170170
'mechanism': 'fixed, passed-in, len',
171171
'python_api_list': True,
172-
'skip_all_except_complex_type_parameters': False,
172+
'skip_all_except_complex_array_representation_parameters': False,
173173
},
174174
ParameterUsageOptions.INPUT_PARAMETERS: {
175175
'skip_session_handle': True,
@@ -184,7 +184,7 @@
184184
'skip_all_except_numpy_parameters': False,
185185
'mechanism': 'any',
186186
'python_api_list': True,
187-
'skip_all_except_complex_type_parameters': False,
187+
'skip_all_except_complex_array_representation_parameters': False,
188188
},
189189
ParameterUsageOptions.LIBRARY_OUTPUT_PARAMETERS: {
190190
'skip_session_handle': True,
@@ -199,7 +199,7 @@
199199
'skip_all_except_numpy_parameters': False,
200200
'mechanism': 'any',
201201
'python_api_list': True,
202-
'skip_all_except_complex_type_parameters': False,
202+
'skip_all_except_complex_array_representation_parameters': False,
203203
},
204204
ParameterUsageOptions.API_OUTPUT_PARAMETERS: {
205205
'skip_session_handle': True,
@@ -214,7 +214,7 @@
214214
'skip_all_except_numpy_parameters': False,
215215
'mechanism': 'any',
216216
'python_api_list': False,
217-
'skip_all_except_complex_type_parameters': False,
217+
'skip_all_except_complex_array_representation_parameters': False,
218218
},
219219
ParameterUsageOptions.API_NUMPY_OUTPUT_PARAMETERS: {
220220
'skip_session_handle': True,
@@ -229,7 +229,7 @@
229229
'skip_all_except_numpy_parameters': False,
230230
'mechanism': 'any',
231231
'python_api_list': False,
232-
'skip_all_except_complex_type_parameters': False,
232+
'skip_all_except_complex_array_representation_parameters': False,
233233
},
234234
ParameterUsageOptions.GRPC_OUTPUT_PARAMETERS: {
235235
'skip_session_handle': True,
@@ -244,7 +244,7 @@
244244
'skip_all_except_numpy_parameters': False,
245245
'mechanism': 'any',
246246
'python_api_list': False,
247-
'skip_all_except_complex_type_parameters': False,
247+
'skip_all_except_complex_array_representation_parameters': False,
248248
},
249249
ParameterUsageOptions.NUMPY_PARAMETERS: {
250250
'skip_session_handle': True,
@@ -259,7 +259,7 @@
259259
'skip_all_except_numpy_parameters': True,
260260
'mechanism': 'any',
261261
'python_api_list': True,
262-
'skip_all_except_complex_type_parameters': False,
262+
'skip_all_except_complex_array_representation_parameters': False,
263263
},
264264
ParameterUsageOptions.IVI_DANCE_PARAMETER: {
265265
'skip_session_handle': True,
@@ -274,7 +274,7 @@
274274
'skip_all_except_numpy_parameters': False,
275275
'mechanism': 'ivi-dance, ivi-dance-with-a-twist',
276276
'python_api_list': True,
277-
'skip_all_except_complex_type_parameters': False,
277+
'skip_all_except_complex_array_representation_parameters': False,
278278
},
279279
ParameterUsageOptions.LEN_PARAMETER: {
280280
'skip_session_handle': True,
@@ -289,7 +289,7 @@
289289
'skip_all_except_numpy_parameters': False,
290290
'mechanism': 'len',
291291
'python_api_list': True,
292-
'skip_all_except_complex_type_parameters': False,
292+
'skip_all_except_complex_array_representation_parameters': False,
293293
},
294294
ParameterUsageOptions.INPUT_ENUM_PARAMETERS: {
295295
'skip_session_handle': True,
@@ -304,7 +304,7 @@
304304
'skip_all_except_numpy_parameters': False,
305305
'mechanism': 'any',
306306
'python_api_list': True,
307-
'skip_all_except_complex_type_parameters': False,
307+
'skip_all_except_complex_array_representation_parameters': False,
308308
},
309309
ParameterUsageOptions.COMPLEX_NUMBER_PARAMETERS: {
310310
'skip_session_handle': True,
@@ -319,7 +319,7 @@
319319
'skip_all_except_numpy_parameters': False,
320320
'mechanism': 'any',
321321
'python_api_list': True,
322-
'skip_all_except_complex_type_parameters': True,
322+
'skip_all_except_complex_array_representation_parameters': True,
323323
},
324324
}
325325

@@ -384,7 +384,7 @@ def filter_parameters(parameters, parameter_usage_options):
384384
skip = False
385385
if not options_to_use['python_api_list'] and not x['use_in_python_api']:
386386
skip = True
387-
if options_to_use['skip_all_except_complex_type_parameters'] and x['complex_type'] is None:
387+
if options_to_use['skip_all_except_complex_array_representation_parameters'] and x['complex_array_representation'] is None:
388388
skip = True
389389
if not skip:
390390
parameters_to_use.append(x)

build/templates/enums.py.mako

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ config = template_parameters['metadata'].config
66
enums = config['enums']
77
%>
88
from enum import Enum
9-
% if any(enums[e].get('enum_class', 'Enum') == 'IntFlag' for e in enums):
9+
% if any(enums[e].get('class', 'Enum') == 'IntFlag' for e in enums):
1010
from enum import IntFlag
1111
% endif
1212
% for enum_name in sorted(helper.filter_codegen_enums(enums)):
1313

1414

15-
class ${enums[enum_name]['python_name']}(${enums[enum_name].get('enum_class', 'Enum')}):
15+
class ${enums[enum_name]['python_name']}(${enums[enum_name].get('class', 'Enum')}):
1616
<%
1717
print_list = []
1818
%>\

build/templates/session.py/numpy_write_method.py.mako

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
raise TypeError('${parameter['python_name']} must be in C-order')
3131
if ${parameter['python_name']}.dtype is not numpy.dtype('${parameter['numpy_type']}'):
3232
raise TypeError('${parameter['python_name']} must be numpy.ndarray of dtype=${parameter['numpy_type']}, is ' + str(${parameter['python_name']}.dtype))
33-
if ${parameter['python_name']}.ndim != ${parameter['array_dimension']}:
34-
raise TypeError('${parameter['python_name']} must be numpy.ndarray of dimension=${parameter['array_dimension']}, is ' + str(${parameter['python_name']}.ndim))
33+
if ${parameter['python_name']}.ndim != ${parameter['array_dimensions']}:
34+
raise TypeError('${parameter['python_name']} must be numpy.ndarray of dimension=${parameter['array_dimensions']}, is ' + str(${parameter['python_name']}.ndim))
3535
% endfor
3636
% for p in helper.filter_parameters(parameters, helper.ParameterUsageOptions.INTERPRETER_METHOD_CALL):
3737
% if 'python_api_converter_name' in p:

0 commit comments

Comments
 (0)