decomp-settings

0.0.10 verified Fri May 01 auth: no python

A library for reading the decomp.yaml configuration file used in decompilation projects. Current version 0.0.10, requires Python >=3.7. Release cadence is irregular.

pip install decomp-settings

Common errors

error ModuleNotFoundError: No module named 'decomp_settings' ↓

cause Library not installed or installed in wrong environment.

fix

Run 'pip install decomp-settings' in the correct Python environment.

error AttributeError: module 'decomp_settings' has no attribute 'Config' ↓

cause Old import pattern (e.g., 'from decomp_settings.config import Config') was used.

fix

Use 'from decomp_settings import Config'.

error yaml.YAMLError: while scanning a simple key ↓

cause The decomp.yaml file has indentation errors or mixed tabs/spaces.

fix

Check the YAML syntax; use consistent indentation (spaces).

Warnings

deprecated The 'github' field in decomp.yaml was renamed to 'repo' in version 0.0.9. ↓

fix Update your decomp.yaml: replace 'github:' with 'repo:'.

breaking Version paths are now type-checked; previously strings were accepted, now they must be an appropriate type. ↓

fix Ensure version paths are typed correctly (see docs).

gotcha The library is built with PyO3 (Rust), so installation may require a Rust compiler on some systems. ↓

fix If pip fails, install Rust via rustup or use pre-built wheels.

deprecated Old-style tool definitions (plain strings) were deprecated in 0.0.4 and may be removed. ↓

fix Use the new arbitrary tool definition format.

Imports

Version

wrong

from decomp_settings.version import Version

correct

from decomp_settings import Version

Version is exposed at top-level package.

Config

wrong

from decomp_settings.config import Config

correct

from decomp_settings import Config

Config is exposed at top-level package.

Quickstart

Load a decomp.yaml file and print its version and tools.

from decomp_settings import Config, Version

config = Config.from_yaml('decomp.yaml')
print(config.version)
print(config.tools)