pulumi/sdk/python
Thomas Gummerer 898a682ef6
Make sure non-targeted resources are not updated (#15476)
When the `--target` option is used, resources that already exist in the
snapshot, but aren't directly targeted should not be updated at all.
Internally in the engine, this is done by turning them into a
`SameStep`, meaning no updates will actually be preformed, and we will
make it look like the resource stayed the same.

However, we currently still write the "new" state of the resource (e.g.
updated dependencies, inputs, etc.) into the snapshot. This is mostly
fine as long as the new dependencies already exist. If a dependency on a
resource is that doesn't already exist is added however this breaks.
Since the resource that's being depended on doesn't exist in the
snapshot and isn't targeted, we won't create it. At the same time we're
adding a dependency on that virtually non-existing resource, which makes
the snapshot invalid.

Since we're in `--target` mode, we should do what we promised the user,
and only update the targeted resources, nothing else. Introduce a new
`NonTargetedSameStep` here, which does exactly that. It's essentially
the same as a `SameStep`, but we always use the *old* state instead of
the new one when writing it out. Since the resource is not targeted,
this leaves it in the same state as before.

Fixes #12096
Fixes #15382
2024-03-05 07:49:11 +00:00
..
cmd Make sure non-targeted resources are not updated (#15476) 2024-03-05 07:49:11 +00:00
dist Fix windows build 2020-12-07 15:58:30 -08:00
lib Clean up unused import warnings (#15581) 2024-03-04 13:01:25 +00:00
scripts ci: divide and conquer integration tests by sdk and package group 2022-03-04 18:08:23 -08:00
stubs Support WhoAmI in automation api for old CLI versions 2023-03-22 13:30:08 +00:00
.gitignore fix(sdk/python): Allow for duplicate output values in python programs 2022-12-07 11:59:09 -05:00
.pylintrc Upgrade pylint to 3.0.3 (#15221) 2024-01-23 23:48:02 +00:00
Makefile [auto/python] Add new API to install the Pulumi CLI (#15204) 2024-01-26 14:30:19 +00:00
README.md [sdk/python] Require Python >=3.8 (#15363) 2024-02-03 16:17:15 +00:00
mypy.ini Support deeply nested protobuf objects in python (#10284) 2022-07-29 16:17:09 +01:00
python.go Enable python conformance tests (#15283) 2024-01-30 15:02:59 +00:00
python_test.go Enable perfsprint linter (#14813) 2023-12-12 12:19:42 +00:00
requirements.txt [sdk/python] Upgrade to grpcio 1.60.1 (#15366) 2024-02-05 19:49:08 +00:00
shim_unix.go Fix lint (#7915) 2021-09-07 16:41:17 -04:00
shim_windows.go Add copyright notice 2020-12-07 14:17:45 -08: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.