python-gdtf

Python library for General Device Type Format

GDTF specification as per https://gdtf.eu/gdtf/prologue/introduction/

See source code for documentation. Naming conventions, in general, are identical to that on the GDTF, CamelCase is replaced with underscore_delimiters.

Credits

Originally created by Jack Page. Friendly forked to Open-Stage by vanous. We continue publishing to pypi under the same pygdtf name with Jack's permission.

This library is used for example by BlenderDMX (BlenderDMX on GitHub).

GitHub Page, PyPi Page

See CHANGELOG for details.

Status

• Reading and Writing of all aspects of GDTF 1.2 (DIN SPEC 15800:2022-02)

Installation

• With uv:

uv add pygdtf

• With pip

pip install pygdtf

Latest development version (if exists on pypi.org)

uv add pygdtf --pre

Usage

GDTF files reading

# import
import pygdtf

# parse a GDTF file
gdtf_fixture = pygdtf.FixtureType("BlenderDMX@[email protected]")

# one can also parse just a description.xml file during development or testing
gdtf_fixture = pygdtf.FixtureType(dsc_file="description.xml")

# now access things like DMX modes, channels and so on
# get DMX Mode name
gdtf_fixture.dmx_modes[0].name
'Mode 1 - Standard 16 - bit'

# get total number of DMX channels
gdtf_fixture.dmx_modes[0].dmx_channels_count
39

# get number of Virtual channels
gdtf_fixture.dmx_modes[0].virtual_channels_count
0

# get DMX breaks and DMX channels count:
gdtf_fixture.dmx_modes[0].dmx_breaks[0].dmx_break
1

gdtf_fixture.dmx_modes[0].dmx_breaks[0].channels_count
39

# get DMX channels as objects gdtf_fixture.dmx_modes[0].dmx_channels
<pygdtf.DmxChannel object at 0x7f789c63bb60>, <pygdtf.DmxChannel object at
0x7f789c375590>, <pygdtf.DmxChannel object at 0x7f789c375a90>,...

# get DMX channels as dict
gdtf_fixture.dmx_modes[0].dmx_channels.as_dict()

[[{'dmx': 1, 'offset': [1, 2], 'id': 'Pan', 'default': 128, 'highlight': None,
'geometry': 'Yoke', 'break': 1, 'parent_name': 'Base', 'channel_functions':
[{'name': 'Pan', 'attribute': 'Pan', 'dmx_from': 0, 'dmx_to': 255, 'default':
128, 'real_fade': 1.833, 'physical_to': 270.0, 'physical_from': -270.0,
'channel_sets': ['', 'Center', '']}, ...

# see the source code for more methods

Writing a GDTF file

import pygdtf
from pathlib import Path

# parse a GDTF file
fixture = pygdtf.FixtureType("BlenderDMX@[email protected]")

# modify the fixture as needed, you must ensure GDTF correctness
# create writer
writer = pygdtf.FixtureTypeWriter(fixture)

# write a new GDTF archive
writer.write_gdtf(Path("BlenderDMX@[email protected]_roundtrip.gdtf"))

See BlenderDMX and tests for reference implementation and usage examples.

Development

PRs appreciated. You can use uv to get the project setup by running:

uv sync

Format

• To format, use ruff

uv run ruff format pygdtf/*

Pre-commit hooks

• You can use the pre-commit hooks

uv run pre-commit install

Testing

• To test, use pytest

uv run pytest

• To test typing with mypy use:

uv run pytest --mypy -m mypy pygdtf/*py

Updating Attribute Definitions

The canonical AttributeDefinitions XML is from the GDTF Spec, and it is stored at the repo root: AttributeDefinitions.xml. When the GDTF Spec updates that file, we need to regenerate the baked Python data module by running the following:

uv run python -c "from pygdtf.utils import attr_loader; attr_loader.generate_attribute_definitions_module()"

This writes pygdtf/utils/attribute_definitions_data.py, which is imported at runtime instead of reading the XML. Format and commit the regenerated module along with the updated XML.

Citation

If you use this library in your research, publication, or software project, please cite it as follows:

@software{pygdtf2025,
  title        = {pyGDTF: Python Library for General Device Type Format},
  author       = {{OpenStage}},
  year         = {2025},
  version      = {1.4.2},
  url          = {https://github.com/open-stage/python-gdtf}
}