python_awslambda
A self-contained Python function suitable for uploading to AWS Lambda.
See https://www.pantsbuild.org/v2.15/docs/awslambda-python.
Backend: pants.backend.awslambda.python
handler
str
Entry point to the AWS Lambda 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. 'lambda.py:handler_func'.
You must use the file name shorthand for file arguments to work with this target.
complete_platforms
Iterable[str] | None
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
targets that point to files that contain complete platform JSON as described by Pex (https://pex.readthedocs.io/en/latest/buildingpex.html#complete-platform).
dependencies
Iterable[str] | None
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 /home/josh/work/scie-pants/dist/pants dependencies
or /home/josh/work/scie-pants/dist/pants peek
on this target to get the final result.
See https://www.pantsbuild.org/v2.15/docs/targets for more about how addresses are formed, including for generated targets. You can also run /home/josh/work/scie-pants/dist/pants list ::
to find all addresses in your project, or /home/josh/work/scie-pants/dist/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
None
A human-readable description of the target.
Use /home/josh/work/scie-pants/dist/pants list --documented ::
to see all targets with descriptions.
environment
str | None
'__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.
include_requirements
bool
True
Whether to resolve requirements and include them in the Pex. This is most useful with Lambda Layers to make code uploads smaller when deps are in layers. https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html
output_path
str | None
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 /home/josh/work/scie-pants/dist/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.
resolve
str | None
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
str | None
None
The identifier of the AWS Lambda runtime to target (pythonX.Y). See https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html.
tags
Iterable[str] | None
None
Arbitrary strings to describe a target.
For example, you may tag some test targets with 'integration_test' so that you could run /home/josh/work/scie-pants/dist/pants --tag='integration_test' test ::
to only run on targets with that tag.