Make package --python work

Author: alexarchambault

build.sc

@@ -180,6 +180,12 @@ object dummy extends Module {
       Deps.scalafmtCli
     )
   }
+  object pythonInterface extends JavaModule with Bloop.Module {
+    def skipBloop = true
+    def ivyDeps = Agg(
+      Deps.pythonInterface
+    )
+  }
 }
 
 trait BuildMacros extends ScalaCliSbtModule
@@ -662,6 +668,9 @@ trait Cli extends SbtModule with ProtoBuildModule with CliLaunchers
          |
          |/** Build-time constants. Generated by mill. */
          |object Constants {
+         |  def pythonInterfaceOrg       = "${Deps.pythonInterface.dep.module.organization.value}"
+         |  def pythonInterfaceName      = "${Deps.pythonInterface.dep.module.name.value}"
+         |  def pythonInterfaceVersion   = "${Deps.pythonInterface.dep.version}"
          |  def launcherTypeResourcePath = "${launcherTypeResourcePath.toString}"
          |  def defaultFilesResourcePath = "$defaultFilesResourcePath"
          |  def maxAmmoniteScala3Version = "${Scala.maxAmmoniteScala3Version}"

modules/cli/src/main/scala/scala/cli/commands/package0/Package.scala

@@ -3,6 +3,7 @@ package scala.cli.commands.package0
 import ai.kien.python.Python
 import caseapp.*
 import coursier.launcher.*
+import dependency.*
 import packager.config.*
 import packager.deb.DebianPackage
 import packager.docker.DockerPackage
@@ -36,7 +37,7 @@ import scala.cli.commands.util.BuildCommandHelpers
 import scala.cli.commands.{CommandUtils, ScalaCommand, WatchUtil}
 import scala.cli.config.{ConfigDb, Keys}
 import scala.cli.errors.ScalaJsLinkingError
-import scala.cli.internal.{CachedBinary, ProcUtil, ScalaJsLinker}
+import scala.cli.internal.{CachedBinary, Constants, ProcUtil, ScalaJsLinker}
 import scala.cli.packaging.{Library, NativeImage}
 import scala.util.Properties
 
@@ -300,7 +301,7 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
 
       val outputPath = packageType match {
         case PackageType.Bootstrap =>
-          value(bootstrap(build, destPath, value(mainClass), () => alreadyExistsCheck()))
+          value(bootstrap(build, destPath, value(mainClass), () => alreadyExistsCheck(), logger))
           destPath
         case PackageType.LibraryJar =>
           val content = Library.libraryJar(build)
@@ -391,7 +392,15 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
 
         case nativePackagerType: PackageType.NativePackagerType =>
           val bootstrapPath = os.temp.dir(prefix = "scala-packager") / "app"
-          value(bootstrap(build, bootstrapPath, value(mainClass), () => alreadyExistsCheck()))
+          value {
+            bootstrap(
+              build,
+              bootstrapPath,
+              value(mainClass),
+              () => alreadyExistsCheck(),
+              logger
+            )
+          }
           val sharedSettings = SharedSettings(
             sourceAppPath = bootstrapPath,
             version = packageOptions.packageVersion,
@@ -627,7 +636,7 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
 
     val appPath = os.temp.dir(prefix = "scala-cli-docker") / "app"
     build.options.platform.value match {
-      case Platform.JVM => value(bootstrap(build, appPath, mainClass, () => Right(())))
+      case Platform.JVM => value(bootstrap(build, appPath, mainClass, () => Right(()), logger))
       case Platform.JS  => buildJs(build, appPath, mainClass, logger)
       case Platform.Native =>
         val dest = value(buildNative(build, mainClass, logger))
@@ -669,7 +678,8 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
     build: Build.Successful,
     destPath: os.Path,
     mainClass: String,
-    alreadyExistsCheck: () => Either[BuildException, Unit]
+    alreadyExistsCheck: () => Either[BuildException, Unit],
+    logger: Logger
   ): Either[BuildException, Unit] = either {
     val byteCodeZipEntries = os.walk(build.output)
       .filter(os.isFile(_))
@@ -708,10 +718,41 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
       .withOsKind(Properties.isWin)
       .callsItself(Properties.isWin)
       .withJavaOpts(build.options.javaOptions.javaOpts.toSeq.map(_.value.value))
-    val params = Parameters.Bootstrap(Seq(loaderContent), mainClass)
+    val baseParams = Parameters.Bootstrap(Seq(loaderContent), mainClass)
       .withDeterministic(true)
       .withPreamble(preamble)
 
+    val params =
+      if (build.options.notForBloopOptions.doSetupPython.getOrElse(false)) {
+        val res = value {
+          Artifacts.fetch(
+            Positioned.none(Seq(
+              dep"${Constants.pythonInterfaceOrg}:${Constants.pythonInterfaceName}:${Constants.pythonInterfaceVersion}"
+            )),
+            Nil,
+            None,
+            logger,
+            build.options.finalCache,
+            None,
+            Some(_)
+          )
+        }
+        val entries = res.artifacts.map {
+          case (a, f) =>
+            val path = os.Path(f)
+            if (build.options.notForBloopOptions.packageOptions.isStandalone)
+              ClassPathEntry.Resource(path.last, os.mtime(path), os.read.bytes(path))
+            else
+              ClassPathEntry.Url(a.url)
+        }
+        val pythonContent = Seq(
+          ClassLoaderContent(entries)
+        )
+        baseParams.addExtraContent("python", pythonContent).withPython(true)
+      }
+      else
+        baseParams
+
     value(alreadyExistsCheck())
     BootstrapGenerator.generate(params, destPath.toNIO)
     ProcUtil.maybeUpdatePreamble(destPath)

modules/integration/src/test/scala/scala/cli/integration/PackageTestDefinitions.scala

@@ -894,4 +894,36 @@ abstract class PackageTestDefinitions(val scalaVersionOpt: Option[String])
       )
     }
   }
+
+  test("scalapy") {
+
+    def maybeScalapyPrefix =
+      if (actualScalaVersion.startsWith("2.13.")) ""
+      else "import me.shadaj.scalapy.py" + System.lineSeparator()
+
+    val inputs = TestInputs(
+      os.rel / "Hello.scala" ->
+        s"""$maybeScalapyPrefix
+           |object Hello {
+           |  def main(args: Array[String]): Unit = {
+           |    py.Dynamic.global.print("Hello from Python", flush = true)
+           |  }
+           |}
+           |""".stripMargin
+    )
+
+    val dest =
+      if (Properties.isWin) "hello.bat"
+      else "hello"
+
+    inputs.fromRoot { root =>
+      os.proc(TestUtil.cli, "package", "--python", ".", "-o", dest, extraOptions)
+        .call(cwd = root, stdin = os.Inherit, stdout = os.Inherit)
+
+      val launcher = root / dest
+      val res      = os.proc(launcher).call(cwd = root)
+      val output   = res.out.trim()
+      expect(output == "Hello from Python")
+    }
+  }
 }

project/deps.sc

@@ -139,6 +139,7 @@ object Deps {
   def organizeImports            = ivy"com.github.liancheng::organize-imports:0.6.0"
   def osLib                      = ivy"com.lihaoyi::os-lib:0.8.1"
   def pprint                     = ivy"com.lihaoyi::pprint:0.8.0"
+  def pythonInterface            = ivy"io.github.alexarchambault.python:interface:0.1.0"
   def pythonNativeLibs           = ivy"ai.kien::python-native-libs:0.2.4"
   def scala3Compiler(sv: String) = ivy"org.scala-lang:scala3-compiler_3:$sv"
   def scalaAsync         = ivy"org.scala-lang.modules::scala-async:1.0.1".exclude("*" -> "*")