https://github.com/amplify-education/python-hcl2
https://github.com/amplify-education/python-hcl2
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/amplify-education/python-hcl2
- Owner: amplify-education
- License: mit
- Created: 2019-08-16T17:56:51.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T12:57:28.000Z (about 2 months ago)
- Last Synced: 2025-04-12T01:03:42.515Z (about 2 months ago)
- Language: Python
- Size: 483 KB
- Stars: 272
- Watchers: 26
- Forks: 58
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://app.codacy.com/gh/amplify-education/python-hcl2/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://travis-ci.org/amplify-education/python-hcl2)
[](https://raw.githubusercontent.com/amplify-education/python-hcl2/master/LICENSE)
[](https://pypi.org/project/python-hcl2/)
[](https://pypi.python.org/pypi/python-hcl2)
[](https://pypistats.org/packages/python-hcl2)
# Python HCL2
A parser for [HCL2](https://github.com/hashicorp/hcl/blob/hcl2/hclsyntax/spec.md) written in Python using
[Lark](https://github.com/lark-parser/lark). This parser only supports HCL2 and isn't backwards compatible
with HCL v1. It can be used to parse any HCL2 config file such as Terraform.
## About Amplify
Amplify builds innovative and compelling digital educational products that empower teachers and students across the
country. We have a long history as the leading innovator in K-12 education - and have been described as the best tech
company in education and the best education company in tech. While others try to shrink the learning experience into
the technology, we use technology to expand what is possible in real classrooms with real students and teachers.
Learn more at
## Getting Started
### Prerequisites
python-hcl2 requires Python 3.7 or higher to run.
### Installing
This package can be installed using `pip`
```sh
pip3 install python-hcl2
```
### Usage
```python
import hcl2
with open('foo.tf', 'r') as file:
dict = hcl2.load(file)
```
### Parse Tree to HCL2 reconstruction
With version 6.x the possibility of HCL2 reconstruction from the Lark Parse Tree and Python dictionaries directly was introduced.
Documentation and an example of manipulating Lark Parse Tree and reconstructing it back into valid HCL2 can be found in [tree-to-hcl2-reconstruction.md](https://github.com/amplify-education/python-hcl2/blob/main/tree-to-hcl2-reconstruction.md) file.
More details about reconstruction implementation can be found in PRs #169 and #177.
## Building From Source
For development, `tox>=4.0.9` is recommended.
### Running Tests
python-hcl2 uses `tox`. You will need to install tox with `pip install tox`.
Running `tox` will automatically execute linters as well as the unit tests.
You can also run them individually with the `-e` argument.
For example, `tox -e py37-unit` will run the unit tests for python 3.7
To see all the available options, run `tox -l`.
## Releasing
To create a new release go to Releases page, press 'Draft a new release', create a tag
with a version you want to be released, fill the release notes and press 'Publish release'.
Github actions will take care of publishing it to PyPi.
## Responsible Disclosure
If you have any security issue to report, contact project maintainers privately.
You can reach us at
## Contributing
We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you:
- For any sizable change, first open a GitHub issue to discuss your idea.
- Create a pull request. Explain why you want to make the change and what it’s for.
We’ll try to answer any PR’s promptly.
## Limitations
### Using inline expression as an object key
- Object key can be an expression as long as it is wrapped in parentheses:
```terraform
locals {
foo = "bar"
baz = {
(format("key_prefix_%s", local.foo)) : "value"
# format("key_prefix_%s", local.foo) : "value" this will fail
}
}
```