Add option to initialize python functions.

Author: taeold

src/deploy/functions/runtimes/python/index.ts

@@ -13,7 +13,7 @@ import { runWithVirtualEnv } from "../../../../functions/python";
 import { FirebaseError } from "../../../../error";
 import { Build } from "../../build";
 
-const LATEST_VERSION: runtimes.Runtime = "python310";
+export const LATEST_VERSION: runtimes.Runtime = "python310";
 
 /**
  * Create a runtime delegate for the Python runtime, if applicable.
@@ -37,6 +37,24 @@ export async function tryCreateDelegate(
   return Promise.resolve(new Delegate(context.projectId, context.sourceDir, runtime));
 }
 
+/**
+ * Get corresponding python binary name for a given runtime.
+ *
+ * By default, returns "python"
+ */
+export function getPythonBinary(runtime: runtimes.Runtime): string {
+  if (process.platform === "win32") {
+    // There is no easy way to get specific version of python executable in Windows.
+    return "python.exe";
+  }
+  if (runtime === "python310") {
+    return "python3.10";
+  } else if (runtime === "python311") {
+    return "python3.11";
+  }
+  return "python";
+}
+
 export class Delegate implements runtimes.RuntimeDelegate {
   public readonly name = "python";
   constructor(
@@ -82,16 +100,7 @@ export class Delegate implements runtimes.RuntimeDelegate {
   }
 
   getPythonBinary(): string {
-    if (process.platform === "win32") {
-      // There is no easy way to get specific version of python executable in Windows.
-      return "python.exe";
-    }
-    if (this.runtime === "python310") {
-      return "python3.10";
-    } else if (this.runtime === "python311") {
-      return "python3.11";
-    }
-    return "python";
+    return getPythonBinary(this.runtime);
   }
 
   validate(): Promise<void> {

src/functions/python.ts

@@ -12,6 +12,7 @@ export function runWithVirtualEnv(
   commandAndArgs: string[],
   cwd: string,
   envs: Record<string, string>,
+  spawnOpts: cp.SpawnOptions = {},
   venvDir = DEFAULT_VENV_DIR
 ): cp.ChildProcess {
   const activateScriptPath =
@@ -25,6 +26,7 @@ export function runWithVirtualEnv(
     shell: true,
     cwd,
     stdio: [/* stdin= */ "pipe", /* stdout= */ "pipe", /* stderr= */ "pipe", "pipe"],
+    ...spawnOpts,
     // Linting disabled since internal types expect NODE_ENV which does not apply to Python runtimes.
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-explicit-any
     env: envs as any,

src/init/features/functions/index.ts

@@ -13,6 +13,7 @@ import {
   assertUnique,
 } from "../../../functions/projectConfig";
 import { FirebaseError } from "../../../error";
+import { isEnabled } from "../../../experiments";
 
 const MAX_ATTEMPTS = 5;
 
@@ -167,6 +168,12 @@ async function languageSetup(setup: any, config: Config): Promise<any> {
       value: "typescript",
     },
   ];
+  if (isEnabled("pythonfunctions")) {
+    choices.push({
+      name: "Python",
+      value: "python",
+    });
+  }
   const language = await promptOnce({
     type: "list",
     message: "What language would you like to use to write Cloud Functions?",

src/init/features/functions/python.ts

@@ -0,0 +1,71 @@
+import * as fs from "fs";
+import * as spawn from "cross-spawn";
+import * as path from "path";
+
+import { Config } from "../../../config";
+import { getPythonBinary, LATEST_VERSION } from "../../../deploy/functions/runtimes/python";
+import { runWithVirtualEnv } from "../../../functions/python";
+import { promptOnce } from "../../../prompt";
+
+const TEMPLATE_ROOT = path.resolve(__dirname, "../../../../templates/init/functions/python");
+const MAIN_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "main.py"), "utf8");
+const REQUIREMENTS_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "requirements.txt"), "utf8");
+const GITIGNORE_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "_gitignore"), "utf8");
+
+/**
+ * Create a Python Firebase Functions project.
+ */
+export async function setup(setup: any, config: Config): Promise<void> {
+  await config.askWriteProjectFile(
+    `${setup.functions.source}/requirements.txt`,
+    REQUIREMENTS_TEMPLATE
+  );
+  await config.askWriteProjectFile(`${setup.functions.source}/.gitignore`, GITIGNORE_TEMPLATE);
+  await config.askWriteProjectFile(`${setup.functions.source}/main.py`, MAIN_TEMPLATE);
+
+  // Write the latest supported runtime version to the config.
+  config.set("functions.runtime", LATEST_VERSION);
+  // Add python specific ignores to config.
+  config.set("functions.ignore", ["venv", "__pycache__"]);
+
+  // Setup VENV.
+  const venvProcess = spawn(getPythonBinary(LATEST_VERSION), ["-m", "venv", "venv"], {
+    shell: true,
+    cwd: config.path(setup.functions.source),
+    stdio: [/* stdin= */ "pipe", /* stdout= */ "pipe", /* stderr= */ "pipe", "pipe"],
+  });
+  await new Promise((resolve, reject) => {
+    venvProcess.on("exit", resolve);
+    venvProcess.on("error", reject);
+  });
+
+  const install = await promptOnce({
+    name: "install",
+    type: "confirm",
+    message: "Do you want to install dependencies now?",
+    default: true,
+  });
+  if (install) {
+    // Update pip to support dependencies like pyyaml.
+    const upgradeProcess = runWithVirtualEnv(
+      ["pip3", "install", "--upgrade", "pip"],
+      config.path(setup.functions.source),
+      {},
+      { stdio: ["inherit", "inherit", "inherit"] }
+    );
+    await new Promise((resolve, reject) => {
+      upgradeProcess.on("exit", resolve);
+      upgradeProcess.on("error", reject);
+    });
+    const installProcess = runWithVirtualEnv(
+      [getPythonBinary(LATEST_VERSION), "-m", "pip", "install", "-r", "requirements.txt"],
+      config.path(setup.functions.source),
+      {},
+      { stdio: ["inherit", "inherit", "inherit"] }
+    );
+    await new Promise((resolve, reject) => {
+      installProcess.on("exit", resolve);
+      installProcess.on("error", reject);
+    });
+  }
+}

templates/init/functions/python/_gitignore

@@ -0,0 +1,13 @@
+# Welcome to Cloud Functions for Firebase for Python!
+# To get started, simply uncomment the below code or create your own.
+# Deploy with `firebase deploy`
+
+from firebase_functions import https
+from firebase_admin import initialize_app
+
+# initialize_app()
+#
+#
+# @https.on_request()
+# def on_request_example(req: https.Request) -> https.Response:
+#     return https.Response("Hello world!")

templates/init/functions/python/main.py

@@ -0,0 +1 @@
+git+https://github.com/firebase/firebase-functions-python.git@main#egg=firebase-functions