How to extend hot-reload to yaml/json configuration files changes?

[vanem]

First Check

• I added a very descriptive title here.
• I have checked the FAQs for a similar question and didn't find it.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the NiceGUI documentation, with the integrated search.
• I already searched online "How to X in NiceGUI" and didn't find any information.

Example Code

from nicegui import ui
from omegaconf import OmegaConf

# cfg.yaml
# label: hello

cfg = OmegaConf.load("cfg.yaml")

ui.label(f"{cfg.label}")

ui.run()

Description

Is there already a "nice" way to auto reload when the config file changes?

NiceGUI Version

2.14.0

Python Version

3.13.2

Browser

Chrome

Operating System

Linux

Additional Context

No response

[falkoschindler]

Hi @vanem,

You can use ui.run(uvicorn_reload_includes='*.py, *.yaml') to specify a comma-separated list of glob-patterns for the hot-reload.
See https://nicegui.io/documentation/run#ui_run and https://www.uvicorn.org/settings/#reloading-with-watchfiles for more information.

[vanem]

Does not seem to work without https://pypi.org/project/watchfiles
After installing watchfiles, works like a charm

[evnchn]

You can also use a startup task and monitor the file for change, and reload the cfg variable if so.

This can avoid reloading NiceGUI, which isn't exactly fast. But, your code needs to fetch the latest cfg.label, so put it in @ui.page('/') so that the page builder function is run every time on page load.

[evnchn]

Or, you can put cfg = OmegaConf.load("cfg.yaml") inside the page builder function, loading it from disk every time.

https://nicegui.io/documentation/page