Add support for additional Python Lambda handler filenames

changelog.md

@@ -2,6 +2,15 @@
 
 ---
 
+## [3.6.0] 2023-08-02
+
+### Added
+
+- Added support for additional Python Lambda handler filenames, including `lambda.py`, `handler.py`, and `__main__.py`
+  - Architect's legacy `index.py` root filename remains
+
+---
+
 ## [3.5.7] 2023-07-09
 
 ### Changed

src/config/pragmas/populate-lambda/get-handler.js

@@ -41,6 +41,7 @@ let nodeHandlers = [ 'index.js', 'index.mjs', 'index.cjs' ]
 let denoHandlers = [ 'mod.ts', 'mod.js' ]
   // TODO: these are all prob going away
   .concat([ 'mod.tsx', 'index.ts', 'index.js', 'index.tsx' ])
+let snekHandlers = [ 'lambda.py', 'handler.py', '__main__.py', 'index.py' ]
 
 function getExt ({ runtime, src, errors }) {
   try {
@@ -71,7 +72,10 @@ function getExt ({ runtime, src, errors }) {
       }
       return { file, ext, handlerModuleSystem }
     }
-    if (runtime.startsWith('python')) return { ext: 'py' }
+    if (runtime.startsWith('python')) {
+      let { file = 'lambda', ext = 'py' } = findHandler(snekHandlers, src)
+      return { file, ext }
+    }
     if (runtime.startsWith('ruby')) return { ext: 'rb' }
     if (runtime.startsWith('deno')) {
       let { file = 'mod', ext = 'ts' } = findHandler(denoHandlers, src)

test/unit/src/config/pragmas/populate-lambda/get-handler-test.js

@@ -25,8 +25,8 @@ test('Set up env', t => {
 })
 
 test('Handler properties (built-in runtimes)', t => {
-  t.plan(20)
-  let config, errors, result
+  t.plan(32)
+  let config, errors, pythonHandler, result
 
   // Defaults to Node.js
   config = defaultFunctionConfig()
@@ -50,11 +50,60 @@ test('Handler properties (built-in runtimes)', t => {
   // Python
   config = defaultFunctionConfig()
   errors = []
+  pythonHandler = 'lambda.py'
+  config.runtime = 'python3.8'
+  result = getHandler({ config, src, errors })
+  t.notOk(errors.length, 'Did not get handler errors')
+  t.equal(result.handlerFile, srcPath(pythonHandler), `Got correct handlerFile: ${result.handlerFile}`)
+  t.equal(result.handlerMethod, handler, `Got correct handlerMethod: ${result.handlerMethod}`)
+
+  // Verify priority of the updated default handler name
+  config = defaultFunctionConfig()
+  errors = []
+  mockFs({ [src]: {
+    [pythonHandler]: 'hi',
+    'index.py': 'hi',
+  } })
+  config.runtime = 'python3.8'
+  result = getHandler({ config, src, errors })
+  t.notOk(errors.length, 'Did not get handler errors')
+  t.equal(result.handlerFile, srcPath(pythonHandler), `Got correct handlerFile: ${result.handlerFile}`)
+  t.equal(result.handlerMethod, handler, `Got correct handlerMethod: ${result.handlerMethod}`)
+  mockFs.restore()
+
+  config = defaultFunctionConfig()
+  errors = []
+  pythonHandler = 'handler.py'
+  mockFs(fakeFile(pythonHandler))
   config.runtime = 'python3.8'
   result = getHandler({ config, src, errors })
   t.notOk(errors.length, 'Did not get handler errors')
-  t.equal(result.handlerFile, srcPath(`${file}.py`), `Got correct handlerFile: ${result.handlerFile}`)
+  t.equal(result.handlerFile, srcPath(pythonHandler), `Got correct handlerFile: ${result.handlerFile}`)
   t.equal(result.handlerMethod, handler, `Got correct handlerMethod: ${result.handlerMethod}`)
+  mockFs.restore()
+
+  config = defaultFunctionConfig()
+  errors = []
+  pythonHandler = '__main__.py'
+  mockFs(fakeFile(pythonHandler))
+  config.runtime = 'python3.8'
+  result = getHandler({ config, src, errors })
+  t.notOk(errors.length, 'Did not get handler errors')
+  t.equal(result.handlerFile, srcPath(pythonHandler), `Got correct handlerFile: ${result.handlerFile}`)
+  t.equal(result.handlerMethod, handler, `Got correct handlerMethod: ${result.handlerMethod}`)
+  mockFs.restore()
+
+  // Old school Architect default
+  config = defaultFunctionConfig()
+  errors = []
+  pythonHandler = 'index.py'
+  mockFs(fakeFile(pythonHandler))
+  config.runtime = 'python3.8'
+  result = getHandler({ config, src, errors })
+  t.notOk(errors.length, 'Did not get handler errors')
+  t.equal(result.handlerFile, srcPath(pythonHandler), `Got correct handlerFile: ${result.handlerFile}`)
+  t.equal(result.handlerMethod, handler, `Got correct handlerMethod: ${result.handlerMethod}`)
+  mockFs.restore()
 
   // Ruby
   config = defaultFunctionConfig()