Add a new layer ("lâmina") to AWS lambda functions
Project description
Welcome to Lamina
This library adds a new layer ("lâmina") to AWS lambda functions, integrating synchronous and asynchronous code in a single function, which use Pydantic models to validate input and output data.
Install
$ pip install py-lamina
This library is compatible with Python 3.9, 3.10 and 3.11.
Usage
Create the models for Input and Output data:
# schemas.py
from pydantic import BaseModel
class ExampleInput(BaseModel):
name: str
age: int
class ExampleOutput(BaseModel):
message: str
Create your AWS Lambda handler:
# main.py
from typing import Any, Dict, Tuple, Union
from lamina import lamina, Request
from .schemas import ExampleInput, ExampleOutput
@lamina(schema=ExampleInput, schema_out=ExampleOutput)
def handler(request: Request) -> Dict[str, Any]:
response = {"message": f"Hello {request.data.name}, you are {request.data.age} years old!"}
return response
You can also use an async handler:
# main.py
import asyncio
@lamina(schema=ExampleInput, schema_out=ExampleOutput)
async def handler(request: Request) -> Dict[str, Any]:
await asyncio.sleep(1)
response = {"message": f"Hello {request.data.name}, you are {request.data.age} years old!"}
return response
The Response Status Code
Default value is 200. You can change it by returning a tuple with the response and the status code:
@lamina(schema=ExampleInput, schema_out=ExampleOutput)
def handler(request: Request) -> Tuple[Dict[str, Any], int]:
response = {"message": f"Hello {request.data.name}, you are {request.data.age} years old!"}
return response, 201
The Response Content Type
Default content type is application/json; charset=utf-8. You can change it by defining the content_type parameter:
@lamina(schema=ExampleInput, content_type=Lamina.HTML)
def handler(request: Request) -> Tuple[str, int]:
html_404 = """
<html>
<head><title>404 Not Found</title></head>
<body>
<h1>404 Not Found</h1>
</body>
</html>
"""
return html_404, 404
The Response Headers
Default header contains the Content Type defined in decorator or {"Content-Type": "application/json; charset=utf-8"}
by default.
You can add more headers it by returning a dict in the function return tuple:
@lamina(schema=ExampleInput, content_type=Lamina.HTML)
def handler(request: Request) -> str:
return None, 403, {"Location": "https://www.example.com"}
This dict will be merged with the default header.
The Request object
The Request object has the following attributes:
data: The input data, already validated by the schema.event: The original event received by the lambda function.context: The original context received by the lambda function.
You can use lamina without one or both schemas, if you like:
# main.py
import json
from typing import Any, Dict
from lamina import lamina, Request
@lamina()
def handler(request: Request) -> Dict[str, Any]:
body = request.event["body"]
data = json.loads(body)
response = {"message": f"Hello {data.name}, you are {data.age} years old!"}
return response
Please note, if you do not define a SchemaIn, the data attribute will contain the original body from event. You
need to validate it yourself and convert it to a dict, bytes, etc... you need before using the data received.
License
This project is licensed under the terms of the MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file py_lamina-2.1.1.tar.gz.
File metadata
- Download URL: py_lamina-2.1.1.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.2 tqdm/4.66.5 importlib-metadata/8.4.0 keyring/25.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 12f3b1feee99915a5e846870078f1578f7b4e8c368a8ba34a1ce5eadf414a529 |
|
| MD5 | 0351bdb6261720e9b2870e29caf1920c |
|
| BLAKE2b-256 | 8dd588fe084670a157e6ace1fa4a9947ce451f7a2b3daac223ed3b3e7e53a8cb |
File details
Details for the file py_lamina-2.1.1-py3-none-any.whl.
File metadata
- Download URL: py_lamina-2.1.1-py3-none-any.whl
- Upload date:
- Size: 5.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.2 tqdm/4.66.5 importlib-metadata/8.4.0 keyring/25.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7641a627f590ddc371388afa7611e946c167d8ff98bf44377e13713789b4cd11 |
|
| MD5 | b583646f97223d76c15ec72b472e6a6b |
|
| BLAKE2b-256 | 722398d495e107cacb814e7299f68230fcf1109bcbc99c769513a10b3bab08df |
