napari directory organization#

The majority of the napari code lives in napari/. The main folders are:

napari/
├── _app_model/
├── _qt/
├── _tests/
├── _vendor/
├── _vispy/
├── benchmarks/
├── components/
├── errors/
├── layers/
├── plugins/
├── qt/
├── resources/
├── settings/
└── utils/

  • Folders beginning with _ represent private code, that is not part of the public API.

    • Similarly, files beginning with _ within folders are not considered part of the public API.

  • Information on organization of test files can be found in Test organization.

Notable folders in the root directory:

Qt separation#

Qt is a C++ framework to build graphical user interfaces (GUIs) that is available in Python from a number of libraries, such as PyQt5. Napari uses Qt to build its GUI, but we want to remain flexible to offer other GUI frameworks (such as a web-based GUI) in the future. Therefore, we try to confine code that directly imports Qt (currently the only supported GUI backend) to the folders _qt/ and _vispy/. Sometimes this means that code needs to be split in order to place the Qt part inside _qt/. For example, some of the Action menu items in the View menu require Qt. These live in napari/_qt/_qapp_model/qactions/_view.py while the Action menu items that do not require Qt live in napari/_app_model/actions/_view_actions.py. Notice how the folder structure inside _qt/ tries to mirror the structure of napari/, with ‘q’ being added to the start of folders and files (e.g., _app_model is named _qapp_model inside _qt/).

Folder summary#

  • _app_model/ - the code here relates to app-model and defines menu item Actions, providers and processors and context keys. Any Qt parts live in napari/_qt/_qapp_model.

  • _qt/ - here we define all the visual elements of napari including layer controls, menus, vispy canvas and dialogs. Any code that directly imports GUI also lives here.

  • _vendor/ - code vendored from other projects. This may have been because we only wanted to use a small part of a library and did not want to add another dependency. We may also have wanted to use changes in an upstream package before it has been released.

  • _vispy/ - code here defines how layers and their metadata are displayed on the canvas (the canvas is a vispy object onto which you can draw ‘visuals’).

  • benchmarks/ - benchmarking code, mostly for checking the performance of layers. It is is executed in CI and is run every Sunday. See .github/workflows/benchmarks.yml for CI workflow details. The benchmarks can also be run locally.

  • components/ - code that defines all components of the napari viewer, including the layerlist, dimensions and camera.

  • errors/ - custom napari errors (that inherit from built-in errors) are defined here. Currently we only have reader related custom errors.

  • layers/ - defines the classes, utilities, keybinding and mouse binding for each layer type.

  • plugins/ - the code here deals with registering, activating and deactivating plugins. It also handles ingesting plugin contributions to achieve the desired effect in viewer (e.g., widget contributions should add a widget to the napari viewer). Code that defines the specification for each plugin contribution, the plugin manifest and defines plugin manager (a class that manages the currently installed plugins and their contribitions) lives in its own repo: npe2.

  • qt/ - public utilities that directly rely on Qt, such as the progress bar and the thread worker.

  • resources/ - stores icons for buttons in the viewer.

  • settings/ - code that defines and manages napari user settings.

  • utils/ - commonly used classes and functions imported in variety of places.

On this page