Skip to main content
Version: 2.25 (dev)

python_google_cloud_function

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

See https://www.pantsbuild.org/2.24/docs/python/integrations/google-cloud-functions.

Backend: pants.backend.google_cloud_function.python

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'.

This is re-exported at main.handler in the resulting package to used as the configured handler of the Google Cloud Function in GCP. It can also be accessed under its source-root-relative module path, for example: path.to.module.handler_func.

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.

complete_platforms​

Iterable[str] | None
default: None

The platforms the built PEX should be compatible with.

There must be built wheels available for all of the foreign platforms, rather than sdists.

You can give a list of multiple complete platforms to create a multiplatform PEX, meaning that the PEX will be executable in all of the supported environments.

Complete platforms should be addresses of file or resource targets that point to files that contain complete platform JSON as described by Pex (https://pex.readthedocs.io/en/latest/buildingpex.html#complete-platform).

See https://www.pantsbuild.org/2.24/docs/python/overview/pex#generating-the-complete_platforms-file for details on how to create this file.

N.B.: only one of this and runtime can be set. If runtime is set, a default complete platform is chosen, if one is known for that runtime. Explicitly set this to [] to use the platform's ambient interpreter, such as when running in an docker environment.

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/2.24/docs/using-pants/key-concepts/targets-and-build-files 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.

environment​

str | None
default: '__local__'

Specify which environment target to consume environment-sensitive options from.

Once environments are defined in [environments-preview].names, you can specify the environment for this target by its name. Any fields that are defined in that environment will override the values from options set by pants.toml, command line values, or environment variables.

You can specify multiple valid environments by using parametrize. If __local__ is specified, Pants will fall back to the local_environment defined for the current platform, or no environment if no such environment exists.

layout​

'flat' | 'flat-zipped' | 'venv' | None
default: 'flat-zipped'

Control the layout of the final artifact: flat creates a directory with the source and requirements at the top level, as recommended by cloud vendors, while flat-zipped (the default) wraps this up into a single zip file.

output_path​

str | None
default: '${spec_path_normalized}/${target_name_normalized}${file_suffix}'

Where the built asset should be located.

This field supports the following template replacements:

  • ${spec_path_normalized}: The path to the target's directory ("spec path") with forward slashes replaced by dots.

  • ${target_name_normalized}: The target's name with paramaterizations escaped by replacing dots with underscores.

  • ${file_suffix}: For target's which produce single file artifacts, this is the file type suffix to use with a leading dot, and is empty otherwise when not applicable.

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. This behavior corresponds to the default template: ${spec_path_normalized}/${target_name_normalized}${file_suffix}

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.

pex_build_extra_args​

Iterable[str] | None
default: ()

Additional arguments to pass to the pex invocation that is used to collect the requirements and sources for packaging.

For example, pex_build_extra_args=["--exclude=pypi-package-name"] to force a package called pypi-package-name isn't included in the artifact.

Note: Excluding dependencies currently causes Pex to throw an error. You can additionally pass the --ignore-errors flag.

pex3_venv_create_extra_args​

Iterable[str] | None
default: ()

Any extra arguments to pass to the pex3 venv create invocation that is used to create the final zip file or directory.

For example, pex3_venv_create_extra_args=["--collisions-ok"], if using packages that have colliding files that aren't required at runtime (errors like "Encountered collisions populating ...").

resolve​

str | None
default: None

The resolve from [python].resolves to use.

If not defined, will default to [python].default_resolve.

All dependencies must share the same value for their resolve field.

runtime​

'python310' | 'python311' | 'python312' | 'python37' | 'python38' | 'python39' | None
default: None

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

In general you'll want to define either a runtime or one complete_platforms but not both. Specifying a runtime is simpler, but less accurate. If you have issues either packaging the Google Cloud Function PEX or running it as a deployed Google Cloud Function, you should try using complete_platforms instead.

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.