uniqc.config module

Project-wide configuration and platform credentials helpers.

This module is the canonical source of truth for CONFIG_FILE and all configuration management functions (load_config, save_config, get_active_profile, …). uniqc.backend_adapter.config re-exports from here so that patching uniqc.config.CONFIG_FILE propagates to every import path.

All credentials and cache settings are persisted in ~/.uniqc/config.yaml.

Example configuration structure:

always_ai_hints: false
active_profile: default
default:
  originq:
    token: xxx
  quark:
    QUARK_API_KEY: xxx
  ibm:
    token: xxx
    proxy:
      http: http://proxy:8080
      https: https://proxy:8080

uniqc.config.create_default_config(config_path=None)

uniqc.config.get_active_profile(config_path=None)

uniqc.config.get_always_ai_hints(config_path=None)

uniqc.config.get_config_version(config)

Return the schema version of a parsed config dict (0 = unversioned legacy).

uniqc.config.get_ibm_config(profile=None)

uniqc.config.get_originq_config(profile=None)

uniqc.config.get_platform_config(platform_name, profile='default', config_path=None)

uniqc.config.get_quark_config(profile=None)

uniqc.config.has_platform_credentials(platform)

Check whether credentials exist for a platform without raising.

Returns True if the platform section exists in the active profile and contains a non-empty token/key field. Returns False otherwise (including when the config file does not exist or the platform is not configured at all).

uniqc.config.load_config(config_path=None)

uniqc.config.load_dummy_config()

uniqc.config.load_ibm_config()

uniqc.config.load_logicalqubit_config()

uniqc.config.load_originq_config()

uniqc.config.load_quark_config()

uniqc.config.load_tianyan_config()

uniqc.config.migrate_config(config)

Migrate a parsed config dict to CURRENT_CONFIG_VERSION.

Raises ConfigError if the file was written by a newer uniqc.

uniqc.config.save_config(config, config_path=None)

uniqc.config.set_active_profile(profile, config_path=None)

uniqc.config.set_always_ai_hints(enabled, config_path=None)

uniqc.config.update_platform_config(platform_name, platform_config, profile='default', config_path=None)

uniqc.config.validate_config(config=None, config_path=None)