hisscl/README.md
2024-11-09 00:16:41 -08:00

1.3 KiB

HissCL

A HashiCorp Config Language parser for Python

Usage

For most simple use-cases, you can use the load* convenience functions:

load_file():

import hisscl
cfg = hisscl.load_file("config.hcl")

loads():

import hisscl
# Use the optional name argument to specify a filename for errors
cfg = hisscl.loads("x = 2 * 4", name='string.hcl')

load():

import hisscl
with open('test.hcl', 'r') as fl:
    # Use the optional name argument to specify a filename for errors
    cfg = hisscl.load(fl, name=fl.name)

Each load* function has an optional globals: dict[str, Any] parameter, whose elements are used as variables in your config file. For example, if you have x = y + 1, y must be defined in globals.

For more advanced use-cases, lexer, parser, ast, and interp submodules are provided.

Features

Currently, this parser supports all HCL features except:

Support for these features is planned.