Merge pull request #20 from odd12258053/auto_detect_service

Allow calling without no service to `Agraffe.entry_point`.

Author: odd12258053

README.md

@@ -8,12 +8,15 @@ Agraffe, build API with ASGI in Serverless services (e.g AWS lambda, Google Clou
 
 ## Support Services
 - [x] Google Cloud Functions
+  - Python 3.7, 3.8, 3.9, 3.10, 3.11(preview)
 - [x] AWS lambda (with API Gateway HTTP API or REST API, or with Function URL)
+  - Python 3.7, 3.8, 3.9
 - [x] Azure Functions
+  - Python 3.7, 3.8, 3.9, 3.10(preview)
 
 ## Requirements
 
-Python 3.7, 3.8, 3.9
+Python 3.7+
 
 ## Installation
 ```sh
@@ -26,9 +29,7 @@ Create it
 - Create a file `main.py` with:
 
 ```python
-from agraffe import Agraffe, Service
-
-from typing import Optional
+from agraffe import Agraffe
 
 from fastapi import FastAPI
 
@@ -41,13 +42,13 @@ def read_root():
 
 
 @app.get("/items/{item_id}")
-def read_item(item_id: int, q: Optional[str] = None):
+def read_item(item_id: int, q: str | None = None):
     return {"item_id": item_id, "q": q}
 
-entry_point = Agraffe.entry_point(app, Service.google_cloud_functions)
+entry_point = Agraffe.entry_point(app)
 ```
 ```python
-# or
+# or, for on GCP
 from agraffe.services.google_cloud_functions import HttpCycle
 
 def entry_point(request):
@@ -59,8 +60,10 @@ Deploy it
 - Deploy the api with:
 
 ```sh
-$ gcloud functions deploy {FUNCTION NAME} --entry-point entry_point --runtime python37 --trigger-http --allow-unauthenticated
+$ gcloud functions deploy {FUNCTION NAME} --entry-point entry_point --runtime python310 --trigger-http --allow-unauthenticated
 ```
 
+See `/example` for other services.
+
 ## License
 This project is licensed under the terms of the MIT license.

agraffe/__init__.py

@@ -1,22 +1,17 @@
 """ Agraffe, build API with ASGI in Serverless services (e.g AWS lambda, Google Cloud Functions and Azure Functions). """  # noqa: E501
 
-__version__ = "0.5.0"
+__version__ = "0.6.0"
 
 import asyncio
-from enum import Enum
 from typing import Any, Callable, Type, Union
 
+from .services import Service
 from .types import ASGIApp, ASGICycle
-
-
-class Service(str, Enum):
-    google_cloud_functions = 'Google Cloud Functions'
-    aws_lambda = 'AWS Lambda'
-    azure_functions = 'Azure Functions'
+from .utils import find_service
 
 
 class Agraffe:
-    def __init__(self, app: ASGIApp, http_cycle: Type[ASGICycle]):
+    def __init__(self, app: ASGIApp, http_cycle: Type[ASGICycle]) -> None:
         self.app = app
         self._http_cycle = http_cycle
         loop = asyncio.new_event_loop()
@@ -29,8 +24,11 @@ def __call__(self, request: Any) -> Any:
 
     @classmethod
     def entry_point(
-        cls, app: ASGIApp, service: Union[str, Service]
+        cls, app: ASGIApp, service: Union[str, Service, None] = None
     ) -> Callable[..., Any]:
+        if service is None:
+            service = find_service()
+
         if service == Service.google_cloud_functions:
             from .services.google_cloud_functions import HttpCycle as GCPHttpCycle
 

agraffe/services/__init__.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class Service(str, Enum):
+    google_cloud_functions = 'Google Cloud Functions'
+    aws_lambda = 'AWS Lambda'
+    azure_functions = 'Azure Functions'

agraffe/utils.py

@@ -0,0 +1,23 @@
+import os
+import sys
+from typing import Union
+
+from .services import Service
+
+
+def find_service() -> Union[Service, None]:
+    # ref: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html
+    if 'AWS_LAMBDA_FUNCTION_NAME' in os.environ:
+        return Service.aws_lambda
+
+    # ref: https://learn.microsoft.com/en-us/azure/azure-functions/functions-app-settings  # noqa: 501
+    if 'FUNCTIONS_WORKER_RUNTIME' in os.environ:
+        return Service.azure_functions
+
+    # ref: https://cloud.google.com/functions/docs/configuring/env-var#newer_runtimes
+    if sys.version_info >= (3, 8) and 'FUNCTION_TARGET' in os.environ:
+        return Service.google_cloud_functions
+    elif 'GCP_PROJECT' in os.environ and 'FUNCTION_NAME' in os.environ:
+        return Service.google_cloud_functions
+
+    return None

example/aws/.gitignore

@@ -1,6 +1,3 @@
-node_modules/
 agraffe/
-.serverless/
-package-lock.json
 samconfig.toml
 .aws-sam/

example/aws/src/main.py

@@ -1,8 +1,6 @@
-import os
-
 from agraffe import Agraffe
 
 from app import app
 
 
-entry_point = Agraffe.entry_point(app, os.environ['AgraffeService'])
+entry_point = Agraffe.entry_point(app)

example/aws/src/requirements.txt

@@ -1,6 +1,5 @@
-fastapi==0.68.1
-pydantic==1.8.2
-starlette==0.14.2
-typing-extensions==3.7.4.3
-python-multipart==0.0.5
-agraffe==0.5.0
+fastapi
+pydantic
+typing-extensions
+python-multipart
+agraffe>=0.6.0

example/aws/template_api.yaml

@@ -10,9 +10,6 @@ Resources:
       Handler: main.entry_point
       MemorySize: 256
       Timeout: 30
-      Environment:
-        Variables:
-          AgraffeService: AWS Lambda
       Events:
         Index:
           Type: Api

example/aws/template_function_url.yaml

@@ -12,6 +12,3 @@ Resources:
       Timeout: 30
       FunctionUrlConfig:
         AuthType: NONE
-      Environment:
-        Variables:
-          AgraffeService: AWS Lambda

example/aws/template_httpapi.yaml

@@ -10,9 +10,6 @@ Resources:
       Handler: main.entry_point
       MemorySize: 256
       Timeout: 30
-      Environment:
-        Variables:
-          AgraffeService: AWS Lambda
       Events:
         Index:
           Type: HttpApi