Python Middleware v2 Scaffolding by lkingland · Pull Request #2685 · knative/func

lkingland · 2025-02-04T13:39:52Z

Changes

🎁 Host builder now supports Python Functions
🎁 Can now func run Python Functions locally outside of a container (no container runtime required)
🎁 Python Functions now suppport instanced method signatures
🎁 Python Functions now support lifecycle events (start, stop, readiness, liveness)
🎁 Updates Python Template Tests to use pytest
🎁 Python Functions now use the ASGI Spec and run using an ASGI optimized server
🎁 adds support for base images to the OCI builder
🧹 Cleans up .gitignore
🧹 Cleans up and simplifies the OCI builder
🧹 Cleans up and simplifies the repository management code
🧹 removes broken interactive prompts from the run command pending forthcoming UX update

/kind enhancement

Fixes #

Release Note

Python Functions now use the ASGI specification for method signature.
Python Functions now support instances and lifecycle events.  See the new templates for details.
The Host builder now can build and run Python functions locally without a container.

Docs

knative-prow · 2025-02-04T13:39:56Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

pkg/functions/runner.go

matzew · 2025-02-07T10:07:54Z

nice for getting this started

Inbuilt templates should be limited to a base http and cloudevent integration, with anything beyond this falling to the officially supported functions samples repository.

pkg/builders/s2i/assemblers.go

templates/python/cloudevents/pyproject.toml

matzew · 2025-03-27T10:34:01Z

ON, https://github.com/lkingland/func/tree/scaffolding-python/templates/python
can we have a README.md ? with a bit of overview?

.github/workflows/test-e2e-runtime.yaml

codecov · 2025-04-01T12:04:43Z

Codecov Report

Attention: Patch coverage is 52.01238% with 465 lines in your changes missing coverage. Please review.

Project coverage is 62.48%. Comparing base (c7a95dd) to head (727d1dd).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/oci/builder.go	60.62%	195 Missing and 55 partials ⚠️
pkg/oci/python_builder.go	0.00%	133 Missing ⚠️
pkg/functions/runner.go	0.00%	57 Missing and 1 partial ⚠️
pkg/functions/repository.go	84.37%	7 Missing and 3 partials ⚠️
pkg/mock/client.go	0.00%	6 Missing ⚠️
pkg/builders/s2i/assemblers.go	50.00%	4 Missing ⚠️
cmd/run.go	87.50%	1 Missing and 1 partial ⚠️
cmd/build.go	75.00%	0 Missing and 1 partial ⚠️
pkg/oci/go_builder.go	96.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2685      +/-   ##
==========================================
- Coverage   62.61%   62.48%   -0.13%     
==========================================
  Files         131      131              
  Lines       15588    15921     +333     
==========================================
+ Hits         9761     9949     +188     
- Misses       4902     5017     +115     
- Partials      925      955      +30

Flag	Coverage Δ
e2e-test	`34.94% <8.09%> (-0.93%)`	⬇️
e2e-test-oncluster	`33.36% <7.58%> (+0.48%)`	⬆️
e2e-test-oncluster-runtime	`27.86% <7.37%> (?)`
e2e-test-runtime-go	`25.91% <8.09%> (?)`
e2e-test-runtime-node	`25.33% <7.68%> (?)`
e2e-test-runtime-quarkus	`25.41% <7.68%> (?)`
e2e-test-runtime-rust	`24.42% <7.37%> (?)`
e2e-test-runtime-springboot	`24.46% <7.37%> (?)`
e2e-test-runtime-typescript	`25.42% <7.68%> (?)`
integration-tests	`48.81% <50.46%> (+1.08%)`	⬆️
unit-tests	`48.79% <51.70%> (?)`
unit-tests-macos-latest	`?`
unit-tests-ubuntu-latest	`?`
unit-tests-windows-latest	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

gauron99

/lgtm

gauron99 · 2025-03-28T13:19:07Z

pkg/builders/s2i/assemblers.go

+Once Functions is stable and post 1.0, it would be worth exploring adding
+Functions support in the upstream base scripts themselves via environment
+variable.
+*/


love the top-of-file overview comment ❤️

knative-prow · 2025-04-02T10:31:23Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gauron99, lkingland

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [gauron99,lkingland]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

matejvasek · 2025-04-02T19:11:31Z

pkg/oci/go_builder.go

 	if cfg.verbose {
 		fmt.Printf("mv %v %v\n", rel(cfg.buildDir(), target), rel(cfg.buildDir(), blob))
 	}
 	err = os.Rename(target, blob)


@lkingland you are ignoring the err here.

Signed-off-by: Matej Vašek <matejvasek@gmail.com>

* Pick knative#2685 Signed-off-by: Matej Vašek <matejvasek@gmail.com> * Fix Python S2I On-Cluster build Signed-off-by: Matej Vašek <mvasek@redhat.com> --------- Signed-off-by: Matej Vašek <matejvasek@gmail.com> Signed-off-by: Matej Vašek <mvasek@redhat.com>

picking knative#2685 Co-authored-by: Luke Kingland <lkinglan@redhat.com> Signed-off-by: Matej Vašek <mvasek@redhat.com>

* feat: remote storage class picking knative#2693 Co-authored-by: Luke Kingland <lkinglan@redhat.com> Signed-off-by: Matej Vašek <mvasek@redhat.com> * Python Middleware v2 Scaffolding picking knative#2685 Co-authored-by: Luke Kingland <lkinglan@redhat.com> Signed-off-by: Matej Vašek <mvasek@redhat.com> * Fix Python S2I On-Cluster build picking knative#2770 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Fix http port 433 => 443 picking knative#2742 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Trust loopback builders picking knative#2750 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Add testcase for Go private repositories picking knative#2748 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Test adjustments picking knative#2751 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Allow host mounts for build phahse picking knative#2753 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Use s2i in standard mode, not "as-dockerfile" picking knative#2764 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Improvements for Go s2i assembler picking knative#2765 Signed-off-by: Matej Vašek <mvasek@redhat.com> * S2I (source-to-image) host binds picking knative#2766 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Make build binds more similar to runtime binds picking knative#2768 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Add guideline for private Go module usage picking knative#2771 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Improve Go templates README picking knative#2848 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Fix detection of hostname resolution failure picking knative#2841 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Fix: Go scaffolding uses correct module name picking knative#2769 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Fix non-containerized build/run /w external deps picking knative#2847 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Tekton 1.0.x fixes picking #1349 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Fix co-scheduling picking #1358 Co-authored-by: Jefferson Ramos <jeramos@redhat.com> Signed-off-by: Matej Vašek <mvasek@redhat.com> * test: fix gitlab test Signed-off-by: Matej Vašek <mvasek@redhat.com> * dapr install upgrade picking knative#3055 Co-authored-by: David Fridrich <fridrich.david19@gmail.com> Co-authored-by: Luke Kingland <lkinglan@redhat.com> Signed-off-by: Matej Vašek <mvasek@redhat.com> * fixup: go.mod Signed-off-by: Matej Vašek <mvasek@redhat.com> * fixup: update alpine version Signed-off-by: Matej Vašek <mvasek@redhat.com> * Migrate golangci-lint config to v2 picking knative#2781 Signed-off-by: Matej Vašek <mvasek@redhat.com> * Bump golangci-lint version picking knative#2784 Signed-off-by: Matej Vašek <mvasek@redhat.com> * fix flaky unit test picking knative#2749 Signed-off-by: David Fridrich <fridrich.david19@gmail.com> Signed-off-by: Matej Vašek <mvasek@redhat.com> --------- Signed-off-by: Matej Vašek <mvasek@redhat.com> Signed-off-by: David Fridrich <fridrich.david19@gmail.com> Co-authored-by: Luke Kingland <lkinglan@redhat.com> Co-authored-by: Jefferson Ramos <jeramos@redhat.com> Co-authored-by: David Fridrich <fridrich.david19@gmail.com>

knative-prow bot added kind/enhancement Feature additions or improvements to existing do-not-merge/work-in-progress 🤖 PR should not merge because it is a work in progress. labels Feb 4, 2025

knative-prow bot requested review from jrangelramos and rhuss February 4, 2025 13:39

knative-prow bot added the approved 🤖 PR has been approved by an approver from all required OWNERS files. label Feb 4, 2025

knative-prow-robot added the needs-rebase Cannot be merged due to conflicts with HEAD. label Feb 4, 2025

knative-prow bot added the size/XXL 🤖 PR changes 1000+ lines, ignoring generated files. label Feb 4, 2025

matzew reviewed Feb 7, 2025

View reviewed changes

pkg/functions/runner.go Outdated Show resolved Hide resolved

lkingland force-pushed the scaffolding-python branch from ec91040 to 182c74c Compare March 4, 2025 07:00

lkingland added 18 commits March 5, 2025 15:28

refactor python http template

4619287

python http scaffolding

0403fea

add python to make update-runtimes

a1aab62

integrate python scaffolding with func run

d692f71

python http template

cb452cd

reorganize python scaffolding

515665e

cancellation stopgap

bd7d351

documentation and logging cleanup

2fd5e2b

Python Middleware v2 - Scaffolding

1dfe6e3

base layer cache

bfed624

remove wsgi and flask templates

18030cd

Inbuilt templates should be limited to a base http and cloudevent integration, with anything beyond this falling to the officially supported functions samples repository.

update python cloudevents runtime in makefile

edf2149

python cloudevents middleware

3a1e1d9

add python .venvs to gitignore

4ef6184

clean up venvs on make

8f59f72

add missing dependencies to python http tempklate

bbb3c46

set python cloudevents manifest

76c1560

further cleanup of repository impl

269a8b2

lkingland force-pushed the scaffolding-python branch from b813d8c to 269a8b2 Compare March 6, 2025 09:57

lkingland force-pushed the scaffolding-python branch from 7488267 to a51bd6a Compare March 25, 2025 13:38

windows python tests

9ecb85c

lkingland force-pushed the scaffolding-python branch from a51bd6a to 9ecb85c Compare March 25, 2025 13:53

knative deleted a comment from knative-prow bot Mar 25, 2025

knative deleted a comment from codecov bot Mar 26, 2025

matzew reviewed Mar 27, 2025

View reviewed changes

pkg/builders/s2i/assemblers.go Show resolved Hide resolved

knative-prow-robot added the needs-rebase Cannot be merged due to conflicts with HEAD. label Mar 27, 2025

matzew reviewed Mar 27, 2025

View reviewed changes

templates/python/cloudevents/pyproject.toml Show resolved Hide resolved

matejvasek reviewed Mar 27, 2025

View reviewed changes

.github/workflows/test-e2e-runtime.yaml Show resolved Hide resolved

Merge remote-tracking branch 'upstream/main' into scaffolding-python

d60a588

knative-prow-robot removed the needs-rebase Cannot be merged due to conflicts with HEAD. label Apr 1, 2025

python templates README

727d1dd

lkingland force-pushed the scaffolding-python branch from 3ae0f09 to 727d1dd Compare April 1, 2025 11:58

knative deleted a comment from knative-prow bot Apr 1, 2025

knative deleted a comment from codecov bot Apr 1, 2025

gauron99 approved these changes Apr 2, 2025

View reviewed changes

knative-prow bot assigned gauron99 Apr 2, 2025

knative-prow bot added the lgtm 🤖 PR is ready to be merged. label Apr 2, 2025

knative-prow bot merged commit 9f6a135 into knative:main Apr 2, 2025
38 checks passed

matejvasek reviewed Apr 2, 2025

View reviewed changes

matejvasek added a commit to openshift-knative/kn-plugin-func that referenced this pull request Apr 3, 2025

Pick knative#2685

ae6f415

Signed-off-by: Matej Vašek <matejvasek@gmail.com>

matejvasek mentioned this pull request Apr 3, 2025

[release-v1.16] Pick Python scaffolding openshift-knative/kn-plugin-func#1236

Merged

lkingland deleted the scaffolding-python branch May 13, 2025 01:52

matejvasek added a commit to openshift-knative/kn-plugin-func that referenced this pull request Oct 3, 2025

Python Middleware v2 Scaffolding

fcc16cd

picking knative#2685 Co-authored-by: Luke Kingland <lkinglan@redhat.com> Signed-off-by: Matej Vašek <mvasek@redhat.com>

matejvasek mentioned this pull request Oct 3, 2025

[release-v1.17] Backports openshift-knative/kn-plugin-func#1366

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Python Middleware v2 Scaffolding#2685

Python Middleware v2 Scaffolding#2685
knative-prow[bot] merged 47 commits intoknative:mainfrom
lkingland:scaffolding-python

lkingland commented Feb 4, 2025 •

edited

Loading

Uh oh!

knative-prow bot commented Feb 4, 2025

Uh oh!

Uh oh!

matzew commented Feb 7, 2025

Uh oh!

Uh oh!

Uh oh!

matzew commented Mar 27, 2025

Uh oh!

Uh oh!

codecov bot commented Apr 1, 2025 •

edited

Loading

Uh oh!

gauron99 left a comment

Uh oh!

gauron99 Mar 28, 2025

Uh oh!

knative-prow bot commented Apr 2, 2025

Uh oh!

Uh oh!

matejvasek Apr 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

lkingland commented Feb 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

knative-prow bot commented Feb 4, 2025

Uh oh!

Uh oh!

matzew commented Feb 7, 2025

Uh oh!

Uh oh!

Uh oh!

matzew commented Mar 27, 2025

Uh oh!

Uh oh!

codecov bot commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gauron99 left a comment

Choose a reason for hiding this comment

Uh oh!

gauron99 Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

knative-prow bot commented Apr 2, 2025

Uh oh!

Uh oh!

matejvasek Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lkingland commented Feb 4, 2025 •

edited

Loading

codecov bot commented Apr 1, 2025 •

edited

Loading