Add load_settings_toml #949
Conversation
| # | ||
| # SPDX-License-Identifier: MIT | ||
| [pytest] | ||
| pythonpath = src |
There was a problem hiding this comment.
needed so pytest knew where the files were. I see there are other tests, but that CI doesn't tun them
| @@ -99,6 +99,7 @@ | |||
| "pyftdi>=0.40.0", | |||
| "adafruit-circuitpython-typing", | |||
| "sysv_ipc>=1.1.0;sys_platform=='linux' and platform_machine!='mips'", | |||
| "toml>=0.10.2;python_version<'3.11'", | |||
There was a problem hiding this comment.
tomllib added in 3.11
| def load_settings_toml(*, return_toml=False): | ||
| """Load values from settings.toml into os.environ, so that os.getenv returns them.""" | ||
| if not os.path.isfile("settings.toml"): | ||
| raise FileNotFoundError("settings.toml not cound in current directory.") |
| try: | ||
| settings = tomllib.load(toml_file) | ||
| except tomllib.TOMLDecodeError as e: | ||
| raise tomllib.TOMLDecodeError("Error with settings.toml file.") from e |
| invalid_types.add(type(value).__name__) | ||
| if invalid_types: | ||
| invalid_types_string = ", ".join(invalid_types) | ||
| raise ValueError( |
|
|
||
| invalid_types = set() | ||
| for key, value in settings.items(): | ||
| if not isinstance(value, (bool, int, float, str)): |
There was a problem hiding this comment.
these all get converted into strings (as they would be in the environment)
src/adafruit_blinka/__init__.py
Outdated
| os.environ[key] = str(value) | ||
| print(f" - {key} added") | ||
|
|
||
| if return_toml: |
There was a problem hiding this comment.
Added for testing, but could also be helpful, it's like getting secrets back
There was a problem hiding this comment.
I think it's okay to just return settings all the time instead of make it conditional with an argument. In the majority of cases people will have copied code that just calls the function and ignores the result.
There was a problem hiding this comment.
I agree, no reason to control whether or not to return, removes an arg, and reduces code size. settings will get gc'd the same way regardless of whether or not it is returned, if the caller does not assign it to anything.
There was a problem hiding this comment.
Fixed here: 046217c
src/adafruit_blinka/__init__.py
Outdated
| os.environ[key] = str(value) | ||
| print(f" - {key} added") | ||
|
|
||
| if return_toml: |
There was a problem hiding this comment.
I agree, no reason to control whether or not to return, removes an arg, and reduces code size. settings will get gc'd the same way regardless of whether or not it is returned, if the caller does not assign it to anything.
|
@FoamyGuy are you opening up another PR to change the minimum pay version? |
No description provided.