Skip to content

AGENTS.md: summarize CustomApp/CustomExt structure #52

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seb5g merged 3 commits into from
Oct 12, 2026
Merged

AGENTS.md: summarize CustomApp/CustomExt structure #52

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f79bee
AGENTS.md: summarize CustomApp/CustomExt structure
claude Oct 11, 2026
c2e62a8
AGENTS.md: embedding control modules in a CustomApp is not advised
claude Oct 11, 2026
cb6d4e5
AGENTS.md: use the new title of the PyMoDAQ docs page
claude Oct 11, 2026
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
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,14 @@ and the deprecated `CustomApp` / `CustomExt` hooks `setup_docks` and `setup_menu

## 4. Dashboard extensions (`CustomExt`)

Structure: `CustomApp(QObject, ActionManager, ParameterManager)` gives actions with their toolbar/menu placement,
the settings tree (`params`, `settings`, `value_changed`), the dock area, the status bar, `h5_manager` and
`thread_manager`; `CustomExt(CustomApp)` adds `dashboard`, `modules_manager` and the Dashboard toolbar. A worker
(`ExtensionWorker`) runs in its own thread with a `SaverWorker`; talk to workers with signals only. Two patterns: a standalone app
(`CustomApp`, no instrument) or a Dashboard extension (`CustomExt`, any use of instruments); embedding control modules in
a `CustomApp` is possible but not advised. They are drawn, with text versions, in the PyMoDAQ
documentation page "CustomApp and CustomExt" (`docs/src/developer_folder/custom_app.rst`).

- Entry point group `pymodaq.extensions` in `pyproject.toml`; each module in `extensions/` defines
`EXTENSION_NAME` (menu label), `CLASS_NAME` (class name) and a class derived from `CustomExt`.
- Import: `from pymodaq.utils.custom_ext import CustomExt`.
Expand Down
Loading