Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python Middleware v2 Scaffolding #2685

Open
wants to merge 45 commits into
base: main
Choose a base branch
from

Conversation

lkingland
Copy link
Member

@lkingland lkingland commented Feb 4, 2025

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


Copy link

knative-prow bot commented Feb 4, 2025

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

@knative-prow knative-prow bot added kind/enhancement do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Feb 4, 2025
Copy link

knative-prow bot commented Feb 4, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lkingland

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@knative-prow knative-prow bot requested review from jrangelramos and rhuss February 4, 2025 13:39
@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 4, 2025
@knative-prow-robot knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 4, 2025
@knative-prow knative-prow bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Feb 4, 2025
@matzew
Copy link
Member

matzew commented Feb 7, 2025

nice for getting this started

@lkingland lkingland force-pushed the scaffolding-python branch from ec91040 to 182c74c Compare March 4, 2025 07:00
Until the Python middleware is supported by the Pack builder, the E2E
tests will need to be disabled.
@lkingland lkingland changed the title [WIP] Python Middleware v2 Scaffolding Python Middleware v2 Scaffolding Mar 24, 2025
@knative-prow knative-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 24, 2025
The target platform for a test needs to be a platform which is available
in all test base images.  That's usually linux.  Using current OS would
fail, for example, building python containers on MacOS because the
official Python base image has no darwin layer.
@knative knative deleted a comment from knative-prow bot Mar 24, 2025
@knative knative deleted a comment from codecov bot Mar 24, 2025
@knative knative deleted a comment from knative-prow bot Mar 24, 2025
@knative knative deleted a comment from codecov bot Mar 24, 2025
@knative knative deleted a comment from codecov bot Mar 24, 2025
@lkingland lkingland force-pushed the scaffolding-python branch 3 times, most recently from 7488267 to a51bd6a Compare March 25, 2025 13:38
@lkingland lkingland force-pushed the scaffolding-python branch from a51bd6a to 9ecb85c Compare March 25, 2025 13:53
@knative knative deleted a comment from knative-prow bot Mar 25, 2025
@knative knative deleted a comment from codecov bot Mar 26, 2025
Copy link

codecov bot commented Mar 26, 2025

Codecov Report

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

Project coverage is 62.64%. Comparing base (335b6c2) to head (9ecb85c).
Report is 2 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.59%   62.64%   +0.04%     
==========================================
  Files         131      131              
  Lines       15588    15921     +333     
==========================================
+ Hits         9758     9974     +216     
- Misses       4904     4995      +91     
- Partials      926      952      +26     
Flag Coverage Δ
e2e-test 34.98% <8.09%> (-0.88%) ⬇️
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.98% <7.68%> (?)
e2e-test-runtime-quarkus 25.46% <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.77% <50.46%> (+1.02%) ⬆️
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.

#!/bin/bash

function is_django_installed() {
python -c "import django" &>/dev/null
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DJ Ango is used for what?

@knative-prow-robot knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 27, 2025
@knative-prow-robot
Copy link

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@@ -0,0 +1,26 @@
[project]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is for poetry, right?

Would it make sense to have a requirements.txt as well - for pip?
Or would this not work?

I am not really an expert there, but would perhaps like in some section mentioned why pyproject / poetry vs pip ?

@matzew
Copy link
Member

matzew commented Mar 27, 2025

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

@@ -12,7 +12,7 @@ jobs:
continue-on-error: true
strategy:
matrix:
runtime: ["node", "go", "python", "quarkus", "springboot", "typescript", "rust"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why has been python removed here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/enhancement needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants