functions-framework 3.8.3__tar.gz → 3.9.0__tar.gz

{functions_framework-3.8.3 → functions_framework-3.9.0}/PKG-INFO

@@ -1,7 +1,9 @@
 Metadata-Version: 2.4
 Name: functions-framework
-Version: 3.8.3
+Version: 3.9.0
 Summary: An open source FaaS (Function as a service) framework for writing portable Python functions -- brought to you by the Google Cloud Functions team.
+Home-page: https://github.com/googlecloudplatform/functions-framework-python
+Author: Google LLC
 Author-email: Google LLC <googleapis-packages@google.com>
 Maintainer-email: Google LLC <googleapis-packages@google.com>
 License: Apache-2.0
@@ -15,16 +17,23 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: <4,>=3.5
+Requires-Python: >=3.5, <4
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: flask<4.0,>=2.0
 Requires-Dist: click<9.0,>=7.0
 Requires-Dist: watchdog>=1.0.0
 Requires-Dist: gunicorn>=22.0.0; platform_system != "Windows"
-Requires-Dist: cloudevents<2.0.0,>=1.2.0
+Requires-Dist: cloudevents<=1.11.0,>=1.2.0
 Requires-Dist: Werkzeug<4.0.0,>=0.14
+Requires-Dist: httpx>=0.24.1
+Requires-Dist: starlette<1.0.0,>=0.37.0; python_version >= "3.8"
+Requires-Dist: uvicorn<1.0.0,>=0.18.0; python_version >= "3.8"
+Requires-Dist: uvicorn-worker<1.0.0,>=0.2.0; python_version >= "3.8"
+Dynamic: author
+Dynamic: home-page
 Dynamic: license-file
+Dynamic: requires-python
 
 # Functions Framework for Python
 

{functions_framework-3.8.3 → functions_framework-3.9.0}/pyproject.toml

@@ -1,17 +1,15 @@
 [project]
 name = "functions-framework"
-version = "3.8.3"
+version = "3.9.0"
 description = "An open source FaaS (Function as a service) framework for writing portable Python functions -- brought to you by the Google Cloud Functions team."
 readme = "README.md"
-requires-python = ">=3.5, <4"
+requires-python = ">=3.7, <4"
 # Once we drop support for Python 3.7 and 3.8, this can become
 # license = "Apache-2.0"
-license = {text = "Apache-2.0"}
-authors = [
-  { name = "Google LLC", email = "googleapis-packages@google.com" }
-]
+license = { text = "Apache-2.0" }
+authors = [{ name = "Google LLC", email = "googleapis-packages@google.com" }]
 maintainers = [
-  { name = "Google LLC", email = "googleapis-packages@google.com" }
+  { name = "Google LLC", email = "googleapis-packages@google.com" },
 ]
 keywords = ["functions-framework"]
 classifiers = [
@@ -29,8 +27,12 @@ dependencies = [
   "click>=7.0,<9.0",
   "watchdog>=1.0.0",
   "gunicorn>=22.0.0; platform_system!='Windows'",
-  "cloudevents>=1.2.0,<2.0.0",
+  "cloudevents>=1.2.0,<=1.11.0",                  # Must support python 3.7
   "Werkzeug>=0.14,<4.0.0",
+  "httpx>=0.24.1",
+  "starlette>=0.37.0,<1.0.0; python_version>='3.8'",
+  "uvicorn>=0.18.0,<1.0.0; python_version>='3.8'",
+  "uvicorn-worker>=0.2.0,<1.0.0; python_version>='3.8'",
 ]
 
 [project.urls]
@@ -55,3 +57,13 @@ functions_framework = ["py.typed"]
 
 [tool.setuptools.package-dir]
 "" = "src"
+
+[dependency-groups]
+dev = [
+    "black>=23.3.0",
+    "build>=1.1.1",
+    "isort>=5.11.5",
+    "pretend>=1.0.9",
+    "pytest>=7.4.4",
+    "pytest-asyncio>=0.21.2",
+]

functions_framework-3.9.0/setup.py

@@ -0,0 +1,72 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from io import open
+from os import path
+
+from setuptools import find_packages, setup
+
+here = path.abspath(path.dirname(__file__))
+
+# Get the long description from the README file
+with open(path.join(here, "README.md"), encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name="functions-framework",
+    version="3.9.0",
+    description="An open source FaaS (Function as a service) framework for writing portable Python functions -- brought to you by the Google Cloud Functions team.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/googlecloudplatform/functions-framework-python",
+    author="Google LLC",
+    author_email="googleapis-packages@google.com",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable ",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Apache Software License",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    keywords="functions-framework",
+    packages=find_packages(where="src"),
+    package_data={"functions_framework": ["py.typed"]},
+    namespace_packages=["google", "google.cloud"],
+    package_dir={"": "src"},
+    python_requires=">=3.5, <4",
+    install_requires=[
+        "flask>=1.0,<4.0",
+        "click>=7.0,<9.0",
+        "watchdog>=1.0.0",
+        "gunicorn>=22.0.0; platform_system!='Windows'",
+        "cloudevents>=1.2.0,<2.0.0",
+        "Werkzeug>=0.14,<4.0.0",
+    ],
+    extras_require={
+        "async": ["starlette>=0.37.0,<1.0.0"],
+    },
+    entry_points={
+        "console_scripts": [
+            "ff=functions_framework._cli:_cli",
+            "functions-framework=functions_framework._cli:_cli",
+            "functions_framework=functions_framework._cli:_cli",
+            "functions-framework-python=functions_framework._cli:_cli",
+            "functions_framework_python=functions_framework._cli:_cli",
+        ]
+    },
+)

{functions_framework-3.8.3 → functions_framework-3.9.0}/src/functions_framework/__init__.py

@@ -327,6 +327,16 @@ def crash_handler(e):
 
 
 def create_app(target=None, source=None, signature_type=None):
+    """Create an app for the function.
+
+    Args:
+        target: The name of the target function to invoke
+        source: The source file containing the function
+        signature_type: The signature type of the function
+
+    Returns:
+        A Flask WSGI app or Starlette ASGI app depending on function decorators
+    """
     target = _function_registry.get_function_target(target)
     source = _function_registry.get_function_source(source)
 
@@ -370,6 +380,7 @@ def create_app(target=None, source=None, signature_type=None):
         setup_logging()
 
     _app.wsgi_app = execution_id.WsgiMiddleware(_app.wsgi_app)
+
     # Execute the module, within the application context
     with _app.app_context():
         try:
@@ -394,6 +405,23 @@ def create_app(target=None, source=None, signature_type=None):
                 # command fails.
                 raise e from None
 
+    use_asgi = target in _function_registry.ASGI_FUNCTIONS
+    if use_asgi:
+        # This function needs ASGI, delegate to create_asgi_app
+        # Note: @aio decorators only register functions in ASGI_FUNCTIONS when the
+        # module is imported. We can't know if a function uses @aio until after
+        # we load the module.
+        #
+        # To avoid loading modules twice, we always create a Flask app first, load the
+        # module within its context, then check if ASGI is needed. This results in an
+        # unused Flask app for ASGI functions, but we accept this memory overhead as a
+        # trade-off.
+        from functions_framework.aio import create_asgi_app_from_module
+
+        return create_asgi_app_from_module(
+            target, source, signature_type, source_module, spec
+        )
+
     # Get the configured function signature type
     signature_type = _function_registry.get_func_signature_type(target, signature_type)
 

{functions_framework-3.8.3 → functions_framework-3.9.0}/src/functions_framework/_cli.py

@@ -16,7 +16,7 @@ import os
 
 import click
 
-from functions_framework import create_app
+from functions_framework import _function_registry, create_app
 from functions_framework._http import create_server
 
 
@@ -32,6 +32,17 @@ from functions_framework._http import create_server
 @click.option("--host", envvar="HOST", type=click.STRING, default="0.0.0.0")
 @click.option("--port", envvar="PORT", type=click.INT, default=8080)
 @click.option("--debug", envvar="DEBUG", is_flag=True)
-def _cli(target, source, signature_type, host, port, debug):
-    app = create_app(target, source, signature_type)
+@click.option(
+    "--asgi",
+    envvar="FUNCTION_USE_ASGI",
+    is_flag=True,
+    help="Use ASGI server for function execution",
+)
+def _cli(target, source, signature_type, host, port, debug, asgi):
+    if asgi:
+        from functions_framework.aio import create_asgi_app
+
+        app = create_asgi_app(target, source, signature_type)
+    else:
+        app = create_app(target, source, signature_type)
     create_server(app, debug).run(host, port)

{functions_framework-3.8.3 → functions_framework-3.9.0}/src/functions_framework/_function_registry.py

@@ -40,6 +40,10 @@ REGISTRY_MAP = {}
 # Keys are the user function name, values are the type of the function input
 INPUT_TYPE_MAP = {}
 
+# ASGI_FUNCTIONS stores function names that require ASGI mode.
+# Functions decorated with @aio.http or @aio.cloud_event are added here.
+ASGI_FUNCTIONS = set()
+
 
 def get_user_function(source, source_module, target):
     """Returns user function, raises exception for invalid function."""

functions_framework-3.9.0/src/functions_framework/_http/__init__.py

@@ -0,0 +1,59 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from flask import Flask
+
+from functions_framework._http.flask import FlaskApplication
+
+
+class HTTPServer:
+    def __init__(self, app, debug, **options):
+        self.app = app
+        self.debug = debug
+        self.options = options
+
+        if isinstance(app, Flask):
+            if self.debug:
+                self.server_class = FlaskApplication
+            else:
+                try:
+                    from functions_framework._http.gunicorn import GunicornApplication
+
+                    self.server_class = GunicornApplication
+                except ImportError as e:
+                    self.server_class = FlaskApplication
+        else:  # pragma: no cover
+            if self.debug:
+                from functions_framework._http.asgi import StarletteApplication
+
+                self.server_class = StarletteApplication
+            else:
+                try:
+                    from functions_framework._http.gunicorn import UvicornApplication
+
+                    self.server_class = UvicornApplication
+                except ImportError as e:
+                    from functions_framework._http.asgi import StarletteApplication
+
+                    self.server_class = StarletteApplication
+
+    def run(self, host, port):
+        http_server = self.server_class(
+            self.app, host, port, self.debug, **self.options
+        )
+        http_server.run()
+
+
+def create_server(app, debug, **options):
+    return HTTPServer(app, debug, **options)

functions_framework-3.9.0/src/functions_framework/_http/asgi.py

@@ -0,0 +1,43 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import uvicorn
+
+
+class StarletteApplication:
+    """A Starlette application that uses Uvicorn for direct serving (development mode)."""
+
+    def __init__(self, app, host, port, debug, **options):
+        """Initialize the Starlette application.
+
+        Args:
+            app: The ASGI application to serve
+            host: The host to bind to
+            port: The port to bind to
+            debug: Whether to run in debug mode
+            **options: Additional options to pass to Uvicorn
+        """
+        self.app = app
+        self.host = host
+        self.port = port
+        self.debug = debug
+
+        self.options = {
+            "log_level": "debug" if debug else "error",
+        }
+        self.options.update(options)
+
+    def run(self):
+        """Run the Uvicorn server directly."""
+        uvicorn.run(self.app, host=self.host, port=int(self.port), **self.options)

{functions_framework-3.8.3 → functions_framework-3.9.0}/src/functions_framework/_http/gunicorn.py

@@ -70,3 +70,28 @@ class GThreadWorkerWithTimeoutSupport(ThreadWorker):  # pragma: no cover
     def handle_request(self, req, conn):
         with ThreadingTimeout(TIMEOUT_SECONDS):
             super(GThreadWorkerWithTimeoutSupport, self).handle_request(req, conn)
+
+
+class UvicornApplication(gunicorn.app.base.BaseApplication):
+    """Gunicorn application for ASGI apps using Uvicorn workers."""
+
+    def __init__(self, app, host, port, debug, **options):
+        self.options = {
+            "bind": "%s:%s" % (host, port),
+            "workers": int(os.environ.get("WORKERS", 1)),
+            "worker_class": "uvicorn_worker.UvicornWorker",
+            "timeout": int(os.environ.get("CLOUD_RUN_TIMEOUT_SECONDS", 0)),
+            "loglevel": os.environ.get("GUNICORN_LOG_LEVEL", "error"),
+            "limit_request_line": 0,
+        }
+        self.options.update(options)
+        self.app = app
+
+        super().__init__()
+
+    def load_config(self):
+        for key, value in self.options.items():
+            self.cfg.set(key, value)
+
+    def load(self):
+        return self.app