Skip to content

Refactor extraction-scripts to reduce code-duplication #2592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 25, 2025
Merged

Refactor extraction-scripts to reduce code-duplication #2592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 56 additions & 54 deletions tools/extract_build_defines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,17 @@ def __init__(self, message, errors):

BUILD_DEFINE_RE = re.compile(r'#\s+{}:\s+(\w+),\s+([^,]+)(?:,\s+(.*))?$'.format(BASE_BUILD_DEFINE_NAME))

ALLOWED_CONFIG_PROPERTIES = set(['type', 'default', 'min', 'max', 'group'])
PROPERTY_TYPE = 'type'
PROPERTY_DEFAULT = 'default'
PROPERTY_MIN = 'min'
PROPERTY_MAX = 'max'
PROPERTY_GROUP = 'group'
ALLOWED_CONFIG_PROPERTIES = set([PROPERTY_TYPE, PROPERTY_DEFAULT, PROPERTY_MIN, PROPERTY_MAX, PROPERTY_GROUP])

PROPERTY_TYPE_INT = 'int'
PROPERTY_TYPE_BOOL = 'bool'
PROPERTY_TYPE_STRING = 'string'
PROPERTY_TYPE_LIST = 'list'

CHIP_NAMES = ["rp2040", "rp2350"]

Expand All @@ -57,72 +67,64 @@ def __init__(self, message, errors):


def ValidateAttrs(config_name, config_attrs, file_path, linenum):
_type = config_attrs.get('type')
type_str = config_attrs.get(PROPERTY_TYPE)
errors = []

# Validate attrs
for key in config_attrs.keys():
if key not in ALLOWED_CONFIG_PROPERTIES:
errors.append(Exception('{} at {}:{} has unexpected property "{}"'.format(config_name, file_path, linenum, key)))

if _type == 'int':
_min = _max = _default = None
if config_attrs.get('min', None) is not None:
value = config_attrs['min']
m = re.match(r'^(\d+)e(\d+)$', value.lower())
if m:
_min = int(m.group(1)) * 10**int(m.group(2))
else:
_min = int(value, 0)
if config_attrs.get('max', None) is not None:
value = config_attrs['max']
m = re.match(r'^(\d+)e(\d+)$', value.lower())
if m:
_max = int(m.group(1)) * 10**int(m.group(2))
else:
_max = int(value, 0)
if config_attrs.get('default', None) is not None:
if '/' not in config_attrs['default']:
str_values = dict()
parsed_values = dict()
if type_str == PROPERTY_TYPE_INT:
for attr_name in (PROPERTY_MIN, PROPERTY_MAX, PROPERTY_DEFAULT):
str_values[attr_name] = config_attrs.get(attr_name, None)
if str_values[attr_name] is not None:
try:
value = config_attrs['default']
m = re.match(r'^(\d+)e(\d+)$', value.lower())
m = re.match(r'^(\d+)e(\d+)$', str_values[attr_name].lower())
if m:
_default = int(m.group(1)) * 10**int(m.group(2))
parsed_values[attr_name] = int(m.group(1)) * 10**int(m.group(2))
else:
_default = int(value, 0)
parsed_values[attr_name] = int(str_values[attr_name], 0)
except ValueError:
pass
if _min is not None and _max is not None:
if _min > _max:
errors.append(Exception('{} at {}:{} has min {} > max {}'.format(config_name, file_path, linenum, config_attrs['min'], config_attrs['max'])))
if _min is not None and _default is not None:
if _min > _default:
errors.append(Exception('{} at {}:{} has min {} > default {}'.format(config_name, file_path, linenum, config_attrs['min'], config_attrs['default'])))
if _default is not None and _max is not None:
if _default > _max:
errors.append(Exception('{} at {}:{} has default {} > max {}'.format(config_name, file_path, linenum, config_attrs['default'], config_attrs['max'])))
elif _type == 'bool':
assert 'min' not in config_attrs
assert 'max' not in config_attrs
_default = config_attrs.get('default', None)
if _default is not None:
if '/' not in _default:
if (_default not in ('0', '1')) and (_default not in all_config_names):
logger.info('{} at {}:{} has non-integer default value "{}"'.format(config_name, file_path, linenum, config_attrs['default']))

elif _type == 'string':
assert 'min' not in config_attrs
assert 'max' not in config_attrs
_default = config_attrs.get('default', None)
elif _type == 'list':
assert 'min' not in config_attrs
assert 'max' not in config_attrs
_default = config_attrs.get('default', None)
logger.info('{} at {}:{} has non-integer {} value "{}"'.format(config_name, file_path, linenum, attr_name, str_values[attr_name]))
for (small_attr, large_attr) in (
(PROPERTY_MIN, PROPERTY_MAX),
(PROPERTY_MIN, PROPERTY_DEFAULT),
(PROPERTY_DEFAULT, PROPERTY_MAX),
):
if small_attr in parsed_values and large_attr in parsed_values and parsed_values[small_attr] > parsed_values[large_attr]:
errors.append(Exception('{} at {}:{} has {} {} > {} {}'.format(config_name, file_path, linenum, small_attr, str_values[small_attr], large_attr, str_values[large_attr])))

elif type_str == PROPERTY_TYPE_BOOL:
assert PROPERTY_MIN not in config_attrs
assert PROPERTY_MAX not in config_attrs

attr_name = PROPERTY_DEFAULT
str_values[attr_name] = config_attrs.get(attr_name, None)
if str_values[attr_name] is not None:
if (str_values[attr_name] not in ('0', '1')) and (str_values[attr_name] not in all_config_names):
logger.info('{} at {}:{} has non-integer {} value "{}"'.format(config_name, file_path, linenum, attr_name, str_values[attr_name]))

elif type_str == PROPERTY_TYPE_STRING:
assert PROPERTY_MIN not in config_attrs
assert PROPERTY_MAX not in config_attrs

attr_name = PROPERTY_DEFAULT
str_values[attr_name] = config_attrs.get(attr_name, None)

elif type_str == PROPERTY_TYPE_LIST:
assert PROPERTY_MIN not in config_attrs
assert PROPERTY_MAX not in config_attrs

attr_name = PROPERTY_DEFAULT
str_values[attr_name] = config_attrs.get(attr_name, None)

else:
errors.append(Exception("Found unknown {} type {} at {}:{}".format(BASE_BUILD_DEFINE_NAME, _type, file_path, linenum)))

return errors
errors.append(Exception("Found unknown {} type {} at {}:{}".format(BASE_BUILD_DEFINE_NAME, type_str, file_path, linenum)))

return errors

errors = []

Expand Down
112 changes: 59 additions & 53 deletions tools/extract_cmake_configs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#
# Script to scan the Raspberry Pi Pico SDK tree searching for CMake configuration items
# Outputs a tab separated file of the configuration item:
# name location platform chip description type advanced default docref group
# name location platform chip description type advanced default docref group max
#
# Usage:
#
Expand Down Expand Up @@ -46,7 +46,19 @@ def __init__(self, message, errors):

CMAKE_CONFIG_RE = re.compile(r'#\s+{}:\s+(\w+),\s+([^,]+)(?:,\s+(.*))?$'.format(BASE_CMAKE_CONFIG_NAME))

ALLOWED_CONFIG_PROPERTIES = set(['type', 'default', 'min', 'max', 'group', 'advanced', 'docref'])
PROPERTY_TYPE = 'type'
PROPERTY_DEFAULT = 'default'
PROPERTY_MIN = 'min'
PROPERTY_MAX = 'max'
PROPERTY_GROUP = 'group'
PROPERTY_ADVANCED = 'advanced'
PROPERTY_DOCREF = 'docref'
ALLOWED_CONFIG_PROPERTIES = set([PROPERTY_TYPE, PROPERTY_DEFAULT, PROPERTY_MIN, PROPERTY_MAX, PROPERTY_GROUP, PROPERTY_ADVANCED, PROPERTY_DOCREF])

PROPERTY_TYPE_INT = 'int'
PROPERTY_TYPE_BOOL = 'bool'
PROPERTY_TYPE_STRING = 'string'
PROPERTY_TYPE_LIST = 'list'

CHIP_NAMES = ["rp2040", "rp2350"]

Expand All @@ -57,69 +69,63 @@ def __init__(self, message, errors):


def ValidateAttrs(config_name, config_attrs, file_path, linenum):
_type = config_attrs.get('type')
type_str = config_attrs.get(PROPERTY_TYPE)
errors = []

# Validate attrs
for key in config_attrs.keys():
if key not in ALLOWED_CONFIG_PROPERTIES:
errors.append(Exception('{} at {}:{} has unexpected property "{}"'.format(config_name, file_path, linenum, key)))

if _type == 'int':
_min = _max = _default = None
if config_attrs.get('min', None) is not None:
value = config_attrs['min']
m = re.match(r'^(\d+)e(\d+)$', value.lower())
if m:
_min = int(m.group(1)) * 10**int(m.group(2))
else:
_min = int(value, 0)
if config_attrs.get('max', None) is not None:
value = config_attrs['max']
m = re.match(r'^(\d+)e(\d+)$', value.lower())
if m:
_max = int(m.group(1)) * 10**int(m.group(2))
else:
_max = int(value, 0)
if config_attrs.get('default', None) is not None:
if '/' not in config_attrs['default']:
str_values = dict()
parsed_values = dict()
if type_str == PROPERTY_TYPE_INT:
for attr_name in (PROPERTY_MIN, PROPERTY_MAX, PROPERTY_DEFAULT):
str_values[attr_name] = config_attrs.get(attr_name, None)
if str_values[attr_name] is not None:
try:
value = config_attrs['default']
m = re.match(r'^(\d+)e(\d+)$', value.lower())
m = re.match(r'^(\d+)e(\d+)$', str_values[attr_name].lower())
if m:
_default = int(m.group(1)) * 10**int(m.group(2))
parsed_values[attr_name] = int(m.group(1)) * 10**int(m.group(2))
else:
_default = int(value, 0)
parsed_values[attr_name] = int(str_values[attr_name], 0)
except ValueError:
pass
if _min is not None and _max is not None:
if _min > _max:
errors.append(Exception('{} at {}:{} has min {} > max {}'.format(config_name, file_path, linenum, config_attrs['min'], config_attrs['max'])))
if _min is not None and _default is not None:
if _min > _default:
errors.append(Exception('{} at {}:{} has min {} > default {}'.format(config_name, file_path, linenum, config_attrs['min'], config_attrs['default'])))
if _default is not None and _max is not None:
if _default > _max:
errors.append(Exception('{} at {}:{} has default {} > max {}'.format(config_name, file_path, linenum, config_attrs['default'], config_attrs['max'])))
elif _type == 'bool':
assert 'min' not in config_attrs
assert 'max' not in config_attrs
_default = config_attrs.get('default', None)
if _default is not None:
if '/' not in _default:
if (_default not in ('0', '1')) and (_default not in all_config_names):
logger.info('{} at {}:{} has non-integer default value "{}"'.format(config_name, file_path, linenum, config_attrs['default']))

elif _type == 'string':
assert 'min' not in config_attrs
assert 'max' not in config_attrs
_default = config_attrs.get('default', None)
elif _type == 'list':
assert 'min' not in config_attrs
assert 'max' not in config_attrs
_default = config_attrs.get('default', None)
# pass
logger.info('{} at {}:{} has non-integer {} value "{}"'.format(config_name, file_path, linenum, attr_name, str_values[attr_name]))
for (small_attr, large_attr) in (
(PROPERTY_MIN, PROPERTY_MAX),
(PROPERTY_MIN, PROPERTY_DEFAULT),
(PROPERTY_DEFAULT, PROPERTY_MAX),
):
if small_attr in parsed_values and large_attr in parsed_values and parsed_values[small_attr] > parsed_values[large_attr]:
errors.append(Exception('{} at {}:{} has {} {} > {} {}'.format(config_name, file_path, linenum, small_attr, str_values[small_attr], large_attr, str_values[large_attr])))

elif type_str == PROPERTY_TYPE_BOOL:
assert PROPERTY_MIN not in config_attrs
assert PROPERTY_MAX not in config_attrs

attr_name = PROPERTY_DEFAULT
str_values[attr_name] = config_attrs.get(attr_name, None)
if str_values[attr_name] is not None:
if (str_values[attr_name] not in ('0', '1')) and (str_values[attr_name] not in all_config_names):
logger.info('{} at {}:{} has non-integer {} value "{}"'.format(config_name, file_path, linenum, attr_name, str_values[attr_name]))

elif type_str == PROPERTY_TYPE_STRING:
assert PROPERTY_MIN not in config_attrs
assert PROPERTY_MAX not in config_attrs

attr_name = PROPERTY_DEFAULT
str_values[attr_name] = config_attrs.get(attr_name, None)

elif type_str == PROPERTY_TYPE_LIST:
assert PROPERTY_MIN not in config_attrs
assert PROPERTY_MAX not in config_attrs

attr_name = PROPERTY_DEFAULT
str_values[attr_name] = config_attrs.get(attr_name, None)

else:
errors.append(Exception("Found unknown {} type {} at {}:{}".format(BASE_CMAKE_CONFIG_NAME, _type, file_path, linenum)))
errors.append(Exception("Found unknown {} type {} at {}:{}".format(BASE_CMAKE_CONFIG_NAME, type_str, file_path, linenum)))

return errors

Expand Down
Loading
Loading