Application Programming Interfaces

The CFG format can be used through libraries with an API, which depends on the implementation language. The following sections describe the API exposed by a number of different implementations of functionality to work with CFG.

In all current implementations, there are two levels:

• A low level which parses CFG source to produce an abstract syntax tree (AST).
• A higher level which uses the parser to create higher-level configuration objects, which are what your programs will interact with in most cases.

Currently, only the higher level is documented, as it should be all that’s needed to work with CFG files.

Use the links below to look at the APIs for various languages. They are broadly similar for each of the implementations – Python, the JVM (using Kotlin), .NET, Go, Rust, D, JavaScript, Ruby, Elixir and Nim.

• The CFG API for Python
  • Backwards-Incompatible Changes
    • Format
    • Code
  • Modules
  • Installation
  • Getting Started with CFG in Python
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to datetime objects
    • Access to other Python objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
    • A larger example - Django configuration
  • Classes
    • The Location class
    • The ConfigError class
    • The Config class
      • Config
        • Config.path
        • Config.include_path
        • Config.context
        • Config.no_duplicates
        • Config.strict_conversions
        • Config.load()
        • Config.close()
        • Config.as_dict()
        • Config.get()
• The CFG API for Kotlin / Java
  • Installation
  • Exploration
  • Getting Started with CFG in Kotlin / Java
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to other JVM objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Classes
    • The Config class
• The CFG API for .NET
  • Installation
  • Exploration
  • Getting Started with CFG in C#
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to other CLR objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Namespaces
  • Classes
    • The Config class
• The CFG API for Rust
  • Usage
  • Exploration
  • Getting Started with CFG in Rust
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Types
  • Enums
  • Structs
• The CFG API for Go
  • Installation
  • Exploration
  • Getting Started with CFG in Go
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Types
  • Functions
• The CFG API for D
  • Installation
  • Exploration
  • Getting Started with CFG in D
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Classes
    • The Config class
• The CFG API for JavaScript
  • Installation
  • Exploration
  • Getting Started with CFG in JavaScript
    • Loading a configuration
    • Usage in a browser
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Classes
    • The Config class
      • Config
        • Config.noDuplicates: bool = true
        • Config.strictConversions: bool = true
        • Config.context: object
        • Config.cached: bool = false
        • Config.includePath: string[]
        • Config.path: string = null
        • Config.Config()
        • Config.load()
        • Config.loadFile()
        • Config.get()
  • Functions
    • makeStream()
• The CFG API for Ruby
  • Installation
  • Exploration
  • Getting Started with CFG in Ruby
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to other Ruby objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Classes
    • The Config class
• The CFG API for Elixir
  • Installation
  • Exploration
  • Getting Started with CFG in Elixir
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to other Elixir objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Modules
    • CFG.Location
    • CFG.RecognizerError
    • CFG.Config
• The CFG API for Nim
  • Installation
  • Exploration
  • Getting Started with CFG in Nim
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Types
    • ValueKind (enum)
    • ConfigValue (object)
    • Location (object)
    • ConfigError (object)
    • Config (ref object)
• The CFG API for Dart
  • Installation
  • Exploration
  • Getting Started with CFG in Dart
    • Loading a configuration
    • Access elements with keys
    • Access elements with paths
    • Access to date/time objects
    • Access to environment variables
    • Access to computed values
    • Including one configuration inside another
    • Avoiding unnecessary repetition
  • Classes
    • The Location class
    • The ConfigException class
    • The Config class