kobinpy/kobin

Type Hints friendly web framework for Python3.6+

kobin's Issues

Before / After request hooks

I want to offer before/after request hooks like this:

from kobin import Kobin, request

app = Kobin()


@app.before_request
def before_request():
    print('Before request hook')

But it's just an idea. Your opinion are required.

Dynamic routing

Implement a static file server

In production, we use a nginx to return static files (ex. css, images, ... and so on).
But, in development, We want to use a static file server.

caching with functools.lru_cache

http://docs.python.jp/3/library/functools.html#functools.lru_cache

Use pathlib

Summary

http://docs.python.jp/3/library/pathlib.html

Refactor using config object.

In #15 , Add BASE_DIR, TEMPLATE_DIRS, and so on.
But these implementations are not great. So REFACTORING it!

Implement request, response object

Error handling with functools.singledispatch

http://docs.python.jp/3/library/functools.html#functools.singledispatch

WebSocket support

combine async/await syntax.

References

WebSocket implementation in Python

• https://github.com/aaugustin/websockets
• https://github.com/KeepSafe/aiohttp
  • https://github.com/KeepSafe/aiohttp/blob/master/aiohttp/websocket.py
  • http://stackabuse.com/python-async-await-tutorial/
• https://github.com/Lawouach/WebSocket-for-Python
• methaneさんの比較記事(2013/02)

WebSocket usage

• http://pawelmhm.github.io/python/2015/02/15/creating-realtime-scraper.html
• http://pawelmhm.github.io/python/websockets/2016/01/02/playing-with-websockets.html
• http://postd.cc/websockets-caution-required/

About async/await syntax

• ja: https://www.youtube.com/watch?v=R5jNZCJWHyI
  • aiohttpがasyncioを使った綺麗な実装らしい
• http://www.snarky.ca/how-the-heck-does-async-await-work-in-python-3-5
• http://masnun.com/2015/11/13/python-generators-coroutines-native-coroutines-and-async-await.html
  • ja: http://postd.cc/python-generators-coroutines-native-coroutines-and-async-await/
• http://www.pythonsandbarracudas.com/blog/2015/11/22/developing-a-computational-pipeline-using-the-asyncio-module-in-python-3
• http://makina-corpus.com/blog/metier/2015/python-http-server-with-the-new-async-await-syntax
• ja: http://qiita.com/yasunori/items/03229bfa161e6dc2ea61
• methaneさんのasyncioの解説
• http://docs.python.jp/3/library/asyncio.html
• http://qiita.com/Lspeciosum/items/98e05c7495369ab9d102

Expect the types of routing arguments from type hints

In the following sample code, There is duplicate between types of routing and type hints because\w+ means str.

@app.route('^/user/(?P<name>\w+)/$')
def hello(name: str):
    return "Hello {}".format(name)

So I'd like to write like the following code.

@app.route('^/user/<name>/$')
def hello(name: str):
    return "Hello {}".format(name)

Add a web session function.

In a bottle framework, the documentation says "using a Beaker".

• http://bottlepy.org/docs/dev/recipes.html
• https://github.com/bbangert/beaker

Add japanese docs

• http://www.sphinx-doc.org/en/stable/intl.html

Update

$ make gettext
$ sphinx-intl update -p build/locale
# edit doc/source/locale/*.po files
$ make -e SPHINXOPTS="-D language='ja'" html

Error handling

• HTTPError class
  • It only raise exception for now.
• Error page
  • when content-type is text/json, return the error status and message in json style.
  • when content-type is text/html, return the error status and message in html.
  • others: only message.
• http://postd.cc/choosing-an-http-status-code/

CSRF token generator

Helper for reading a boolean property from environment variables

like:

https://github.com/Pylons/pyramid/blob/master/pyramid/settings.py

Class based views

for improving reusability.

• View
• ModelView
• JsonResponseView
• TemplateView

refs.

• http://ccbv.co.uk/
• http://flask.pocoo.org/docs/0.10/views/

Cookie handling

http://docs.python.jp/3/library/http.cookies.html

CONTENT_LENGTH exception if 'CONTENT_LENGTH' = ''

Summary

• Same with c-bata/webframework-in-python#11

Expected Behavior

$ curl -d '{"key":"value"}' -X POST http://127.0.0.1:8000/user/
User Created
$ curl -X POST http://127.0.0.1:8000/user/
User Created

Actual Behavior

$ curl -d '{"key":"value"}' -X POST http://127.0.0.1:8000/user/
User Created
$ curl -X POST http://127.0.0.1:8000/user/
A server error occurred.  Please contact the administrator.

Environment

• omit

Related Issue(Optional)

• c-bata/webframework-in-python#11

Refactor config object

• make global and remove from request object
• cannot write using property

Create a document using sphinx

• Read the docs
• sphinx
• logo image
• Google Analytics

Use Context Variables(PEP 567) as a threading.local replacement

Summary

Replace threading.local with Context Variables that will be added from Python 3.7.
https://www.python.org/dev/peps/pep-0567/

Make exception handler to WSGI middleware

To use werkzeug debugger.

plugin system

Type Hints for query parameters.

Summary

I want to exploit type hints for converting query parameters.

Description

IDEA 1

from kobin import Kobin, Response, Param

app = Kobin()

@app.route('/tasks/{task_id}')
def index(task_id: int, query_done: Param[bool]) -> Response:
    return Response('Hello World')

IDEA 2

from kobin import Kobin, Response, query_param

app = Kobin()

@app.route('/tasks/{task_id}')
@query_param('query_done')
def index(task_id: int, query_done: bool) -> Response:
    return Response('Hello World')

Add redirect function

Modify URL Dispatcher

URL Dispatcher like matcha

A URL Dispatch with regex has high flexibility. But, In the most of the case, It isn't need.
So I suggest matcha like url dispatch with type hints.

It is a simple both the web framework developer and users.

@app.route('/post/{post_id}')
def post_detail(post_id: int):
    assert isinstance(post_id, int)

Converters like WebDispatch

@app.route('/post/{post_id}', converter=lambda id: Post.objects.get(id))
def post_detail(post: Post):
    template('post_detail.html', post=post)

Other references

• https://github.com/aodag/WebDispatch/tree/master/webdispatch
• https://github.com/django/django/blob/master/django/urls/resolvers.py
  • https://docs.djangoproject.com/es/1.9/ref/urlresolvers/
• https://github.com/Pylons/webob/blob/master/webob/dec.py

Refactor and Add Tests for error status

• http://postd.cc/choosing-an-http-status-code/

Custom Request/Response class

Now, kobin always uses kobin.environs.request as a request. So we can use only LocalRequest.

Similarly, We can use only LocalResponse as a response.

However, I want to use a custom request/response like this:

import yaml
from kobin import Kobin
from kobin.environs import LocalRequest
from .environs import MyRequest, MyResponse

app = Kobin()
app.config['REQUEST_CLASS'] = MyRequest
app.config['RESPONSE_CLASS'] = MyResponse

NOTE: It's a just idea. Probably, there are better ways.

Remove run method and server adapter and static file serving and implement CLI

Remove static file serving

Because, it requires in development only. And it is not match new routing system.
Use wsgi-static-middleware

Remove run method

Because it is not compatible with wsgi middleware.

Add CLI

Because, it can offer previous function like this:

$ kobin myapp:app --server wsgiref --port 8000 --staticroot /static --staticdirs 

default:

• server: wsgiref
• port : 8080
• staticroot : `app.config['STATIC_ROOT']
• staticdirs : `app.config['STATICFILES_DIRS']

Progress

• remove serving static files
• remove server adapters
• Add CLI

Add tutorial and topic page.

Topic page

• templates
• static files
• WSGI servers
• Request, Response

Authentication Plugin with secrets module in Python3.6

secret module is added by Python3.6

https://docs.python.org/3.6/whatsnew/3.6.html#secrets

Clean requirements and add constraints.txt

Support jinja2.

Implement a template adapter for jinja2.

Update a documentation

• Kobin class
• Request
• Response
• Routing
• Tutorial
• Fix the autodoc problem on ReadTheDocs

Create a nice logo image for Kobin

Hmmm...

Add the topic about configurations on documents.

$ kobin-manager startproject myproject

$ python manage.py runserver  # Use conf.py on project root.
$ python manage.py runserver  --settings=settings.local
$ python manage.py runserver  --settings=settings.prod

Refactor view roles.

view should has only function that receives request and returns response object. But now, view return bytes or str object (ref. https://github.com/c-bata/kobin/blob/master/kobin/app.py#L42 ).

Integrate logging module.

Replace old-style classes to new style classes.

In this framework, the supported python version is 3.5 only.
So we should use new-style classes.

class Hoge:
    pass

Support gunicorn server.

Refactor router

refs #66

Multiple after / before request hook.

Summary

@app.before_request
def before1():
    pass

@app.before_request
def before2():
    pass

@app.before_request
def before3():
    pass

Plugin system using PEP487 added by Python 3.6

https://docs.python.org/3.6/whatsnew/3.6.html#pep-487-simpler-customization-of-class-creation

Replace header handling with wsgiref.headers

https://docs.python.org/3/library/wsgiref.html#wsgiref.headers.Headers

>>> from wsgiref import headers
>>> headers.Headers
<class 'wsgiref.headers.Headers'>
>>> headers.Headers()
Headers([])
>>> h = headers.Headers()
>>> h.add_header('content-type', 'text/html')
>>> h
Headers([('content-type', 'text/html')])

Reverse routing with next url endpoint

Summary

Sometimes, we want to set query_parameters when redirecting like:

• http://flask.pocoo.org/docs/0.12/patterns/viewdecorators/

Caution

This option bumped with url variables.

@app.route('/foo/{next}')
def foo(next: str) -> Response:
    return Response('foo')

Update for mypy 0.4

http://mypy-lang.blogspot.jp/2016/05/mypy-04-released.html

• --fast-parser enables the new, faster parser (see above). This is still experimental but worth a try!
• --disallow-untyped-defs generates errors for functions without type annotations. Consider using this if you tend to forget to annotate some functions.
• --disallow-untyped-calls causes mypy to complain about calls to untyped functions. This is a boon for static typing purists, together with --disallow-untyped-defs :-)
• --line-count-report DIRECTORY generates a report of annotated line counts.
• --almost-silent behaves like --silent-imports, but it also reports every module that was silently ignored. This is useful for troubleshooting if mypy doesn’t seem to find all the code you are expecting.

Don't exec and use SourceFileLoader

https://twitter.com/podhmo/status/782398058319400960