PEP631/621 Support + Python10 Support + DependABot update

.gitattributes

@@ -1,2 +1,2 @@
 *.js    text eol=lf
-*.json  text eol=lf
+*.json  text eol=lf

.github/workflows/validate.yml

@@ -10,8 +10,67 @@ env:
   FORCE_COLOR: 1
 
 jobs:
-  linuxNode18:
-    name: '[Linux] Node.js v18: Lint, Eventual Commitlint, Eventual Changelog, Formatting & Unit tests'
+  code_quality:
+    name: '[Linux] Node.js v18: Code Quality and formatting checks'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          # For commitlint purpose ensure to have complete list of PR commits
+          # It's loose and imperfect assumption that PR has no more than 30 commits
+          fetch-depth: 30
+
+      - name: Retrieve last master commit (for `git diff` purposes)
+        run: |
+          git checkout -b pr
+          git fetch --prune --depth=30 origin +refs/heads/master:refs/remotes/origin/master
+          git checkout master
+          git checkout pr
+
+      - name: Retrieve dependencies from cache
+        id: cacheNpm
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: npm-v18-${{ runner.os }}-${{ github.ref }}-${{ hashFiles('package.json') }}
+          restore-keys: |
+            npm-v18-${{ runner.os }}-${{ github.ref }}-
+            npm-v18-${{ runner.os }}-refs/heads/master-
+
+      - name: Install Node.js and npm
+        uses: actions/setup-node@v1
+        with:
+          node-version: 18.x
+
+      - name: Install dependencies
+        if: steps.cacheNpm.outputs.cache-hit != 'true'
+        run: |
+          npm update --no-save
+          npm update --save-dev --no-save
+
+      - name: Validate Prettier formatting
+        run: npm run prettier-check:updated
+
+      - name: Validate ESLint rules
+        run: npm run lint:updated
+
+      - name: Validate commit messages
+        if: github.event.pull_request.base.repo.id == github.event.pull_request.head.repo.id
+        run: npx commitlint -f master
+
+      - name: Validate changelog (if new version)
+        run: |
+          NEW_VERSION=`git diff -U0 master package.json | grep '"version": "' | tail -n 1 | grep -oE "[0-9]+\.[0-9]+\.[0-9]+"` || :
+          if [ -n "$NEW_VERSION" ];
+          then
+            npx dump-release-notes-from-cc-changelog $NEW_VERSION
+          fi
+
+  unit_tests:
+    name: '[Linux] Node.js v18: Unit tests'
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -43,10 +102,10 @@ jobs:
             npm-v18-${{ runner.os }}-${{ github.ref }}-
             npm-v18-${{ runner.os }}-refs/heads/master-
 
-      - name: Set up Python 3.9
+      - name: Set up Python 3.10
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: '3.10'
 
       - name: Install Node.js and npm
         uses: actions/setup-node@v1
@@ -71,19 +130,6 @@ jobs:
         run: |
           npm update --no-save
           npm update --save-dev --no-save
-      - name: Validate Prettier formatting
-        run: npm run prettier-check:updated
-      - name: Validate ESLint rules
-        run: npm run lint:updated
-      - name: Validate commit messages
-        if: github.event.pull_request.base.repo.id == github.event.pull_request.head.repo.id
-        run: npx commitlint -f master
-      - name: Validate changelog (if new version)
-        run: |
-          NEW_VERSION=`git diff -U0 master package.json | grep '"version": "' | tail -n 1 | grep -oE "[0-9]+\.[0-9]+\.[0-9]+"` || :
-          if [ -n "$NEW_VERSION" ];
-          then
-            npx dump-release-notes-from-cc-changelog $NEW_VERSION
-          fi
+
       - name: Unit tests
         run: npm test

.gitignore

@@ -42,6 +42,7 @@ admin.env
 #PYTHON STUFF
 *.py[co]
 __pycache__
+.venv
 
 #NODE STUFF
 package-lock.json
@@ -66,6 +67,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+tests/base/.requirements-cache
 
 # Serverless directories
 .serverless

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    rev: v8.56.0
+    hooks:
+      - id: eslint
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+        types_or: [css, javascript, html, json, markdown, yaml]
+        args: [--semi, --single-quote, --trailing-comma, all]
+        verbose: true

.python-version

@@ -1 +1 @@
-3.9
+3.10

CONTRIBUTING.md

@@ -14,8 +14,8 @@ Welcome, and thanks in advance for your help!
 
 Pre-Reqs:
 
-- Python 3.9
-- [poetry](https://python-poetry.org/docs/) (if you use multiple versions of Python be sure to install it with python 3.9)
+- Python 3.10
+- [poetry](https://python-poetry.org/docs/) (if you use multiple versions of Python be sure to install it with python 3.10)
 - Perl (used in the tests)
 - Node v14 or v16
 

README.md

@@ -160,21 +160,53 @@ Instead of:
 
 ```toml
 [tool.poetry.dependencies]
-bottle = {git = "[email protected]/bottlepy/bottle.git", tag = "0.12.16"}
+bottle = {git = "[email protected]/bottlepy/bottle.git", tag = "0.12.25"}
 ```
 
 Use:
 
 ```toml
 [tool.poetry.dependencies]
-bottle = {git = "https://[email protected]/bottlepy/bottle.git", tag = "0.12.16"}
+bottle = {git = "https://[email protected]/bottlepy/bottle.git", tag = "0.12.25"}
 ```
 
 Or, if you have an SSH key configured:
 
 ```toml
 [tool.poetry.dependencies]
-bottle = {git = "ssh://[email protected]/bottlepy/bottle.git", tag = "0.12.16"}
+bottle = {git = "ssh://[email protected]/bottlepy/bottle.git", tag = "0.12.25"}
+```
+
+## :sparkles::snake::sparkles: PyProject PEP631/621
+
+If you include a `pyproject.toml` and have `dependencies` installed instead of a `requirements.txt` this will
+generate a requirements file from it. It is fully compatible with all options such as `zip` and
+`dockerizePip`. If you don't want this plugin to generate it for you, set the following option:
+
+```yaml
+custom:
+  pythonRequirements:
+    usePyProject: false
+```
+
+If your PyProject configuration includes custom dependency groups, they will not be installed automatically. To include them in the deployment package, use the `pyprojectWithGroups`.
+
+```yaml
+custom:
+  pythonRequirements:
+    pyprojectWithGroups:
+      - internal_dependencies
+      - lambda_dependencies
+```
+
+## :sparkles::snake::sparkles: Custom Python Package installation
+
+If your function rely on your code being installed as a python package use `installFolderAsPackage`. Ensure your code is structured as a python package or otherwise it will not be installed correctly (`pip install .`)
+
+```yaml
+custom:
+  pythonRequirements:
+    installFolderAsPackage: true
 ```
 
 ## Dealing with Lambda's size limitations
@@ -285,7 +317,7 @@ custom:
       name: ${self:provider.stage}-layerName
       description: Python requirements lambda layer
       compatibleRuntimes:
-        - python3.7
+        - python3.10
       licenseInfo: GPLv3
       allowedAccounts:
         - '*'
@@ -515,7 +547,7 @@ For usage of `dockerizePip` on Windows do Step 1 only if running serverless on w
 Some Python packages require extra OS dependencies to build successfully. To deal with this, replace the default image with a `Dockerfile` like:
 
 ```dockerfile
-FROM public.ecr.aws/sam/build-python3.9
+FROM public.ecr.aws/sam/build-python3.10
 
 # Install your dependencies
 RUN yum -y install mysql-devel
@@ -602,7 +634,7 @@ To handle native dependencies, it's recommended to use the Docker builder with t
 custom:
   pythonRequirements:
     # Can use any Python version supported by Scaleway
-    dockerImage: rg.fr-par.scw.cloud/scwfunctionsruntimes-public/python-dep:3.11
+    dockerImage: rg.fr-par.scw.cloud/scwfunctionsruntimes-public/python-dep:3.10
 ```
 
 ## Contributors
@@ -635,6 +667,8 @@ custom:
   - [@drice](https://github.com/drice)
   - [@ofercaspi](https://github.com/ofercaspi)
   - [@tpansino](https://github.com/tpansino)
+- PyProject PEP631/621
+  - [@jax-b](https://github.com/jax-b)
 - [@david-mk-lawrence](https://github.com/david-mk-lawrence) - added Lambda Layer support
 - [@bryantbriggs](https://github.com/bryantbiggs) - Fixing CI/CD
 - [@jacksgt](https://github.com/jacksgt) - Fixing pip issues

example/serverless.yml

@@ -2,7 +2,7 @@ service: sls-py-req-test
 
 provider:
   name: aws
-  runtime: python3.9
+  runtime: python3.10
 
 plugins:
   - serverless-python-requirements

example_native_deps/requirements.txt

@@ -1,3 +1,3 @@
 numpy==1.13.3
 scipy==1.0.0
-sklearn==0.0
+sklearn==0.0

example_native_deps/serverless.yml

@@ -2,7 +2,7 @@ service: sls-py-req-test
 
 provider:
   name: aws
-  runtime: python3.9
+  runtime: python3.10
 
 plugins:
   - serverless-python-requirements

index.js

@@ -61,10 +61,13 @@ class ServerlessPythonRequirements {
         poetryWithGroups: [],
         poetryWithoutGroups: [],
         poetryOnlyGroups: [],
+        usePyProject: true,
+        pyprojectWithGroups: [],
+        installFolderAsPackage: false,
       },
       (this.serverless.service.custom &&
         this.serverless.service.custom.pythonRequirements) ||
-        {}
+        {},
     );
     if (
       options.pythonBin === this.serverless.service.provider.runtime &&
@@ -92,19 +95,19 @@ class ServerlessPythonRequirements {
       if (!this.warningLogged) {
         if (this.log) {
           this.log.warning(
-            'You provided a docker related option but dockerizePip is set to false.'
+            'You provided a docker related option but dockerizePip is set to false.',
           );
         } else {
           this.serverless.cli.log(
-            'WARNING: You provided a docker related option but dockerizePip is set to false.'
+            'WARNING: You provided a docker related option but dockerizePip is set to false.',
           );
         }
         this.warningLogged = true;
       }
     }
     if (options.dockerImage && options.dockerFile) {
       throw new Error(
-        'Python Requirements: you can provide a dockerImage or a dockerFile option, not both.'
+        'Python Requirements: you can provide a dockerImage or a dockerFile option, not both.',
       );
     }
 
@@ -241,8 +244,8 @@ class ServerlessPythonRequirements {
         .then(() =>
           injectAllRequirements.bind(this)(
             arguments[1].functionObj &&
-              arguments[1].functionObj.package.artifact
-          )
+              arguments[1].functionObj.package.artifact,
+          ),
         );
     };
 

lib/clean.js

@@ -26,8 +26,8 @@ function cleanup() {
 
   return BbPromise.all(
     artifacts.map((artifact) =>
-      fse.removeAsync(path.join(this.servicePath, artifact))
-    )
+      fse.removeAsync(path.join(this.servicePath, artifact)),
+    ),
   );
 }
 
@@ -58,7 +58,7 @@ function cleanupCache() {
         promises.push(fse.removeAsync(file));
       });
     return BbPromise.all(promises).finally(
-      () => cleanupProgress && cleanupProgress.remove()
+      () => cleanupProgress && cleanupProgress.remove(),
     );
   } else {
     if (this.serverless) {

lib/docker.js

@@ -20,7 +20,7 @@ async function dockerCommand(options, pluginInstance) {
     ) {
       throw new pluginInstance.serverless.classes.Error(
         'docker not found! Please install it.',
-        'PYTHON_REQUIREMENTS_DOCKER_NOT_FOUND'
+        'PYTHON_REQUIREMENTS_DOCKER_NOT_FOUND',
       );
     }
     throw e;
@@ -42,7 +42,7 @@ async function buildImage(dockerFile, extraArgs, pluginInstance) {
   } else {
     throw new pluginInstance.serverless.classes.Error(
       'dockerRunCmdExtraArgs option must be an array',
-      'PYTHON_REQUIREMENTS_INVALID_DOCKER_EXTRA_ARGS'
+      'PYTHON_REQUIREMENTS_INVALID_DOCKER_EXTRA_ARGS',
     );
   }
 
@@ -72,7 +72,7 @@ function findTestFile(servicePath, pluginInstance) {
   }
   throw new pluginInstance.serverless.classes.Error(
     'Unable to find serverless.{yml|yaml|json} or requirements.txt for getBindPath()',
-    'PYTHON_REQUIREMENTS_MISSING_GET_BIND_PATH_FILE'
+    'PYTHON_REQUIREMENTS_MISSING_GET_BIND_PATH_FILE',
   );
 }