This module is used to handle configuration files for FlexSensor. It has been designed, so the user can create a config with a UI, automatically connected to the signal and slots.
Install the requirements with pip:
pip install -r requirements.txtor
pip install PySide6 PyYAML richJust add the following line to your requirements.txt
git+https://github.com/agentsmith29/fstools.confighandler.git@<branch>
# e.g., from branch main
git+https://github.com/agentsmith29/fstools.confighandler.git@<branch>oder directly using pip (without requirements.txt)
# or manually
pip install git+https://github.com/agentsmith29/fstools.confighandler.git@<branch>Example files can be found in ./examples.
The usage is straight forward. Just create a new ConfigNode object and call the show() method.
The current implementation supports the following literal field types: FieldBool.py FieldFloat.py FieldInt.py FieldString.py
The following list types are also supported: FieldList.py FieldSelectableList.py FieldTuple.py
The object pathlib.Path can also be stored: FieldPath.py
Usually the type is automatically detected.
Before you can start working with the config, you need to create some kind of sceleton. This has three advantages:
- You can define the type of the fields. You can give them friendly names and descriptions.
- The parsing of the config file is much easier, because the parser knows the type of the fields.
- When working with this library, you can use the auto completion of your IDE, since it is a class.
import confPy6 as cfg
class SecondConfig(cfg.ConfigNode):
def __init__(self, enable_log=True) -> None:
# Call the base class (important!)
super().__init__(internal_log=enable_log)
# Create a field of type int. Set a default value, a friendly name and a description
self.test_int: cfg.Field[int] = cfg.Field(1,
friendly_name="My Test Int",
description="This is just an integer")
class ApplicationConfig(cfg.ConfigNode):
def __init__(self, enable_log=True) -> None:
# Call the base class (important!)
super().__init__(internal_log=enable_log)
# Some fields
# Create a field of type int. Set a default value, a friendly name and a description
self.counter: cfg.Field[int] = cfg.Field(
1, friendly_name="My Counter", description="This is just an integer")
self.version: cfg.Field[str] = cfg.Field(
"v1.0", friendly_name="Version", description="The version")
# You can also omit the friendly name and description
self.check: cfg.Field[bool] = cfg.Field(False)
# Some other fields
# Also possible to create a field of type list
self.my_tuple: cfg.Field[tuple] = cfg.Field((1, 2))
self.any_list: cfg.Field[list] = cfg.Field([1, 2])
# Even a nested config is possible
self.second_config: SecondConfig = SecondConfig()
# Don't forget to register the fields (important!)
self.register()It is possible to load and save a config. The config is saved as a yaml file.
from ApplicationConfig import ApplicationConfig
if __name__ == "__main__":
config = ApplicationConfig(enable_log=True)
config.save('./configs/ApplicationConfig.yaml')
config.load('./configs/ApplicationConfig.yaml')It is also possible to autosave a config. This is useful, if you want to save the config, when the user changes a value.
from ApplicationConfig import ApplicationConfig
if __name__ == "__main__":
config = ApplicationConfig(enable_log=True)
config.autosave(enable=True, path='./configs_autosave')The condifg handler build an UI in the background. You can access the widget using
import logging
import sys
from PySide6 import QtWidgets
from PySide6.QtWidgets import QApplication, QMainWindow, QWidget, QTreeWidget
from ApplicationConfig import ApplicationConfig
if __name__ == "__main__":
# Creating the UI
window = QMainWindow()
wdg = QWidget()
grd = QtWidgets.QGridLayout()
wdg.setLayout(grd)
# Add the config to the UI
config = ApplicationConfig(enable_log=True)
conf_view = config.view.widget()
grd.addWidget(conf_view, 0, 0)
window.setCentralWidget(wdg)
window.show()
sys.exit(app.exec())or using a tree view (which is sometimes more useful)
import logging
import sys
from PySide6 import QtWidgets
from PySide6.QtWidgets import QApplication, QMainWindow, QWidget, QTreeWidget
from ApplicationConfig import ApplicationConfig
if __name__ == "__main__":
# Creating the UI
window = QMainWindow()
wdg = QWidget()
grd = QtWidgets.QGridLayout()
wdg.setLayout(grd)
# Add the config to the UI
config = ApplicationConfig(enable_log=True)
# Create a tree view
tree = QTreeWidget()
tree.setColumnCount(3)
tree.setHeaderLabels(["Name", "Type", "Description"])
# Get the tree item
config_item = config.view.ui_tree_widget_item(tree)
tree.addTopLevelItem(config_item)
grd.addWidget(tree, 2, 0)
window.setCentralWidget(wdg)
window.show()
sys.exit(app.exec())confPy6 allows to automatically set environment variables. This can be useful, if you cannot use the already initialized class (e.g. you want to retrieve a variable during an import of a module). See (example4)[./examples/example4.py]
class ApplicationConfig(cfg.ConfigNode):
def __init__(self) -> None:
super().__init__()
self.wafer_list: cfg.Field[int] = cfg.Field(1, env_var="WAFER_LIST")
self.wafer_list2: cfg.Field[int] = cfg.Field(2)
self.register()use
print(os.environ['WAFER_LIST'])to print the environment variable.
When working inside the examples folder, you need to add the 'confPy6' folder to the python path.
import sys
sys.path.append('../src/')If you use this code, please cite:
Schmidt, C. (2024). fstools.confighandler - FlexSensor Tools: Configuration File Handler (Version 1.2.2) [Computer software]. https://github.com/agentsmith29/fstools.confighandler
or
@software{Schmidt_fstools_confighandler_-_FlexSensor_2024,
author = {Schmidt, Christoph},
month = feb,
title = {{fstools.confighandler - FlexSensor Tools: Configuration File Handler}},
url = {https://github.com/agentsmith29/fstools.confighandler},
version = {1.2.2},
year = {2024}
}