@aws-cdk/aws-lambda-python-alpha 2.0.0-rc.23

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+AWS Cloud Development Kit (AWS CDK)
+Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

package/README.md

@@ -0,0 +1,98 @@
+# Amazon Lambda Python Library
+
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
+
+> The APIs of higher level constructs in this module are experimental and under active development.
+> They are subject to non-backward compatible changes or removal in any future version. These are
+> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
+> announced in the release notes. This means that while you may use them, you may need to update
+> your source code when upgrading to a newer version of this package.
+
+---
+
+<!--END STABILITY BANNER-->
+
+This library provides constructs for Python Lambda functions.
+
+To use this module, you will need to have Docker installed.
+
+## Python Function
+
+Define a `PythonFunction`:
+
+```ts
+import * as lambda from "@aws-cdk/aws-lambda";
+import { PythonFunction } from "@aws-cdk/aws-lambda-python";
+
+new PythonFunction(this, 'MyFunction', {
+  entry: '/path/to/my/function', // required
+  index: 'my_index.py', // optional, defaults to 'index.py'
+  handler: 'my_exported_func', // optional, defaults to 'handler'
+  runtime: lambda.Runtime.PYTHON_3_6, // optional, defaults to lambda.Runtime.PYTHON_3_7
+});
+```
+
+All other properties of `lambda.Function` are supported, see also the [AWS Lambda construct library](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-lambda).
+
+## Module Dependencies
+
+If `requirements.txt` or `Pipfile` exists at the entry path, the construct will handle installing
+all required modules in a [Lambda compatible Docker container](https://gallery.ecr.aws/sam/build-python3.7)
+according to the `runtime` and with the Docker platform based on the target architecture of the Lambda function.
+
+Python bundles are only recreated and published when a file in a source directory has changed.
+Therefore (and as a general best-practice), it is highly recommended to commit a lockfile with a
+list of all transitive dependencies and their exact versions.
+This will ensure that when any dependency version is updated, the bundle asset is recreated and uploaded.
+
+To that end, we recommend using [`pipenv`] or [`poetry`] which has lockfile support.
+
+[`pipenv`]: https://pipenv-fork.readthedocs.io/en/latest/basics.html#example-pipfile-lock
+[`poetry`]: https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+
+**Lambda with a requirements.txt**
+
+```plaintext
+.
+├── lambda_function.py # exports a function named 'handler'
+├── requirements.txt # has to be present at the entry path
+```
+
+**Lambda with a Pipfile**
+
+```plaintext
+.
+├── lambda_function.py # exports a function named 'handler'
+├── Pipfile # has to be present at the entry path
+├── Pipfile.lock # your lock file
+```
+
+**Lambda with a poetry.lock**
+
+```plaintext
+.
+├── lambda_function.py # exports a function named 'handler'
+├── pyproject.toml # has to be present at the entry path
+├── poetry.lock # your poetry lock file
+```
+
+**Lambda Layer Support**
+
+You may create a python-based lambda layer with `PythonLayerVersion`. If `PythonLayerVersion` detects a `requirements.txt`
+or `Pipfile` or `poetry.lock` with the associated `pyproject.toml` at the entry path, then `PythonLayerVersion` will include the dependencies inline with your code in the
+layer.
+
+```ts
+new lambda.PythonFunction(this, 'MyFunction', {
+  entry: '/path/to/my/function',
+  layers: [
+    new lambda.PythonLayerVersion(this, 'MyLayer', {
+      entry: '/path/to/my/layer', // point this to your library's directory
+    }),
+  ],
+});
+```

package/lib/Dockerfile

@@ -0,0 +1,9 @@
+# The correct AWS SAM build image based on the runtime of the function will be
+# passed as build arg. The default allows to do `docker build .` when testing.
+ARG IMAGE=public.ecr.aws/sam/build-python3.7
+FROM $IMAGE
+
+# Ensure rsync is installed
+RUN yum -q list installed rsync &>/dev/null || yum install -y rsync
+
+CMD [ "python" ]

package/lib/Dockerfile.dependencies

@@ -0,0 +1,22 @@
+# The correct AWS SAM build image based on the runtime of the function will be
+# passed as build arg. The default allows to do `docker build .` when testing.
+ARG IMAGE=public.ecr.aws/sam/build-python3.7
+FROM $IMAGE
+
+# Ensure rsync is installed
+RUN yum -q list installed rsync &>/dev/null || yum install -y rsync
+
+# Upgrade pip (required by cryptography v3.4 and above, which is a dependency of poetry)
+RUN pip install --upgrade pip
+
+# Install pipenv and poetry so we can create a requirements.txt if we detect pipfile or poetry.lock respectively
+RUN pip install pipenv poetry
+
+# Install the dependencies in a cacheable layer
+WORKDIR /var/dependencies
+COPY Pipfile* pyproject* poetry* requirements.tx[t] ./
+RUN [ -f 'Pipfile' ] && pipenv lock -r >requirements.txt; \
+    [ -f 'poetry.lock' ] && poetry export --with-credentials --format requirements.txt --output requirements.txt; \
+    [ -f 'requirements.txt' ] && pip install -r requirements.txt -t .;
+
+CMD [ "python" ]

package/lib/bundling.d.ts

@@ -0,0 +1,78 @@
+import * as lambda from 'aws-cdk-lib/aws-lambda';
+import * as cdk from 'aws-cdk-lib';
+/**
+ * Dependency files to exclude from the asset hash.
+ */
+export declare const DEPENDENCY_EXCLUDES: string[];
+/**
+ * The location in the image that the bundler image caches dependencies.
+ */
+export declare const BUNDLER_DEPENDENCIES_CACHE = "/var/dependencies";
+/**
+ * Options for bundling
+ */
+export interface BundlingOptions {
+    /**
+     * Entry path
+     */
+    readonly entry: string;
+    /**
+     * The runtime of the lambda function
+     */
+    readonly runtime: lambda.Runtime;
+    /**
+     * The system architecture of the lambda function
+     */
+    readonly architecture: lambda.Architecture;
+    /**
+     * Output path suffix ('python' for a layer, '.' otherwise)
+     */
+    readonly outputPathSuffix: string;
+    /**
+     * Determines how asset hash is calculated. Assets will get rebuild and
+     * uploaded only if their hash has changed.
+     *
+     * If asset hash is set to `SOURCE` (default), then only changes to the source
+     * directory will cause the asset to rebuild. This means, for example, that in
+     * order to pick up a new dependency version, a change must be made to the
+     * source tree. Ideally, this can be implemented by including a dependency
+     * lockfile in your source tree or using fixed dependencies.
+     *
+     * If the asset hash is set to `OUTPUT`, the hash is calculated after
+     * bundling. This means that any change in the output will cause the asset to
+     * be invalidated and uploaded. Bear in mind that `pip` adds timestamps to
+     * dependencies it installs, which implies that in this mode Python bundles
+     * will _always_ get rebuild and uploaded. Normally this is an anti-pattern
+     * since build
+     *
+     * @default AssetHashType.SOURCE By default, hash is calculated based on the
+     * contents of the source directory. If `assetHash` is also specified, the
+     * default is `CUSTOM`. This means that only updates to the source will cause
+     * the asset to rebuild.
+     */
+    readonly assetHashType?: cdk.AssetHashType;
+    /**
+     * Specify a custom hash for this asset. If `assetHashType` is set it must
+     * be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
+     * be SHA256 hashed and encoded as hex. The resulting hash will be the asset
+     * hash.
+     *
+     * NOTE: the hash is used in order to identify a specific revision of the asset, and
+     * used for optimizing and caching deployment activities related to this asset such as
+     * packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
+     * need to make sure it is updated every time the asset changes, or otherwise it is
+     * possible that some deployments will not be invalidated.
+     *
+     * @default - based on `assetHashType`
+     */
+    readonly assetHash?: string;
+}
+/**
+ * Produce bundled Lambda asset code
+ */
+export declare function bundle(options: BundlingOptions): lambda.Code;
+/**
+ * Checks to see if the `entry` directory contains a type of dependency that
+ * we know how to install.
+ */
+export declare function stageDependencies(entry: string, stagedir: string): boolean;

package/lib/bundling.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stageDependencies = exports.bundle = exports.BUNDLER_DEPENDENCIES_CACHE = exports.DEPENDENCY_EXCLUDES = void 0;
+const fs = require("fs");
+const path = require("path");
+const lambda = require("aws-cdk-lib/aws-lambda");
+const cdk = require("aws-cdk-lib");
+/**
+ * Dependency files to exclude from the asset hash.
+ */
+exports.DEPENDENCY_EXCLUDES = ['*.pyc'];
+/**
+ * The location in the image that the bundler image caches dependencies.
+ */
+exports.BUNDLER_DEPENDENCIES_CACHE = '/var/dependencies';
+/**
+ * Produce bundled Lambda asset code
+ */
+function bundle(options) {
+    const { entry, runtime, architecture, outputPathSuffix } = options;
+    const stagedir = cdk.FileSystem.mkdtemp('python-bundling-');
+    const hasDeps = stageDependencies(entry, stagedir);
+    const depsCommand = chain([
+        hasDeps ? `rsync -r ${exports.BUNDLER_DEPENDENCIES_CACHE}/. ${cdk.AssetStaging.BUNDLING_OUTPUT_DIR}/${outputPathSuffix}` : '',
+        `rsync -r . ${cdk.AssetStaging.BUNDLING_OUTPUT_DIR}/${outputPathSuffix}`,
+    ]);
+    // Determine which dockerfile to use. When dependencies are present, we use a
+    // Dockerfile that can create a cacheable layer. We can't use this Dockerfile
+    // if there aren't dependencies or the Dockerfile will complain about missing
+    // sources.
+    const dockerfile = hasDeps
+        ? 'Dockerfile.dependencies'
+        : 'Dockerfile';
+    // copy Dockerfile to workdir
+    fs.copyFileSync(path.join(__dirname, dockerfile), path.join(stagedir, dockerfile));
+    const image = cdk.DockerImage.fromBuild(stagedir, {
+        buildArgs: {
+            IMAGE: runtime.bundlingImage.image,
+        },
+        platform: architecture.dockerPlatform,
+        file: dockerfile,
+    });
+    return lambda.Code.fromAsset(entry, {
+        assetHashType: options.assetHashType,
+        assetHash: options.assetHash,
+        exclude: exports.DEPENDENCY_EXCLUDES,
+        bundling: {
+            image,
+            command: ['bash', '-c', depsCommand],
+        },
+    });
+}
+exports.bundle = bundle;
+/**
+ * Checks to see if the `entry` directory contains a type of dependency that
+ * we know how to install.
+ */
+function stageDependencies(entry, stagedir) {
+    const prefixes = [
+        'Pipfile',
+        'pyproject',
+        'poetry',
+        'requirements.txt',
+    ];
+    let found = false;
+    for (const file of fs.readdirSync(entry)) {
+        for (const prefix of prefixes) {
+            if (file.startsWith(prefix)) {
+                fs.copyFileSync(path.join(entry, file), path.join(stagedir, file));
+                found = true;
+            }
+        }
+    }
+    return found;
+}
+exports.stageDependencies = stageDependencies;
+function chain(commands) {
+    return commands.filter(c => !!c).join(' && ');
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"bundling.js","sourceRoot":"","sources":["bundling.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAC7B,iDAAiD;AACjD,mCAAmC;AAEnC;;GAEG;AACU,QAAA,mBAAmB,GAAG,CAAC,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACU,QAAA,0BAA0B,GAAG,mBAAmB,CAAC;AAmE9D;;GAEG;AACH,SAAgB,MAAM,CAAC,OAAwB;IAC7C,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;IAEnE,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAEnD,MAAM,WAAW,GAAG,KAAK,CAAC;QACxB,OAAO,CAAC,CAAC,CAAC,YAAY,kCAA0B,MAAM,GAAG,CAAC,YAAY,CAAC,mBAAmB,IAAI,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE;QACrH,cAAc,GAAG,CAAC,YAAY,CAAC,mBAAmB,IAAI,gBAAgB,EAAE;KACzE,CAAC,CAAC;IAEH,6EAA6E;IAC7E,6EAA6E;IAC7E,6EAA6E;IAC7E,WAAW;IACX,MAAM,UAAU,GAAG,OAAO;QACxB,CAAC,CAAC,yBAAyB;QAC3B,CAAC,CAAC,YAAY,CAAC;IAEjB,6BAA6B;IAC7B,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IAEnF,MAAM,KAAK,GAAG,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE;QAChD,SAAS,EAAE;YACT,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,KAAK;SACnC;QACD,QAAQ,EAAE,YAAY,CAAC,cAAc;QACrC,IAAI,EAAE,UAAU;KACjB,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;QAClC,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,OAAO,EAAE,2BAAmB;QAC5B,QAAQ,EAAE;YACR,KAAK;YACL,OAAO,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC;SACrC;KACF,CAAC,CAAC;AACL,CAAC;AAvCD,wBAuCC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAAa,EAAE,QAAgB;IAC/D,MAAM,QAAQ,GAAG;QACf,SAAS;QACT,WAAW;QACX,QAAQ;QACR,kBAAkB;KACnB,CAAC;IAEF,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;QACxC,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;YAC7B,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBAC3B,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;gBACnE,KAAK,GAAG,IAAI,CAAC;aACd;SACF;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAnBD,8CAmBC;AAED,SAAS,KAAK,CAAC,QAAkB;IAC/B,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC","sourcesContent":["import * as fs from 'fs';\nimport * as path from 'path';\nimport * as lambda from 'aws-cdk-lib/aws-lambda';\nimport * as cdk from 'aws-cdk-lib';\n\n/**\n * Dependency files to exclude from the asset hash.\n */\nexport const DEPENDENCY_EXCLUDES = ['*.pyc'];\n\n/**\n * The location in the image that the bundler image caches dependencies.\n */\nexport const BUNDLER_DEPENDENCIES_CACHE = '/var/dependencies';\n\n/**\n * Options for bundling\n */\nexport interface BundlingOptions {\n  /**\n   * Entry path\n   */\n  readonly entry: string;\n\n  /**\n   * The runtime of the lambda function\n   */\n  readonly runtime: lambda.Runtime;\n\n  /**\n   * The system architecture of the lambda function\n   */\n  readonly architecture: lambda.Architecture;\n\n  /**\n   * Output path suffix ('python' for a layer, '.' otherwise)\n   */\n  readonly outputPathSuffix: string;\n\n  /**\n   * Determines how asset hash is calculated. Assets will get rebuild and\n   * uploaded only if their hash has changed.\n   *\n   * If asset hash is set to `SOURCE` (default), then only changes to the source\n   * directory will cause the asset to rebuild. This means, for example, that in\n   * order to pick up a new dependency version, a change must be made to the\n   * source tree. Ideally, this can be implemented by including a dependency\n   * lockfile in your source tree or using fixed dependencies.\n   *\n   * If the asset hash is set to `OUTPUT`, the hash is calculated after\n   * bundling. This means that any change in the output will cause the asset to\n   * be invalidated and uploaded. Bear in mind that `pip` adds timestamps to\n   * dependencies it installs, which implies that in this mode Python bundles\n   * will _always_ get rebuild and uploaded. Normally this is an anti-pattern\n   * since build\n   *\n   * @default AssetHashType.SOURCE By default, hash is calculated based on the\n   * contents of the source directory. If `assetHash` is also specified, the\n   * default is `CUSTOM`. This means that only updates to the source will cause\n   * the asset to rebuild.\n   */\n  readonly assetHashType?: cdk.AssetHashType;\n\n  /**\n   * Specify a custom hash for this asset. If `assetHashType` is set it must\n   * be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will\n   * be SHA256 hashed and encoded as hex. The resulting hash will be the asset\n   * hash.\n   *\n   * NOTE: the hash is used in order to identify a specific revision of the asset, and\n   * used for optimizing and caching deployment activities related to this asset such as\n   * packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will\n   * need to make sure it is updated every time the asset changes, or otherwise it is\n   * possible that some deployments will not be invalidated.\n   *\n   * @default - based on `assetHashType`\n   */\n  readonly assetHash?: string;\n}\n\n/**\n * Produce bundled Lambda asset code\n */\nexport function bundle(options: BundlingOptions): lambda.Code {\n  const { entry, runtime, architecture, outputPathSuffix } = options;\n\n  const stagedir = cdk.FileSystem.mkdtemp('python-bundling-');\n  const hasDeps = stageDependencies(entry, stagedir);\n\n  const depsCommand = chain([\n    hasDeps ? `rsync -r ${BUNDLER_DEPENDENCIES_CACHE}/. ${cdk.AssetStaging.BUNDLING_OUTPUT_DIR}/${outputPathSuffix}` : '',\n    `rsync -r . ${cdk.AssetStaging.BUNDLING_OUTPUT_DIR}/${outputPathSuffix}`,\n  ]);\n\n  // Determine which dockerfile to use. When dependencies are present, we use a\n  // Dockerfile that can create a cacheable layer. We can't use this Dockerfile\n  // if there aren't dependencies or the Dockerfile will complain about missing\n  // sources.\n  const dockerfile = hasDeps\n    ? 'Dockerfile.dependencies'\n    : 'Dockerfile';\n\n  // copy Dockerfile to workdir\n  fs.copyFileSync(path.join(__dirname, dockerfile), path.join(stagedir, dockerfile));\n\n  const image = cdk.DockerImage.fromBuild(stagedir, {\n    buildArgs: {\n      IMAGE: runtime.bundlingImage.image,\n    },\n    platform: architecture.dockerPlatform,\n    file: dockerfile,\n  });\n\n  return lambda.Code.fromAsset(entry, {\n    assetHashType: options.assetHashType,\n    assetHash: options.assetHash,\n    exclude: DEPENDENCY_EXCLUDES,\n    bundling: {\n      image,\n      command: ['bash', '-c', depsCommand],\n    },\n  });\n}\n\n/**\n * Checks to see if the `entry` directory contains a type of dependency that\n * we know how to install.\n */\nexport function stageDependencies(entry: string, stagedir: string): boolean {\n  const prefixes = [\n    'Pipfile',\n    'pyproject',\n    'poetry',\n    'requirements.txt',\n  ];\n\n  let found = false;\n  for (const file of fs.readdirSync(entry)) {\n    for (const prefix of prefixes) {\n      if (file.startsWith(prefix)) {\n        fs.copyFileSync(path.join(entry, file), path.join(stagedir, file));\n        found = true;\n      }\n    }\n  }\n\n  return found;\n}\n\nfunction chain(commands: string[]): string {\n  return commands.filter(c => !!c).join(' && ');\n}\n"]}

package/lib/function.d.ts

@@ -0,0 +1,91 @@
+import * as lambda from 'aws-cdk-lib/aws-lambda';
+import { AssetHashType } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+/**
+ * (experimental) Properties for a PythonFunction.
+ *
+ * @experimental
+ */
+export interface PythonFunctionProps extends lambda.FunctionOptions {
+    /**
+     * (experimental) The path to the root directory of the function.
+     *
+     * @experimental
+     */
+    readonly entry: string;
+    /**
+     * (experimental) The path (relative to entry) to the index file containing the exported handler.
+     *
+     * @default index.py
+     * @experimental
+     */
+    readonly index?: string;
+    /**
+     * (experimental) The name of the exported handler in the index file.
+     *
+     * @default handler
+     * @experimental
+     */
+    readonly handler?: string;
+    /**
+     * (experimental) The runtime environment.
+     *
+     * Only runtimes of the Python family are
+     * supported.
+     *
+     * @default lambda.Runtime.PYTHON_3_7
+     * @experimental
+     */
+    readonly runtime?: lambda.Runtime;
+    /**
+     * (experimental) Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed.
+     *
+     * If asset hash is set to `SOURCE` (default), then only changes to the source
+     * directory will cause the asset to rebuild. This means, for example, that in
+     * order to pick up a new dependency version, a change must be made to the
+     * source tree. Ideally, this can be implemented by including a dependency
+     * lockfile in your source tree or using fixed dependencies.
+     *
+     * If the asset hash is set to `OUTPUT`, the hash is calculated after
+     * bundling. This means that any change in the output will cause the asset to
+     * be invalidated and uploaded. Bear in mind that `pip` adds timestamps to
+     * dependencies it installs, which implies that in this mode Python bundles
+     * will _always_ get rebuild and uploaded. Normally this is an anti-pattern
+     * since build
+     *
+     * @default AssetHashType.SOURCE By default, hash is calculated based on the
+     * contents of the source directory. This means that only updates to the
+     * source will cause the asset to rebuild.
+     * @experimental
+     */
+    readonly assetHashType?: AssetHashType;
+    /**
+     * (experimental) Specify a custom hash for this asset.
+     *
+     * If `assetHashType` is set it must
+     * be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
+     * be SHA256 hashed and encoded as hex. The resulting hash will be the asset
+     * hash.
+     *
+     * NOTE: the hash is used in order to identify a specific revision of the asset, and
+     * used for optimizing and caching deployment activities related to this asset such as
+     * packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
+     * need to make sure it is updated every time the asset changes, or otherwise it is
+     * possible that some deployments will not be invalidated.
+     *
+     * @default - based on `assetHashType`
+     * @experimental
+     */
+    readonly assetHash?: string;
+}
+/**
+ * (experimental) A Python Lambda function.
+ *
+ * @experimental
+ */
+export declare class PythonFunction extends lambda.Function {
+    /**
+     * @experimental
+     */
+    constructor(scope: Construct, id: string, props: PythonFunctionProps);
+}