pulumi/sdk/python
Julien efb38baee4
Fix hang on error when using uv on Windows (#18054)
When using uv we were running Python as `uv run python`, since that
conveniently
handles the virtualenv for us. This results in a process tree of
`python-language-runtime -> uv -> python`. This is problematic because
on error
we kill the plugin and its children, but not the children of the
children. On
macOS and Linux, when uv is killed, it kills its children, so we have no
problem
here. On Windows however, it does not, and we end up with an orphaned
Python
process that's busy-waiting in the eventloop and never exits.

To avoid this issue, we run Python the same way as we do when using
Poetry or Pip.

Fixes https://github.com/pulumi/pulumi/issues/17877
2024-12-16 18:14:20 +00:00
..
cmd fix race conditions in nxadm/tail library (#18044) 2024-12-16 14:32:08 +00:00
dist Handle extra CLI arguments passed policy packs plugins (#16402) 2024-06-17 09:10:04 +00:00
lib Document provider Diff response requirements (#18032) 2024-12-16 11:10:28 +00:00
scripts Give Node.js and Python coverage files unique names to improve code coverage quality (#17100) 2024-08-29 15:55:03 +00:00
stubs Support WhoAmI in automation api for old CLI versions 2023-03-22 13:30:08 +00:00
toolchain Fix hang on error when using uv on Windows (#18054) 2024-12-16 18:14:20 +00:00
.gitignore fix(sdk/python): Allow for duplicate output values in python programs 2022-12-07 11:59:09 -05:00
Makefile Switch to ruff for linting and formatting (#17882) 2024-12-02 12:41:19 +00:00
README.md [sdk/python] Require Python >=3.8 (#15363) 2024-02-03 16:17:15 +00:00
mypy.ini Drop Python 3.8 support (#17883) 2024-12-02 16:13:08 +00:00
pyrightconfig.json Fix Pyright type checking of "StackReference#outputs" (#16957) 2024-08-14 05:14:23 +00:00
requirements.txt Switch to ruff for linting and formatting (#17882) 2024-12-02 12:41:19 +00:00
ruff.toml Drop Python 3.8 support (#17883) 2024-12-02 16:13:08 +00:00

README.md

Pulumi Python SDK

The Pulumi Python SDK (pulumi) is the core package used when writing Pulumi programs in Python. It contains everything that youll need in order to interact with Pulumi resource providers and express infrastructure using Python code. Pulumi resource providers all depend on this library and express their resources in terms of the types defined in this module.

The Pulumi Python SDK requires a supported version of Python.

note: pip is required to install dependencies. If you installed Python from source, with an installer from python.org, or via Homebrew you should already have pip. If Python is installed using your OS package manager, you may have to install pip separately, see Installing pip/setuptools/wheel with Linux Package Managers. For example, on Debian/Ubuntu you must run sudo apt install python3-venv python3-pip.

Getting Started

The fastest way to get up and running is to choose from one of the following Getting Started guides: -aws -microsoft azure -google cloud -kubernetes

Pulumi Programming Model

The Pulumi programming model defines the core concepts you will use when creating infrastructure as code programs using Pulumi. Architecture & Concepts describes these concepts with examples available in Python. These concepts are made available to you in the Pulumi SDK.

The Pulumi SDK is available to Python developers as a Pip package distributed on PyPI . To learn more, refer to the Pulumi SDK Reference Guide.

The Pulumi programming model includes a core concept of Input and Output values, which are used to track how outputs of one resource flow in as inputs to another resource. This concept is important to understand when getting started with Python and Pulumi, and the [Inputs and Outputs] (https://www.pulumi.com/docs/intro/concepts/inputs-outputs/)documentation is recommended to get a feel for how to work with this core part of Pulumi in common cases.

The Pulumi Python Resource Model

Like most languages usable with Pulumi, Pulumi represents cloud resources as classes and Python programs can instantiate those classes. All classes that can be instantiated to produce actual resources derive from the pulumi.Resource class.