Python libterraform
Python binding for Terraform.
Installation
$ pip install libterraform
NOTE
- Please install version 0.3.1 or above, which solves the memory leak problem.
- This library does not support multithreading.
Usage
Terraform CLI
TerraformCommand is used to invoke various Terraform commands.
Now, support all commands (plan, apply, destroy etc.), and return a CommandResult object. The CommandResult object has the following properties:
retcodeindicates the command return code. A value of 0 or 2 is normal, otherwise is abnormal.valuerepresents command output. Ifjson=Trueis specified when executing the command, the output will be loaded as json.jsonindicates whether to load the output as json.errorindicates command error output.
To get Terraform verison:
>>> from libterraform import TerraformCommand
>>> TerraformCommand().version()
<CommandResult retcode=0 json=True>
>>> _.value
{'terraform_version': '1.1.7', 'platform': 'darwin_arm64', 'provider_selections': {}, 'terraform_outdated': False}
>>> TerraformCommand().version(json=False)
<CommandResult retcode=0 json=False>
>>> _.value
'Terraform v1.1.7\non darwin_arm64\n'
To init and apply according to Terraform configuration files in the specified directory:
>>> from libterraform import TerraformCommand
>>> cli = TerraformCommand('your_terraform_configuration_directory')
>>> cli.init()
<CommandResult retcode=0 json=False>
>>> cli.apply()
<CommandResult retcode=0 json=True>
Additionally, run() can execute arbitrary commands, returning a tuple (retcode, stdout, stderr).
>>> TerraformCommand.run('version')
(0, 'Terraform v1.1.7\non darwin_arm64\n', '')
>>> TerraformCommand.run('invalid')
(1, '', 'Terraform has no command named "invalid".\n\nTo see all of Terraform\'s top-level commands, run:\n terraform -help\n\n')
Terraform Config Parser
TerraformConfig is used to parse Terraform config files.
For now, only supply TerraformConfig.load_config_dir method which reads the .tf and .tf.json files in the given directory as config files and then combines these files into a single Module. This method returns (mod, diags) which are both dict, corresponding to the *Module and hcl.Diagnostic structures in Terraform respectively.
>>> from libterraform import TerraformConfig
>>> mod, _ = TerraformConfig.load_config_dir('your_terraform_configuration_directory')
>>> mod['ManagedResources'].keys()
dict_keys(['time_sleep.wait1', 'time_sleep.wait2'])
Building & Testing
If you want to develop this library, should first prepare the following environments:
Then, initialize git submodule:
$ git submodule init
$ git submodule update
pip install necessary tools:
$ pip install poetry pytest
Now, we can build and test:
$ poetry build -f wheel
$ pytest
Why use this library?
Terraform is a great tool for deploying resources. If you need to call the Terraform command in the Python program for deployment, a new process needs to be created to execute the Terraform command on the system. A typical example of this is the python-terraform library. Doing so has the following problems:
- Requires Terraform commands on the system.
- The overhead of starting a new process is relatively high.
This library compiles Terraform as a dynamic link library in advance, and then loads it for calling. So there is no need to install Terraform, nor to start a new process.
In addition, since the Terraform dynamic link library is loaded, this library can further call Terraform's internal capabilities, such as parsing Terraform config files.
3k Dec 29, 2022
1.5k Jan 9, 2023
9 Dec 12, 2022
11 Nov 21, 2022
4 Nov 23, 2021
6 Mar 26, 2022
16 Sep 24, 2022
32 Dec 30, 2022
5 Aug 28, 2022
123 Jan 04, 2023
5 Apr 30, 2022
17 Aug 13, 2022
1 Nov 03, 2021
4 Jun 07, 2021
15 Oct 08, 2022
2 Mar 17, 2022
6 Jan 05, 2023
4 Sep 09, 2021
32 Dec 28, 2022
27 Oct 28, 2022
41 Jun 24, 2022
4 Dec 28, 2022
1 Dec 27, 2021
10 Jun 12, 2022
153 Nov 16, 2022
2 Oct 20, 2021
100 Dec 17, 2022
1 Dec 10, 2021