Update the handler to match style of golang-http-template by kturcios · Pull Request #16 · openfaas/python-flask-template

kturcios · 2019-02-21T18:18:40Z

Description

Update the template to match the (event, context) style of the golang-http-template.
Add dev build options
Update README with instructions on how to use the template
Add waitress as the production server

Motivation and Context

This will allow users to return custom responses for their functions.

I have raised an issue to propose this change (required)

Which issue(s) this PR fixes

Fixes #8
Fixes #15
Resolves #12

How Has This Been Tested?

All examples in README were built and tested for expected responses for python3-http
All examples in README were built and tested for expected responses for python3-http-armhf

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I've read the CONTRIBUTION guide
I have signed-off my commits with git commit -s
I have added tests to cover my changes.
All new and existing tests passed.

Signed-off-by: Kevin Turcios kevin_turcios@outlook.com

- Created two new templates, python3-http & python3-http-armhf - Added waitress as the production server for new templates Signed-off-by: Kevin Turcios <kevin_turcios@outlook.com>

pcorbel · 2019-02-25T09:43:23Z

README.md

+$ curl -i $OPENFAAS_URL/function/<fn-name>
+```
+
+## Event and Context Data


Is there an "official doc" where the contract with the watchdog is explained?
The goal is to know which field is mandatory, and which is not

Hi @pcorbel how is this question related to the Python template?

pcorbel · 2019-02-25T09:46:30Z

template/python3-http-armhf/Dockerfile

@@ -0,0 +1,48 @@
+FROM armhf/python:3.6-alpine


The stock image 'library/python:3.6-alpine' is compatible with ARM.
So we can use

FROM python:3.6-alpine

and if the image is build on ARM, the ARM version will be pulled.
Tested on Raspberry pi OK 👍

Oh I had no idea about that! You've tested it on the Raspberry Pi already?

Yes I've tested and it ran successfully

I just tried this and it failed. How were you able to run the image on your Raspberry Pi? Did you have to make any other changes?

Tried what / what failed? Give steps please so we can try too.

This appears to work for me on armhf:

docker run -ti python:3.6-alpine /bin/sh

I tried building the template with python:3.6-alpine and deploying it on the rpi, but the watchdog fails with the message Error reading stdout: EOF.

pcorbel · 2019-02-25T09:47:56Z

template/python3-http-armhf/index.py

@@ -0,0 +1,68 @@
+from flask import Flask, request, jsonify


No header?
I think it would be a good practice to put

#!/usr/bin/env python # -*- coding: utf-8 -*-

everywhere

I'm unfamiliar with this so I'll take a look into it

We haven't done this elsewhere so please propose it generically @pcorbel in a separate issue.

pcorbel · 2019-02-25T09:49:39Z

template/python3-http/Dockerfile

@@ -0,0 +1,48 @@
+FROM python:3.7-alpine


Why base python3-http on 3.7 and python-http-armhf on 3.6?
I think it would be a good idea to sync the two of them

alexellis · 2019-03-02T19:44:05Z

Hi, is this still WIP?

Signed-off-by: Kevin Turcios <kevin_turcios@outlook.com>

kturcios · 2019-03-03T17:40:20Z

It should be ready now

alexellis · 2019-03-03T21:43:31Z

README.md

+=============================================

-Python OpenFaaS template with Flask
+The Python Flask templates make use of the incubator project [of-watchdog](https://github.com/openfaas-incubator/of-watchdog) to handle higher throughput than the [classic watchdog](https://github.com/openfaas/faas/tree/master/watchdog) due to the process being kept warm.


I think this is technically correct but confusing / too-much-info for the people who may read it.

to handle higher throughput than the classic watchdog due to the process being kept warm.

alexellis · 2019-03-03T21:43:41Z

README.md

-faas template pull https://github.com/openfaas-incubator/python-flask-template
-faas new --list
-Languages available as templates:
+Templates available under this repository:


under->in

alexellis · 2019-03-03T21:44:22Z

README.md

 - python3-flask
-```
+- python3-flask-armhf
+- python3-http*


python3-http* - why the suffix *?

alexellis · 2019-03-03T21:44:44Z

README.md


-Generate a function with one of the languages:
+Notes: 
+- The templates listed with an asterik are the only ones that support additional control over the HTTP response and provide access to HTTP request details.


Not necessary to explain this, just show it in the examples.

alexellis · 2019-03-03T21:45:39Z

README.md

+By default, flask will automatically attempt to set the correct Content-Type header for you based on the type of response. 

-# Wait a couple of seconds then:
+For example, returning a dict object type will automatically attach the header `Content-Type: application/json` and returning a string type will automatically attach the `Content-Type: text/html, charset=utf-8` for you.


Should we mention flask given that this is not visible to the user? the template will?

alexellis · 2019-03-03T21:46:14Z

README.md


-echo -n content | faas invoke myfunction
+## Example usage
+### Custom Status Codes and Response Bodies


Why is Bodies capitalisedbutExample usage` isn't?

Sentence case should be fine for both

Signed-off-by: Kevin Turcios <kevin_turcios@outlook.com>

smoynes-tc · 2019-03-14T13:38:49Z

template/python3-http/Dockerfile

+
+ARG ADDITIONAL_PACKAGE
+# Alternatively use ADD https:// (which will not be cached by Docker builder)
+RUN apk --no-cache add curl ${ADDITIONAL_PACKAGE} \


As a user, I'd like to be able to install build dependencies and have them removed after pip installs dependencies.

Is that possible?

Some build dependencies generate .so libraries which are needed in the deployment / runtime container.

dschulten · 2019-04-04T09:49:41Z

template/python3-http-armhf/index.py

+        self.headers = request.headers
+        self.method = request.method
+        self.query = request.args
+        self.path = request.path


Please also ad request.files and request.form - they are needed for multipart/form-data requests. The request.files attribute is an ImmutableMultiDict of FileStorage (which is a file-ish ducktype), and form is an ImmutableMultiDict of strings which represent the textual multiparts which have no filename in their content-disposition. Maybe make a plain dictionary of lists from the MultiDict, to abstract away the Flask api.

That would make my pull request obsolete.

That won't be added at this time, but feel free to propose it as an issue.

alexellis · 2019-04-04T11:12:54Z

@kturcios I'm going to merge this and would like the comments followed-up in a separate PR.

Please also upgrade the watchdogs to the latest possible version.

Thank you for working on this template 💯

derek bot added the new-contributor label Feb 21, 2019

Update the handler to match style of golang-http-template

cd97260

- Created two new templates, python3-http & python3-http-armhf - Added waitress as the production server for new templates Signed-off-by: Kevin Turcios <kevin_turcios@outlook.com>

pcorbel reviewed Feb 25, 2019

View reviewed changes

Sync python versions for http templates and add headers

ffcfb17

Signed-off-by: Kevin Turcios <kevin_turcios@outlook.com>

kturcios changed the title ~~[WIP] Update the handler to match style of golang-http-template~~ Update the handler to match style of golang-http-template Mar 3, 2019

alexellis reviewed Mar 3, 2019

View reviewed changes

README.md Outdated

- python3-flask

```

- python3-flask-armhf

- python3-http*

Copy link

Member

alexellis Mar 3, 2019

Choose a reason for hiding this comment

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

python3-http* - why the suffix *?

alexellis reviewed Mar 3, 2019

View reviewed changes

Update README

937ed2d

Signed-off-by: Kevin Turcios <kevin_turcios@outlook.com>

smoynes-tc reviewed Mar 14, 2019

View reviewed changes

dschulten reviewed Apr 4, 2019

View reviewed changes

alexellis merged commit 79e29c4 into openfaas:master Apr 4, 2019

kturcios deleted the event-context-model branch April 6, 2019 17:48

Conversation

kturcios commented Feb 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

Which issue(s) this PR fixes

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexellis Mar 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexellis commented Mar 2, 2019

Uh oh!

kturcios commented Mar 3, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dschulten Apr 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexellis commented Apr 4, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kturcios commented Feb 21, 2019 •

edited

Loading

alexellis Mar 3, 2019 •

edited

Loading

dschulten Apr 4, 2019 •

edited

Loading