https://github.com/virtuald/pyhcl

HCL is a configuration language. pyhcl is a python parser for it.
https://github.com/virtuald/pyhcl

configuration hcl python

Last synced: about 9 hours ago
JSON representation

HCL is a configuration language. pyhcl is a python parser for it.

• Host: GitHub
• URL: https://github.com/virtuald/pyhcl
• Owner: virtuald
• License: mpl-2.0
• Created: 2014-09-09T21:51:09.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-09-03T22:28:39.000Z (3 months ago)
• Last Synced: 2024-11-19T22:05:36.367Z (22 days ago)
• Topics: configuration, hcl, python
• Language: Python
• Size: 196 KB
• Stars: 336
• Watchers: 16
• Forks: 60
• Open Issues: 11
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-terraform - pyhcl - HCL parser in Python (Libraries / Miscellaneous)
• awesome-tf - pyhcl - HCL parser in Python (Libraries / IDE)
• jimsghstars - virtuald/pyhcl - HCL is a configuration language. pyhcl is a python parser for it. (Python)

README

        
pyhcl

=====

Implements a parser for `HCL (HashiCorp Configuration

Language) `__ in Python. This

implementation aims to be compatible with the original golang version of

the parser.

pyhcl does not support HCL2 (which is what modern terraform uses). You might try

https://pypi.org/project/python-hcl2/ instead (though I've never personally tried it).

The grammar and many of the tests/fixtures were copied/ported from the

golang parser into pyhcl. All releases are tested with a variety of 

python versions from Python 2.7 onward.

This version has been modified to work with terraform 0.12 syntax.  

It should be backward compatible with earlier versions.  

It doesn't cover every situation.  See discussion in pull request:

https://github.com/virtuald/pyhcl/pull/57

Installation

============

::

    pip install pyhcl

Usage

=====

This module is intended to be used in mostly the same way that one would

use the json module in python, and load/loads/dumps are implemented.

::

    import hcl

    with open('file.hcl', 'r') as fp:

        obj = hcl.load(fp)

Currently the dumps function outputs JSON, and not HCL.

Convert HCL to JSON

-------------------

pyhcl comes with a script that you can use to easily convert HCL to JSON,

similar to the json.tool that comes with python::

	hcltool INFILE [OUTFILE]

	

Structure Validation

--------------------

Similar to JSON, the output of parsing HCL is a python dictionary with

no defined structure. The golang library for HCL implements support for

parsing HCL according to defined objects, but this implementation does

not currently support such constructs.

Instead, I recommend that you use tools designed to validate JSON, such

as the `schematics `_ library. 

Syntax

======

-  Single line comments start with ``#`` or ``//``

-  Multi-line comments are wrapped in ``/*`` and ``*/``

-  Values are assigned with the syntax ``key = value`` (whitespace

   doesn't matter). The value can be any primitive: a string, number,

   boolean, object, or list.

-  Strings are double-quoted and can contain any UTF-8 characters.

   Example: ``"Hello, World"``

-  Numbers are assumed to be base 10. If you prefix a number with 0x, it

   is treated as a hexadecimal. If it is prefixed with 0, it is treated

   as an octal. Numbers can be in scientific notation: "1e10".

-  Boolean values: ``true``, ``false``

-  Arrays can be made by wrapping it in ``[]``. Example:

   ``["foo", "bar", 42]``. Arrays can contain primitives and other

   arrays, but cannot contain objects. Objects must use the block syntax

   shown below.

Objects and nested objects are created using the structure shown below::

    variable "ami" {

        description = "the AMI to use"

    }

Testing

=======

To run the tests::

    pip install -r testing-requirements.txt

    tests/run_tests.sh

    

Debug Mode

----------

To enable debug mode::

    import hcl

    hcl.parser.DEBUG = True

Authors

=======

Dustin Spicuzza ([email protected])

Note: This project is not associated with Hashicorp