pulumi/sdk/python
Justin Van Patten 0b13f9169d [sdk/{go,nodejs,python}] Fix DeletedWith resource option
This change fixes the `DeletedWith` resource option in the Go, Node.js,
and Python SDKs and adds tests.

This feature was a community contribution and while there were engine
tests included with the original PR, there weren't any tests confirming
the functionality worked correctly from each SDK.

Here's a summary of the fixes:

* Go: The `DeletedWith` resource option was never usable as it accepted
  a URN instead of a Resource. We discussed this internally a while back
  and decided to go ahead and fix this. (Note: While changing the
  signature is technically a breaking change, the feature is currently
  unusable, so the change would not break anyone, so there's no need to
  wait for a major version bump.)

* Node.js: The `deletedWith` resource option did not work at all from
  the Node.js SDK because it was incorrectly passing the resource object
  itself in the RegisterResource request, rather than the resource's
  URN.

* Python: The `deleted_with` resource option did not work at all from
  the Python SDK because it was incorrectly passing the resource object
  itself in the RegisterResource request, rather than the resource's
  URN.

A `FailsOnDelete` resource has been added to the testprovider, which
will fail when its `Delete` gRPC is called. The tests use this to ensure
`Delete` is not called for resources of this type with the `DeletedWith`
option specified.
2023-01-15 16:30:26 -08:00
..
cmd Merge #11819 #11834 #11842 #11845 2023-01-12 20:11:42 +00:00
dist Fix windows build 2020-12-07 15:58:30 -08:00
lib [sdk/{go,nodejs,python}] Fix DeletedWith resource option 2023-01-15 16:30:26 -08:00
scripts ci: divide and conquer integration tests by sdk and package group 2022-03-04 18:08:23 -08:00
stubs Fix bug in semver usage by enabling typechecking (#6833) 2021-04-21 15:48:57 -04:00
.gitignore fix(sdk/python): Allow for duplicate output values in python programs 2022-12-07 11:59:09 -05:00
.pylintrc Fix protobuf checksum code and regenerate 2022-11-04 09:57:05 +00:00
Makefile [sdk/python] Allow editable installs without build step 2022-09-30 17:21:44 -07:00
README.md Add files via upload 2022-11-22 20:09:45 +05:30
mypy.ini Support deeply nested protobuf objects in python (#10284) 2022-07-29 16:17:09 +01:00
python.go Clean up use of pkg/errors in sdk/python 2023-01-03 10:19:35 +00:00
python_test.go all: Drop ioutil 2023-01-06 16:35:14 -08:00
requirements.txt Bumps grpcio to version 1.50 2022-12-21 08:45:21 -05: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 Python version 3.7 or greater through official python installer

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.