Créer et déployer une fonction Cloud HTTP avec Python

Créer et déployer une fonction Cloud HTTP avec Python

Ce guide vous accompagne tout au long du processus d'écriture d'une fonction Cloud à l'aide de l'environnement d'exécution Python. Il existe deux types de fonctions Cloud :

  • Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
  • Les fonctions déclenchées par des événements, qui vous permettent de gérer les événements depuis votre infrastructure cloud tels que les messages sur un sujet Pub/Sub ou les modifications apportées à un bucket Cloud Storage.

Pour en savoir plus, consultez les sections Écrire des fonctions HTTP et Écrire des fonctions pilotées par des événements.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging APIs.

    Enable the APIs

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging APIs.

    Enable the APIs

  8. Installez et initialisez la gcloud CLI.
  9. Mettez à jour et installez les composants gcloud à l'aide de la commande suivante.
    gcloud components update
  10. Préparez votre environnement de développement.

    Accéder au guide de configuration Python

Créer une fonction

  1. Créez un répertoire sur votre système local pour le code de fonction :

    Linux ou Mac OS X

    mkdir ~/helloworld
    cd ~/helloworld
    

    Windows

    mkdir %HOMEPATH%\helloworld
    cd %HOMEPATH%\helloworld
    
  2. Créez un fichier main.py dans le répertoire helloworld avec le contenu suivant :

    
    import functions_framework
    
    from markupsafe import escape
    @functions_framework.http
    def hello_http(request):
        """HTTP Cloud Function.
        Args:
            request (flask.Request): The request object.
            <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
        Returns:
            The response text, or any set of values that can be turned into a
            Response object using `make_response`
            <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
        """
        request_json = request.get_json(silent=True)
        request_args = request.args
    
        if request_json and "name" in request_json:
            name = request_json["name"]
        elif request_args and "name" in request_args:
            name = request_args["name"]
        else:
            name = "World"
        return f"Hello {escape(name)}!"
    
    

    Cet exemple de fonction utilise un nom fourni dans la requête HTTP et renvoie un message d'accueil. Lorsqu'aucun nom n'est fourni, il renvoie le message "Hello World!".

Spécifier des dépendances

Dans Python, les dépendances sont gérées avec pip et exprimées dans un fichier de métadonnées appelé requirements.txt. Ce fichier doit se trouver dans le même répertoire que le fichier main.py qui contient le code de votre fonction.

  1. Créez un fichier requirements.txt dans le répertoire helloworld avec le contenu suivant :

      # An example requirements file. If your function has other dependencies,
      # add them below
      functions-framework==3.*
    

Créer et tester votre fonction localement

Pour compiler et tester votre fonction localement avant de la déployer:

  1. Exécutez le programme d'installation de packages pour Python, pip, pour installer les dépendances de votre package:

    pip install -r requirements.txt
    PATH=$PATH:~/.local/bin
    
  2. Exécutez votre fonction localement avec le framework des fonctions :

    functions-framework-python --target hello_http
    
  3. Testez votre fonction en accédant à http://localhost:8080 dans un navigateur ou en exécutant curl localhost:8080 à partir d'une autre fenêtre.

    Pour en savoir plus, consultez la section Envoyer des requêtes aux fonctions locales.

Déployer la fonction

Pour déployer votre fonction, exécutez la commande suivante dans le répertoire helloworld:

  gcloud functions deploy python-http-function \
    --gen2 \
    --runtime=python312 \
    --region=REGION \
    --source=. \
    --entry-point=hello_http \
    --trigger-http \
    --allow-unauthenticated

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous souhaitez déployer votre fonction (par exemple, us-west1).

L'option facultative --allow-unauthenticated vous permet d'accéder à votre fonction sans authentification.

Tester la fonction déployée

  1. Une fois la fonction déployée, notez la propriété uri à partir du résultat de la commande gcloud functions deploy ou récupérez-la à l'aide de la commande suivante:

    gcloud functions describe python-http-function \
      --region=REGION
    

    Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).

  2. Accédez à cette URL dans votre navigateur. La fonction renvoie un message "Hello World!".

Afficher les journaux de votre fonction

Afficher les journaux à l'aide de l'outil de ligne de commande

Vous pouvez consulter les journaux de votre fonction à l'aide de l'interface utilisateur Cloud Logging ou de Google Cloud CLI.

Pour afficher les journaux de votre fonction à l'aide de gcloud CLI, exécutez la commande logs read :

  gcloud functions logs read \
    --gen2 \
    --limit=10 \
    --region=REGION \
    python-http-function

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).

Le résultat se présente comme suit :

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:42.991
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:41.933
LOG:

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:26.475
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

Afficher les journaux à l'aide du tableau de bord de journalisation

Pour afficher les journaux de votre fonction à l'aide du tableau de bord de journalisation, ouvrez la page Page de présentation de Cloud Functions et cliquez sur le nom de votre fonction dans la liste, puis sur l'onglet Journaux.