django-render-url 0.10

a very light django plugin

Django Render
=============
0. [开始](#0-开始)
1. [简介](#1-简介)
2. [安装](#2-安装)
3. [用法](#3-用法)
4. [注意](#4-注意)
5. [交流](#5-交流)
6. [联系](#6-联系)
7. [待续](#7-待续)

##0. 开始

一个非常轻量的 Django URL 装饰器

```python
from django_render.annotations import *

@url(r'^/index$', method=M.POST)
@post(text=str)
def index(request, text):
return {'hello': text}
```

##1. 简介

基于Python 2.7 重新定义 Django url 的用法，使用@语法可以轻松定义出 RESTful 风格的 url，也可以用于声明 HTTP GET/POST 参数。也可以用于用户认证拦截。自动识别返回类型 HttpResponse, JSON, google-protobuf

##2. 安装
使用 pip:

pip install django-render-url

##3. 用法

###3.1. 定义url
在urls.py中的定义:

```python
from django.conf.urls import patterns, include, url

urlpatterns = patterns('',
url(r'^', include('mysite.views')),
)
```

在views.py中声明:

```python
@url(ur'^/hello$')
def link(request):
...
return True
```

在views 是一个package 的情况下，可以使用url自动扫描:

```python
from django_render.url_patterns_maker import urlpatterns_maker
urlpatterns = urlpatterns_maker()
```
上面的代码放到views/\_\_init\_\_.py 中, 就可以自动将views/下面其他的python file name 作为url 的一级目录。如果有特殊名字映射需求可以如下写法：

```python
from django_render.url_patterns_maker import urlpatterns_maker
urlpatterns = urlpatterns_maker(default='^', profile='^my/')
```

等同于如下写法：
```python
urlpatterns = patterns('',
url(ur'^', include('chooper_api.views.default')),
url(ur'^my/', include('chooper_api.views.profile')),
url(ur'^friend/', include('chooper_api.views.friend')),
url(ur'^feed/', include('chooper_api.views.feed')),
)

```

note that unspecified views(friend.py and feed.py here) got their file name(without extension,
and surrounded by '^' and '/') as the url regex

定义 GET|POST /index:

```python
@url(r'^/index$')
```

定义 GET /index:

```python
@url(r'^/index$', method=M.GET)
```

定义 POST|PUT /name:

```python
@url(r'^/name$', method=[M.POST, M.PUT])
```

需要分别处理的 POST /name , PUT /name:

```python
@url(r'^/name$', method=M.POST)
def post_name(request):
...

@url(r'^/name$', method=M.PUT)
def put_name(request):
...
```

RESTful Style URL:

```python
@url(r'^/blog/$', method=M.GET)
def get_blog_list(request):
...

@url(r'^/blog/(?P<id>\d+)$', method=M.GET)
def get_specific_blog(request, id):
...

@url(r'^/blog/$', method=M.POST)
@post(text=str)
def post_a_blog(request, text):
...

@url(r'^/blog/(?P<id>\d+)$', method=M.PUT)
@post(text=str)
def change_a_blog_text(request, id, text):
...
```

###3.2. 声明HTTP参数

GET/POST 参数:

```python
@get(id=int)
@post(name=str)
```

在方法上接收:

```python
def hello(request, id, name):
...
```

更灵活的使用方法, 以GET为例:

```python
@get('param1', 'param2')
'''
HTTP参数: param1, param2
方法实参: param1, param2
类型: str
默认值: 无
'''

@get(param1=int)
'''
HTTP参数: param1
方法实参: param1
类型: int
默认值: 无
'''

@get(param1=(int, 0))
'''
HTTP参数: param1
方法实参: param1
类型: int
默认值: 0
'''

@get(param1=('param_name', int, 0))
'''
HTTP参数: param_name
方法实参: param1
类型: int
默认值: 0
'''
```

语义化的用法:

```python
@get(param1={'name':'parameter_name', 'type':int, 'default':0})
@get(param1={'type':int, 'default':0})
@get(param1={'type':int })
```

参数类型除了可以转换成:

```python
str, int, bool
```

还支持array:

```python
Type.int_list, Type.str_list, Type.json
```

方法如下:

```python
@get(ids=Type.int_list, names=Type.str_list, extrs=Type.json)
```

其中 Type.int_list 和 Type.str_list, Value应构造成 ids=1,2,3 和 name=Bob,Johns,Peter, 或者 id=1&id=2&id=3 也可以

上传文件file type

```python
@post(image=Type.file)
```

###3.3. 返回类型

如果 return HttpResponse 或其子类，则直接返回到客户端

如果希望返回Json 数据类型

```python
...
return True
# {'rt':true, 'message':''}

...
return False
# {'rt':false, 'message':''}

...
return False, ErrorCode.code1 # requires enum34 # from enum.enum import Enum; class ErrorCode(Enum): pass
# {'rt':false, 'message':1}

...
return True, {'data': ...}
# {'rt':true, 'data': ...}

...
return True, 'message content'
# {'rt':true, 'message':'message content'}

...
return {'data':'xxx', 'num':1, 'other':[{...},...]}
# {'data':'xxx', 'num':1, 'other':[{...},...]}

...
return []
# []

...
return # direct return
# {}

...
return 'message content'
# {'message':'message content'}
```

###3.4. 用户认证

```python
# /hello?access_secret_key=The_Key_Only_You_Know
@login_required(access_secret_key='The_Key_Only_You_Know', login_page='/login.html', check_auth=check_auth)
```

全局定义参数:

```python
## in settings.py
from django_render
...
django_render.global_access_secret_key = 'The_Key_Only_You_Know'
django_render.global_login_page = '/login.html'

## in views.py
@login_required
```

复杂的登录拦截器:

```python
def read_user_interceptor(request):
...
if success:
return user
else:
return None

...

@url(r'^/hello$')
@login_required(read_user_interceptor=read_user_interceptor)
def hello(request, user):
'''
@param request: MUST BE EXIST!
@param user: MUST BE EXIST!
'''
return True, {'user': user.name}
```

全局定义 read_user_interceptor:

```python
#in settings.py
from django_render

def read_user_interceptor(request):
...
if success:
return user
else:
return None

django_render.global_read_user_interceptor = read_user_interceptor

## in views.py
@login_required
```

如果是Ajax类型的请求

```python
@login_required(is_ajax=True)
#如果登录失败，不会跳转到 login page, 而是返回 {'rt':false, 'message':'login first'}
```

##4. 注意

> @url() 并不是真正 django 的 url 方法，但因为是在基础上的封装，所以 django url 的其他用法 @url() 也同样支持

##5. 交流

* mail list: [e-mail]
* qq group id: 7790075

##6. 联系

* email: [e-mail]
* twitter: wang_tai

##7. 待续

1. 自动识别google-protobuf
2. 支持 Form, Ajax 使用 PUT/DELETE/...