aws-lambda-builders 1.56.0__tar.gz → 1.58.0__tar.gz

{aws_lambda_builders-1.56.0/aws_lambda_builders.egg-info → aws_lambda_builders-1.58.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws_lambda_builders
-Version: 1.56.0
+Version: 1.58.0
 Summary: Python library to compile, build & package AWS Lambda functions for several runtimes & frameworks.
 Home-page: https://github.com/awslabs/aws-lambda-builders
 Author: Amazon Web Services
@@ -33,7 +33,7 @@ Provides-Extra: dev
 Requires-Dist: coverage==7.9.2; python_version >= "3.9" and extra == "dev"
 Requires-Dist: coverage==7.6.1; python_version < "3.9" and extra == "dev"
 Requires-Dist: flake8==3.8.4; extra == "dev"
-Requires-Dist: pytest-cov==6.1.1; python_version >= "3.9" and extra == "dev"
+Requires-Dist: pytest-cov==6.2.1; python_version >= "3.9" and extra == "dev"
 Requires-Dist: pytest-cov==5.0.0; python_version < "3.9" and extra == "dev"
 Requires-Dist: pytest>=6.1.1; extra == "dev"
 Requires-Dist: parameterized==0.9.0; extra == "dev"

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/__init__.py

@@ -5,5 +5,5 @@ AWS Lambda Builder Library
 # Changing version will trigger a new release!
 # Please make the version change as the last step of your development.
 
-__version__ = "1.56.0"
+__version__ = "1.58.0"
 RPC_PROTOCOL_VERSION = "0.3"

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/builder.py

@@ -105,7 +105,7 @@ class LambdaBuilder(object):
 
         :type options: dict
         :param options:
-            Optional dictionary of options ot pass to build action. **Not supported**.
+            Optional dictionary of options to pass to build action.
 
         :type executable_search_paths: list
         :param executable_search_paths:

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/workflow.py

@@ -227,7 +227,7 @@ class BaseWorkflow(object, metaclass=_WorkflowMetaClass):
         optimizations : dict, optional
             dictionary of optimization flags to pass to the build action. **Not supported**, by default None
         options : dict, optional
-            dictionary of options ot pass to build action. **Not supported**., by default None
+            dictionary of options to pass to build action. By default None
         mode : str, optional
             Mode the build should produce, by default BuildMode.RELEASE
         download_dependencies: bool, optional

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/workflows/java_gradle/gradle.py

@@ -30,10 +30,10 @@ class SubprocessGradle(object):
         self.os_utils = os_utils
 
     def build(self, source_dir, build_file, cache_dir=None, init_script_path=None, properties=None):
+        ## Note: build_file parameter is not supported anymore, but kept for backward compatibility
         if not self.os_utils.exists(build_file):
             raise BuildFileNotFoundError(build_file)
-
-        args = ["build", "--build-file", build_file]
+        args = ["build"]
         if cache_dir is not None:
             args.extend(["--project-cache-dir", cache_dir])
         if properties is not None:

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/workflows/java_gradle/resources/lambda-build-init.gradle

@@ -54,7 +54,8 @@ def assertExpectedBuildDir(p) {
 }
 
 def createArtifactDir(project) {
-    def distsDir = project.buildDir.toPath().resolve(project.distsDirName).resolve('lambda-build')
+    // In Gradle 9, distsDirName was removed. Use 'distributions' as the default directory name
+    def distsDir = project.buildDir.toPath().resolve('distributions').resolve('lambda-build')
     return makeDirs(distsDir)
 }
 

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/workflows/python_pip/DESIGN.md

@@ -147,3 +147,47 @@ bundle has an `__init__.py` and is on the `PYTHONPATH`.
 The dependencies should now be succesfully installed in the target directory.
 All the temporary/intermediate files can now be deleting including all the
 wheel files and sdists.
+
+### Configuring the builder
+
+The Lambda builder supports the following optional sub-properties of the `aws_sam` configuration property.
+
+#### `parent_python_packages`
+
+`parent_python_packages` must be a string, corresponding to a dot-separated list of parent packages to create in the destination directory. This is useful when the source code has a package structure that needs to be preserved in the built artifacts.
+
+For example, if your source code is structured like this:
+
+```
+├── app
+|   ├── main.py
+|   └── utils
+|       └── logger.py
+└── tests
+    └── unit/test_handler.py
+```
+
+Then the SAM build output will look like this:
+
+```
+└── .aws-sam
+    └── build
+       └── AppLogicalId
+          ├── main.py
+          └── utils
+                └── logger.py
+```
+
+The tests would break because `main.py` is importing `logger` as `from .utils import logger`, but the built artifacts would not have the `app` package.
+
+To fix this, you can set the `parent_python_packages` property to `app` and the SAM build output will look like this:
+
+```
+└── .aws-sam
+    └── build
+       └── AppLogicalId
+          └── app
+              ├── main.py
+              └── utils
+                    └── logger.py
+```

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/workflows/python_pip/actions.py

@@ -3,6 +3,7 @@ Action to resolve Python dependencies using PIP
 """
 
 import logging
+from pathlib import Path
 from typing import Optional, Tuple
 
 from aws_lambda_builders.actions import ActionFailedError, BaseAction, Purpose
@@ -21,6 +22,8 @@ from aws_lambda_builders.workflows.python_pip.utils import OSUtils
 
 LOG = logging.getLogger(__name__)
 
+PARENT_PYTHON_PKGS_KEY = "parent_python_packages"
+
 
 class PythonPipBuildAction(BaseAction):
     NAME = "ResolveDependencies"
@@ -115,3 +118,49 @@ class PythonPipBuildAction(BaseAction):
                 LOG.debug(f"Python runtime path '{python_path}' does not contain pip")
 
         raise ActionFailedError("Failed to find a Python runtime containing pip on the PATH.")
+
+
+class PythonCreateParentPackagesAction(BaseAction):
+    NAME = "CreateParentPackages"
+    DESCRIPTION = "Creating parent Python packages"
+    PURPOSE = Purpose.COPY_SOURCE
+    LANGUAGE = "python"
+
+    def __init__(self, source_dir, dest_dir, options=None):
+        self.source_dir = source_dir
+        self.dest_dir = dest_dir
+        self.options = options or {}
+
+    def execute(self):
+        pkg_parts = self._get_parent_python_packages()
+        if not pkg_parts:
+            return
+
+        source_path = Path(self.source_dir)
+        dest_path = Path(self.dest_dir)
+
+        target_pkg_path = dest_path.joinpath(*pkg_parts)
+        try:
+            target_pkg_path.mkdir(parents=True, exist_ok=False)
+        except FileExistsError:
+            LOG.warning("Skipping creating package %s as it would overwrite existing folder", target_pkg_path)
+            return
+
+        for item in source_path.glob(pattern="*"):
+            if (dest_path / item.name).exists():
+                (dest_path / item.name).rename(target_pkg_path / item.name)
+            else:
+                LOG.debug(f"{item} does not exist in the build path, skipping.")
+
+    def _get_parent_python_packages(self) -> Optional[list]:
+        """
+        Returns the parent Python packages to be created.
+        """
+        if not isinstance(self.options, dict):
+            return None
+
+        parent_python_pkgs = self.options.get(PARENT_PYTHON_PKGS_KEY)
+        if isinstance(parent_python_pkgs, str) and len(parent_python_pkgs) > 0:
+            return parent_python_pkgs.split(".")
+
+        return None

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders/workflows/python_pip/workflow.py

@@ -9,7 +9,7 @@ from aws_lambda_builders.path_resolver import PathResolver
 from aws_lambda_builders.workflow import BaseWorkflow, BuildDirectory, BuildInSourceSupport, Capability
 from aws_lambda_builders.workflows.python_pip.validator import PythonRuntimeValidator
 
-from .actions import PythonPipBuildAction
+from .actions import PARENT_PYTHON_PKGS_KEY, PythonCreateParentPackagesAction, PythonPipBuildAction
 from .utils import OSUtils, is_experimental_build_improvements_enabled
 
 LOG = logging.getLogger(__name__)
@@ -87,15 +87,15 @@ class PythonPipWorkflow(BaseWorkflow):
         self.actions = []
         if not osutils.file_exists(manifest_path):
             LOG.warning("requirements.txt file not found. Continuing the build without dependencies.")
-            self.actions.append(CopySourceAction(source_dir, artifacts_dir, excludes=self.EXCLUDED_FILES))
+            self._actions.append(CopySourceAction(source_dir, artifacts_dir, excludes=self.EXCLUDED_FILES))
             return
 
         # If a requirements.txt exists, run pip builder before copy action.
         if self.download_dependencies:
             if self.dependencies_dir:
                 # clean up the dependencies folder before installing
-                self.actions.append(CleanUpAction(self.dependencies_dir))
-            self.actions.append(
+                self._actions.append(CleanUpAction(self.dependencies_dir))
+            self._actions.append(
                 PythonPipBuildAction(
                     artifacts_dir,
                     scratch_dir,
@@ -113,11 +113,25 @@ class PythonPipWorkflow(BaseWorkflow):
             # when copying downloaded dependencies back to artifacts folder, don't exclude anything
             # symlinking python dependencies is disabled for now since it is breaking sam local commands
             if False and is_experimental_build_improvements_enabled(self.experimental_flags):
-                self.actions.append(LinkSourceAction(self.dependencies_dir, artifacts_dir))
+                self._actions.append(LinkSourceAction(self.dependencies_dir, artifacts_dir))
             else:
-                self.actions.append(CopySourceAction(self.dependencies_dir, artifacts_dir))
+                self._actions.append(CopySourceAction(self.dependencies_dir, artifacts_dir))
 
-        self.actions.append(CopySourceAction(source_dir, artifacts_dir, excludes=self.EXCLUDED_FILES))
+        self._actions.append(CopySourceAction(source_dir, artifacts_dir, excludes=self.EXCLUDED_FILES))
+
+    @property
+    def actions(self):
+        """
+        Returns the list of actions to be executed in this workflow.
+        If required, creating the parent package(s) must be executed last.
+        """
+        if self._should_create_parent_packages():
+            return self._actions + [PythonCreateParentPackagesAction(self.source_dir, self.artifacts_dir, self.options)]
+        return self._actions
+
+    @actions.setter
+    def actions(self, value):
+        self._actions = value
 
     def get_resolvers(self):
         """
@@ -138,5 +152,13 @@ class PythonPipWorkflow(BaseWorkflow):
         major, _ = self.runtime.replace(self.CAPABILITY.language, "").split(".")
         return [f"{self.CAPABILITY.language}{major}"] if major == self.PYTHON_VERSION_THREE else None
 
+    def _should_create_parent_packages(self):
+        """
+        Determines if the parent package(s) should be created based on the options provided.
+        """
+        if isinstance(self.options, dict):
+            return PARENT_PYTHON_PKGS_KEY in self.options
+        return False
+
     def get_validators(self):
         return [PythonRuntimeValidator(runtime=self.runtime, architecture=self.architecture)]

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0/aws_lambda_builders.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws_lambda_builders
-Version: 1.56.0
+Version: 1.58.0
 Summary: Python library to compile, build & package AWS Lambda functions for several runtimes & frameworks.
 Home-page: https://github.com/awslabs/aws-lambda-builders
 Author: Amazon Web Services
@@ -33,7 +33,7 @@ Provides-Extra: dev
 Requires-Dist: coverage==7.9.2; python_version >= "3.9" and extra == "dev"
 Requires-Dist: coverage==7.6.1; python_version < "3.9" and extra == "dev"
 Requires-Dist: flake8==3.8.4; extra == "dev"
-Requires-Dist: pytest-cov==6.1.1; python_version >= "3.9" and extra == "dev"
+Requires-Dist: pytest-cov==6.2.1; python_version >= "3.9" and extra == "dev"
 Requires-Dist: pytest-cov==5.0.0; python_version < "3.9" and extra == "dev"
 Requires-Dist: pytest>=6.1.1; extra == "dev"
 Requires-Dist: parameterized==0.9.0; extra == "dev"

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/aws_lambda_builders.egg-info/requires.txt

@@ -15,5 +15,5 @@ black==24.8.0
 
 [dev:python_version >= "3.9"]
 coverage==7.9.2
-pytest-cov==6.1.1
+pytest-cov==6.2.1
 black==25.1.0

{aws_lambda_builders-1.56.0 → aws_lambda_builders-1.58.0}/requirements/dev.txt

@@ -1,7 +1,7 @@
 coverage==7.9.2; python_version>="3.9"
 coverage==7.6.1; python_version<"3.9"
 flake8==3.8.4
-pytest-cov==6.1.1; python_version>="3.9"
+pytest-cov==6.2.1; python_version>="3.9"
 pytest-cov==5.0.0; python_version<"3.9"
 
 # Test requirements