Skip to main content
Version: 2.9 (deprecated)

python_google_cloud_function

A self-contained Python function suitable for uploading to Google Cloud Function.

See https://www.pantsbuild.org/v2.9/docs/python-google-cloud-function.

Backend: ``

handler​

str
required

Entry point to the Google Cloud Function handler.

You can specify a full module like 'path.to.module:handler_func' or use a shorthand to specify a file name, using the same syntax as the sources field, e.g. 'cloud_function.py:handler_func'.

You must use the file name shorthand for file arguments to work with this target.

runtime​

'python37' | 'python38' | 'python39'
required

The identifier of the Google Cloud Function runtime to target (pythonXY). See https://cloud.google.com/functions/docs/concepts/python-runtime.

type​

'event' | 'http'
required

The trigger type of the cloud function. Can either be 'event' or 'http'. See https://cloud.google.com/functions/docs/concepts/python-runtime for reference to --trigger-http.

dependencies​

Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use ./pants dependencies or ./pants peek on this target to get the final result.

See https://www.pantsbuild.org/v2.9/docs/targets#target-addresses and https://www.pantsbuild.org/v2.9/docs/targets#target-generation for more about how addresses are formed, including for generated targets. You can also run ./pants list :: to find all addresses in your project, or ./pants list dir: to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description​

str | None
default: None

A human-readable description of the target.

Use ./pants list --documented :: to see all targets with descriptions.

output_path​

str | None
default: None

Where the built asset should be located.

If undefined, this will use the path to the BUILD file, followed by the target name. For example, src/python/project:app would be src.python.project/app.ext.

When running ./pants package, this path will be prefixed by --distdir (e.g. dist/).

Warning: setting this value risks naming collisions with other package targets you may have.

tags​

Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tag='integration_test' test :: to only run on targets with that tag.