pulumi/sdk/python
Zaid Ajaj 31c90fd0e0
[python/sdk] Allow remote components to use output property called id (#15115)
# Description

This PR updates the python SDK to allow remote components to have ID
property. Adds an integration test which implements a component that had
an output property `id` to ensure that we can have `id` as an output
that doesn't get filtered out when serializing and deserializing
property maps.

Component instantiation looks like this in python
```python
import pulumi
from component import Component

component_a = Component("a", id="hello")

pulumi.export("id", component_a.id)
```
Where we expect `component_a.id` to equal `"{resource.ID}-{args.Id}" =>
"42-hello"` and the 42 is the (constant) ID of the resource created
inside the component.

## Checklist

- [ ] I have run `make tidy` to update any new dependencies
- [x] I have run `make lint` to verify my code passes the lint check
  - [ ] I have formatted my code using `gofumpt`

<!--- Please provide details if the checkbox below is to be left
unchecked. -->
- [x] I have added tests that prove my fix is effective or that my
feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [x] I have run `make changelog` and committed the
`changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the
Pulumi Cloud,
then the service should honor older versions of the CLI where this
change would not exist.
You must then bump the API version in
/pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi
Cloud API version
<!-- @Pulumi employees: If yes, you must submit corresponding changes in
the service repo. -->
2024-01-18 13:54:09 +00:00
..
cmd Remove deprecated Protobufs imports (#15158) 2024-01-17 09:35:20 +00:00
dist Fix windows build 2020-12-07 15:58:30 -08:00
lib [python/sdk] Allow remote components to use output property called id (#15115) 2024-01-18 13:54:09 +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 [sdk/*] Add support for resource source positions 2023-07-13 16:46:04 -07:00
Makefile Switch to API Token for PyPi uploads (#15048) 2024-01-04 14:44:52 +00: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 Enable perfsprint linter (#14813) 2023-12-12 12:19:42 +00:00
python_test.go Enable perfsprint linter (#14813) 2023-12-12 12:19:42 +00:00
requirements.txt Fix traceback diagnostic from being printed when using Python dynamic providers (#14474) 2023-11-01 22:19:37 +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 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.