Python-Entwicklerhandbuch für Azure FunctionsAzure Functions Python developer guide

Dieser Artikel ist eine Einführung in die Entwicklung von Azure Functions mithilfe von Python.This article is an introduction to developing Azure Functions using Python. Der folgende Inhalt geht davon aus, dass Sie das Azure Functions: Entwicklerhandbuch bereits gelesen haben.The content below assumes that you've already read the Azure Functions developers guide.

Hinweis

Python für Azure Functions ist zurzeit als Vorschauversion verfügbar.Python for Azure Functions is currently in preview. Abonnieren Sie das Repository mit Azure App Service-Ankündigungen auf GitHub, um wichtige Updates zu erhalten.To receive important updates, subscribe to the Azure App Service announcements repository on GitHub.

ProgrammiermodellProgramming model

Eine Azure-Funktion sollte eine zustandslose Methode in Ihrem Python-Skript sein, die Eingaben verarbeitet und Ausgaben erzeugt.An Azure Function should be a stateless method in your Python script that processes input and produces output. Standardmäßig erwartet die Runtime, dass die Methode als globale Methode namens main() in der __init__.py-Datei implementiert ist.By default, the runtime expects the method to be implemented as a global method called main() in the __init__.py file.

Sie können die Standardkonfiguration ändern, indem Sie die Eigenschaften scriptFile und entryPoint in der function.json-Datei angeben.You can change the default configuration by specifying the scriptFile and entryPoint properties in the function.json file. Beispielsweise weist die unten stehende function.json die Runtime an, die Methode customentry() in der main.py-Datei als Einstiegspunkt für Ihre Azure-Funktion zu verwenden.For example, the function.json below tells the runtime to use the customentry() method in the main.py file, as the entry point for your Azure Function.

{
  "scriptFile": "main.py",
  "entryPoint": "customentry",
  ...
}

Daten von Triggern und Bindungen werden mittels Methodenattributen an die Funktion gebunden, die die in der Konfigurationsdatei function.json definierte Eigenschaft name verwenden.Data from triggers and bindings is bound to the function via method attributes using the name property defined in the function.json file. Beispielsweise beschreibt die unten stehende function.json eine einfache Funktion, die von einer HTTP-Anforderung namens req ausgelöst wird:For example, the function.json below describes a simple function triggered by an HTTP request named req:

{
  "bindings": [
    {
      "name": "req",
      "direction": "in",
      "type": "httpTrigger",
      "authLevel": "anonymous"
    },
    {
      "name": "$return",
      "direction": "out",
      "type": "http"
    }
  ]
}

Die Datei __init__.py enthält folgenden Funktionscode:The __init__.py file contains the following function code:

def main(req):
    user = req.params.get('user')
    return f'Hello, {user}!'

Optional können Sie zur Verwendung der von Ihrem Code-Editor bereitgestellten IntelliSense-Features und Features zur automatischen Vervollständigung auch die Attributtypen und Rückgabetypen in der Funktion mithilfe von Python-Typanmerkungen deklarieren.Optionally, to leverage the intellisense and auto-complete features provided by your code editor, you can also declare the attribute types and return type in the function using Python type annotations.

import azure.functions


def main(req: azure.functions.HttpRequest) -> str:
    user = req.params.get('user')
    return f'Hello, {user}!'

Verwenden Sie die Python-Anmerkungen im Paket azure.functions.*, um Eingaben und Ausgaben an Ihre Methoden zu binden.Use the Python annotations included in the azure.functions.* package to bind input and outputs to your methods.

OrdnerstrukturFolder structure

Die Ordnerstruktur für ein Python Functions-Projekt sieht wie folgt aus:The folder structure for a Python Functions project looks like the following:

 FunctionApp
 | - MyFirstFunction
 | | - __init__.py
 | | - function.json
 | - MySecondFunction
 | | - __init__.py
 | | - function.json
 | - SharedCode
 | | - myFirstHelperFunction.py
 | | - mySecondHelperFunction.py
 | - host.json
 | - requirements.txt

Sie können die freigegebene Datei host.json zum Konfigurieren der Funktions-App verwenden.There's a shared host.json file that can be used to configure the function app. Jede Funktion verfügt über eine eigene Codedatei sowie über eine eigene Bindungskonfigurationsdatei (function.json).Each function has its own code file and binding configuration file (function.json).

Freigegebener Code sollte in einem separaten Ordner gespeichert werden.Shared code should be kept in a separate folder. Um auf Module im Ordner „SharedCode“ zu verweisen, können Sie die folgende Syntax verwenden:To reference modules in the SharedCode folder, you can use the following syntax:

from __app__.SharedCode import myFirstHelperFunction

Wenn Sie ein Functions-Projekt in Ihrer Funktions-App in Azure bereitstellen, sollte der gesamte Inhalt des Ordners FunctionApp in das Paket aufgenommen werden, jedoch nicht der Ordner selbst.When deploying a Function project to your function app in Azure, the entire content of the FunctionApp folder should be included in the package, but not the folder itself.

Trigger und EingabenTriggers and Inputs

Eingaben werden in Azure Functions in zwei Kategorien unterteilt: Triggereingaben und zusätzliche Eingaben.Inputs are divided into two categories in Azure Functions: trigger input and additional input. Obwohl sie sich in der Datei function.json unterscheiden, ist ihre Verwendung im Python-Code identisch.Although they are different in the function.json file, usage is identical in Python code. Verbindungszeichenfolgen oder Geheimnisse für Trigger- und Eingabequellen werden bei lokaler Ausführung Werten in der Datei local.settings.json und bei der Ausführung in Azure den Anwendungseinstellungen zugeordnet.Connection strings or secrets for trigger and input sources map to values in the local.settings.json file when running locally, and the application settings when running in Azure.

Im folgenden Code wird beispielsweise der Unterschied zwischen beiden dargestellt:For example, the following code demonstrates the difference between the two:

// function.json
{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "req",
      "direction": "in",
      "type": "httpTrigger",
      "authLevel": "anonymous",
      "route": "items/{id}"
    },
    {
      "name": "obj",
      "direction": "in",
      "type": "blob",
      "path": "samples/{id}",
      "connection": "AzureWebJobsStorage"
    }
  ]
}
// local.settings.json
{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "python",
    "AzureWebJobsStorage": "<azure-storage-connection-string>"
  }
}
# __init__.py
import azure.functions as func
import logging


def main(req: func.HttpRequest,
         obj: func.InputStream):

    logging.info(f'Python HTTP triggered function processed: {obj.read()}')

Bei Aufruf der Funktion wird die HTTP-Anforderung als req an die Funktion übergeben.When the function is invoked, the HTTP request is passed to the function as req. Es wird ein Eintrag, der auf der ID in der Routen-URL basiert, aus Azure Blob Storage abgerufen und als obj im Funktionstext verfügbar gemacht.An entry will be retrieved from the Azure Blob Storage based on the ID in the route URL and made available as obj in the function body. Hier ist das angegebene Speicherkonto die Verbindungszeichenfolge, die sich in AzureWebJobsStorage befindet, wobei es sich um dasselbe Speicherkonto handelt, das von der Funktions-App verwendet wird.Here the storage account specified is the connection string found in AzureWebJobsStorage which is the same storage account used by the function app.

AusgabenOutputs

Ausgaben können sowohl im Rückgabewert als auch in Ausgabeparametern angegeben werden.Output can be expressed both in return value and output parameters. Wenn es nur eine Ausgabe gibt, empfehlen wir, den Rückgabewert zu verwenden.If there's only one output, we recommend using the return value. Bei mehreren Ausgaben müssen Sie Ausgabeparameter verwenden.For multiple outputs, you'll have to use output parameters.

Um den Rückgabewert einer Funktion als Wert für eine Ausgabebindung zu verwenden, sollte die name-Eigenschaft der Bindung in function.json auf $return festgelegt werden.To use the return value of a function as the value of an output binding, the name property of the binding should be set to $return in function.json.

Um mehrere Ausgaben zu erzeugen, verwenden Sie die set()-Methode, die von der azure.functions.Out-Schnittstelle bereitgestellt wird, um der Bindung einen Wert zuzuweisen.To produce multiple outputs, use the set() method provided by the azure.functions.Out interface to assign a value to the binding. Die folgende Funktion kann z. B. mithilfe von Push eine Nachricht an eine Warteschlange übertragen und auch eine HTTP-Antwort zurückgeben.For example, the following function can push a message to a queue and also return an HTTP response.

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "req",
      "direction": "in",
      "type": "httpTrigger",
      "authLevel": "anonymous"
    },
    {
      "name": "msg",
      "direction": "out",
      "type": "queue",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    },
    {
      "name": "$return",
      "direction": "out",
      "type": "http"
    }
  ]
}
import azure.functions as func


def main(req: func.HttpRequest,
         msg: func.Out[func.QueueMessage]) -> str:

    message = req.params.get('body')
    msg.set(message)
    return message

ProtokollierungLogging

Zugriff auf die Azure Functions-Runtimeprotokollierung ist über einen Stamm-logging-Handler in Ihrer Funktions-App verfügbar.Access to the Azure Functions runtime logger is available via a root logging handler in your function app. Diese Protokollierung ist an Application Insights gebunden und ermöglicht es Ihnen, während der Funktionsausführung aufgetretene Warnungen und Fehler zu kennzeichnen.This logger is tied to Application Insights and allows you to flag warnings and errors encountered during the function execution.

Im folgenden Beispiel wird eine Informationsmeldung protokolliert, wenn die Funktion über einen HTTP-Trigger aufgerufen wird.The following example logs an info message when the function is invoked via an HTTP trigger.

import logging


def main(req):
    logging.info('Python HTTP trigger function processed a request.')

Es sind zusätzliche Protokollierungsmethoden verfügbar, mit denen Sie auf anderen Ablaufverfolgungsebenen in die Konsole schreiben können:Additional logging methods are available that let you write to the console at different trace levels:

MethodeMethod BESCHREIBUNGDescription
logging.critical(message)logging.critical(message) Schreibt eine Meldung mit der Stufe KRITISCH in die Stammprotokollierung.Writes a message with level CRITICAL on the root logger.
logging.error(message)logging.error(message) Schreibt eine Meldung mit der Stufe ERROR in die Stammprotokollierung.Writes a message with level ERROR on the root logger.
logging.warning(message)logging.warning(message) Schreibt eine Meldung mit der Stufe WARNUNG in die Stammprotokollierung.Writes a message with level WARNING on the root logger.
logging.info(message)logging.info(message) Schreibt eine Meldung mit der Stufe INFO in die Stammprotokollierung.Writes a message with level INFO on the root logger.
logging.debug(message)logging.debug(message) Schreibt eine Meldung mit der Stufe DEBUG in die Stammprotokollierung.Writes a message with level DEBUG on the root logger.

AsyncAsync

Es wird empfohlen, Ihre Azure-Funktion als asynchrone Coroutine mithilfe der Anweisung async def zu schreiben.We recommend that you write your Azure Function as an asynchronous coroutine using the async def statement.

# Will be run with asyncio directly


async def main():
    await some_nonblocking_socket_io_op()

Wenn die main()-Funktion synchron ist (ohne async-Qualifizierer), führen wir die Funktion automatisch in einem asyncio-Threadpool aus.If the main() function is synchronous (no async qualifier) we automatically run the function in an asyncio thread-pool.

# Would be run in an asyncio thread-pool


def main():
    some_blocking_socket_io()

KontextContext

Um den Aufrufkontext einer Funktion während der Ausführung abzurufen, nehmen Sie das context-Argument in ihre Signatur auf.To get the invocation context of a function during execution, include the context argument in its signature.

Beispiel:For example:

import azure.functions


def main(req: azure.functions.HttpRequest,
         context: azure.functions.Context) -> str:
    return f'{context.invocation_id}'

Die Context-Klasse enthält die folgenden Methoden:The Context class has the following methods:

function_directory
Das Verzeichnis, in dem die Funktion ausgeführt wird.The directory in which the function is running.

function_name
Name der Funktion.Name of the function.

invocation_id
ID des aktuellen Funktionsaufrufs.ID of the current function invocation.

Globale VariablenGlobal variables

Es besteht keine Garantie, dass der Status Ihrer App für zukünftige Ausführungen beibehalten wird.It is not guaranteed that the state of your app will be preserved for future executions. Jedoch verwendet die Azure Functions-Runtime oft wieder den gleichen Prozess für mehrere Ausführungen derselben App.However, the Azure Functions runtime often reuses the same process for multiple executions of the same app. Zum Zwischenspeichern der Ergebnisse einer teuren Berechnung deklarieren Sie diese als globale Variable.In order to cache the results of an expensive computation, declare it as a global variable.

CACHED_DATA = None


def main(req):
    global CACHED_DATA
    if CACHED_DATA is None:
        CACHED_DATA = load_json()

    # ... use CACHED_DATA in code

Python-Version und PaketverwaltungPython version and package management

Zurzeit unterstützt Azure Functions nur Python 3.6.x (offizielle CPython-Verteilung).Currently, Azure Functions only supports Python 3.6.x (official CPython distribution).

Bei der lokalen Entwicklung mithilfe der Azure Functions Core Tools oder von Visual Studio Code fügen Sie die Namen und Versionen der erforderlichen Pakete in der requirements.txt-Datei hinzu, und installieren Sie sie mithilfe von pip.When developing locally using the Azure Functions Core Tools or Visual Studio Code, add the names and versions of the required packages to the requirements.txt file and install them using pip.

Beispielsweise können die folgende Datei mit Anforderungen und der pip-Befehl verwendet werden, um das requests-Paket aus PyPI zu installieren.For example, the following requirements file and pip command can be used to install the requests package from PyPI.

requests==2.19.1
pip install -r requirements.txt

Veröffentlichen in AzurePublishing to Azure

Wenn Sie zur Veröffentlichung bereit sind, stellen Sie sicher, dass alle Ihre Abhängigkeiten in der Datei requirements.txt aufgeführt sind, die sich im Stamm Ihres Projektverzeichnisses befindet.When you're ready to publish, make sure that all your dependencies are listed in the requirements.txt file, which is located at the root of your project directory. Wenn Sie ein Paket verwenden, das einen Compiler erfordert und nicht die Installation von manylinux-kompatiblen Wheels aus PyPI unterstützt, schlägt die Veröffentlichung in Azure mit folgendem Fehler fehl:If you're using a package that requires a compiler and does not support the installation of manylinux-compatible wheels from PyPI, publishing to Azure will fail with the following error:

There was an error restoring dependencies.ERROR: cannot install <package name - version> dependency: binary dependencies without wheels are not supported.  
The terminal process terminated with exit code: 1

Um die erforderlichen Binärdateien automatisch zu erstellen und zu konfigurieren, installieren Sie Docker auf Ihrem lokalen Computer, und führen Sie den folgenden Befehl aus, um mithilfe der Azure Functions Core Tools (func) zu veröffentlichen.To automatically build and configure the required binaries, install Docker on your local machine and run the following command to publish using the Azure Functions Core Tools (func). Denken Sie daran, <app name> durch den Namen Ihrer Funktions-App in Azure zu ersetzen.Remember to replace <app name> with the name of your function app in Azure.

func azure functionapp publish <app name> --build-native-deps

Im Hintergrund verwenden die Core Tools Docker, um das mcr.microsoft.com/azure-functions/python-Image als Container auf Ihrem lokalen Computer auszuführen.Underneath the covers, Core Tools will use docker to run the mcr.microsoft.com/azure-functions/python image as a container on your local machine. Unter Verwendung diese Umgebung werden dann die erforderlichen Module aus der Quellverteilung erstellt und installiert, bevor sie zur endgültigen Bereitstellung in Azure gepackt werden.Using this environment, it'll then build and install the required modules from source distribution, before packaging them up for final deployment to Azure.

Verwenden Sie Azure DevOps-Pipelines, um Ihre Abhängigkeiten zu erstellen und mithilfe eines Continuous Delivery-Systems zu veröffentlichen.To build your dependencies and publish using a continuous delivery (CD) system, use Azure DevOps Pipelines.

KomponententestsUnit Testing

In Python geschriebene Funktionen können wie anderer Python-Code mithilfe von Standardtestframeworks getestet werden.Functions written in Python can be tested like other Python code using standard testing frameworks. Bei den meisten Bindungen können Sie ein Pseudoeingabeobjekt erstellen, indem Sie eine Instanz einer geeigneten Klasse aus dem azure.functions-Paket erstellen.For most bindings, it's possible to create a mock input object by creating an instance of an appropriate class from the azure.functions package.

Beim Folgenden handelt es sich beispielsweise um einen Pseudotest einer durch HTTP ausgelösten Funktion:For example, following is a mock test of an HTTP triggered function:

# myapp/__init__.py
import azure.functions as func
import logging


def main(req: func.HttpRequest,
         obj: func.InputStream):

    logging.info(f'Python HTTP triggered function processed: {obj.read()}')
# myapp/test_func.py
import unittest

import azure.functions as func
from . import my_function


class TestFunction(unittest.TestCase):
    def test_my_function(self):
        # Construct a mock HTTP request.
        req = func.HttpRequest(
            method='GET',
            body=None,
            url='/my_function',
            params={'name': 'Test'})

        # Call the function.
        resp = my_function(req)

        # Check the output.
        self.assertEqual(
            resp.get_body(),
            'Hello, Test!',
        )

Im Folgenden finden Sie ein weiteres Beispiel mit einer durch eine Warteschlange ausgelösten Funktion:Here is another example, with a queue triggered function:

# myapp/__init__.py
import azure.functions as func


def my_function(msg: func.QueueMessage) -> str:
    return f'msg body: {msg.get_body().decode()}'
# myapp/test_func.py
import unittest

import azure.functions as func
from . import my_function


class TestFunction(unittest.TestCase):
    def test_my_function(self):
        # Construct a mock Queue message.
        req = func.QueueMessage(
            body=b'test')

        # Call the function.
        resp = my_function(req)

        # Check the output.
        self.assertEqual(
            resp,
            'msg body: test',
        )

Bekannte Probleme und FAQKnown issues and FAQ

Alle bekannten Probleme und Funktionsanfragen werden mithilfe der GitHub-Problemeliste nachverfolgt.All known issues and feature requests are tracked using GitHub issues list. Wenn Sie auf ein Problem stoßen, das in GitHub nicht zu finden ist, öffnen Sie ein neues Problem mit einer ausführlichen Problembeschreibung.If you run into a problem and can't find the issue in GitHub, open a new issue and include a detailed description of the problem.

Nächste SchritteNext steps

Weitere Informationen finden Sie in den folgenden Ressourcen:For more information, see the following resources: