Method WithTemplate

sdk/python/runtime/main.go:325–384

Add the template files to skaffold a new module The following files are added: - /runtime - /pyproject.toml - /src/ /__init__.py - /src/ /main.py

()

// - <source>/src/<package_name>/__init__.py
// - <source>/src/<package_name>/main.py
func (m *PythonSdk) WithTemplate() *PythonSdk {
	m.Container = m.Container.
		WithFile(
			RuntimeExecutablePath,
			dag.CurrentModule().Source().File("template/runtime.py"),
			dagger.ContainerWithFileOpts{Permissions: 0o755},
		).
		WithEntrypoint([]string{RuntimeExecutablePath})

	d := m.Discovery

	// NB: We can't detect if it's a new module with `dagger develop --sdk`
	// if there's also a pyproject.toml file to customize the base container.
	//
	// The reason for adding sources only on new modules is because it's
	// been reported that it's surprising for users to delete the pyhton
	// file on the host and not fail on `dagger functions` and `dagger call`,
	// if we always recreate from the template. That's because only `init`
	// and `develop` export the generated files back to the host, potentially
	// creating a discrepancy.
	//
	// Throwing an error on missing files when not a new module is less
	// surprising, which is done during discovery.

	if m.IsInit {
		// On `dagger init --sdk`, one can first set a `pyproject.toml` to
		// change the base image, but if it's `dagger develop --sdk` the
		// existence of this file will set d.IsInit = true, thus skipping
		// this entire branch.
		if !d.HasFile(ProjectCfg) {
			projCfg := strings.ReplaceAll(tplToml, "main", m.ProjectName)
			// Align the template's requires-python with the version the
			// runtime actually selected (typically from .python-version),
			// otherwise a freshly created pyproject can declare a higher
			// minimum than the Python that ends up in the container and uv
			// will refuse to lock.
			if version := d.findPythonVersion(); version != "" {
				projCfg = strings.Replace(
					projCfg,
					`requires-python = ">=3.14"`,
					fmt.Sprintf(`requires-python = ">=%s"`, version),
					1,
				)
			}
			m.AddNewFile(ProjectCfg, VendorConfig(projCfg, m.VendorPath))
		}
		if !d.HasFile("*.py") {
			m.AddNewFile(
				path.Join("src", m.PackageName, "__init__.py"),
				strings.ReplaceAll(tplInit, MainObjectName, m.MainObjectName),
			)
			m.AddNewFile(
				path.Join("src", m.PackageName, "main.py"),
				strings.ReplaceAll(tplMain, MainObjectName, m.MainObjectName),
			)
		}
	}