c496921d44
Issue #10659 lists a number of extra linting checks that we could enable in order to make our Go code more robust. This commit implements as many as seem sensible: * `durationcheck`, which checks for multiplication of `time.Duration`s, which can lead to unexpected behaviour (e.g. `time.Second * time.Second` is *not* one second) * `goprintffuncname`, which checks that `Printf`-like functions are appropriately suffixed with `f` to indicate as such * `tenv`, which checks for `os.Setenv` in tests where `t.Setenv` is generally a better solution * `wastedassign`, which checks for assignments whose values are never used (such as initial values before an `if` where both branches then overwrite the value) * `whitespace`, which checks for blank lines at the beginning and end of blocks such as functions, `if`s, `for`s and so on. This commit does *not* enable the following checks listed in #10659: * `wrapcheck`, which insists that third-party library errors are always `%w`rapped -- we have a lot of cases where we don't do this and it's probably a bit more involved than "just wrap them" in terms of making sure we don't break anything (maybe) * `predeclared`, which checks for shadowing of existing Go identifiers -- we use `old` and `new` a lot, especially in step generation, so this is probably a slightly bigger clean-up/one we might want to opt out of * `mnd` (magic number detection) -- we have a lot of failures on this * `nilnil` -- we only have a couple of failures on this; these could probably be handled with `//nolint` but for now I've opted not to take this route. |
||
|---|---|---|
| .. | ||
| cmd | ||
| dist | ||
| lib | ||
| scripts | ||
| stubs | ||
| toolchain | ||
| .gitignore | ||
| .pylintrc | ||
| Makefile | ||
| README.md | ||
| mypy.ini | ||
| pyrightconfig.json | ||
| requirements.txt | ||
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 you’ll 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.