目录
1 模块与包的使用
- 模块与包
- 模块:一个py文件,被别的py文件导入使用,这个py文件称之为模块,运行的这个py文件称之为脚本文件
- 包:一个文件夹下有__init__.py
# 模块与包的导入问题
'''
0 导入模块有相对导入和绝对导入,绝对的路径是从环境变量开始的
1 导入任何模块,如果使用绝对导入,都是从环境变量开始导入起
2 脚本文件执行的路径,会自动加入环境变量
3 相对导入的话,是从当前py文件开始计算的
4 以脚本运行的文件,不能使用相对导入,只能用绝对导入
'''
./ 当前目录。
../ 父级目录。
/ 根目录。
2 断言
assert hasattr(self, 'initial_data'), (
'Cannot call `.is_valid()` as no `data=` keyword argument was '
'passed when instantiating the serializer instance.'
)
语法和使用
# 断定某个东西是我认为的,如果不是就抛异常
语法格式:
"""
assret 判断条件, Exception('异常信息')
-其中的Exception可以是省略不写
-等同于if判断+抛异常
"""
例子:
def add(a, b):
return a + b
res = add(8, 9)
assert res == 16, Exception('不等于16')
print('随便')
# 就等同于if判断+抛异常:
def add(a, b):
return a + b
res = add(8, 9)
if not res==16:
raise Exception('不等于16')
print('随便')
3 drf之请求
目前,drf已经学习过的
# 视图类:APIView
# 序列化组件:Serializer,ModelSerializer
# drf:Request类的对象
# drf:Response
3.1 Request类对象的分析
3.1.1 Request
REST framework 传入视图的request对象不再是Django默认的HttpRequest对象,而是REST framework提供的扩展了HttpRequest类的Request类的对象。
REST framework 提供了Parser解析器,在接收到请求后会自动根据Content-Type指明的请求数据类型(如JSON、表单等)将请求数据进行parse解析,解析为类字典[QueryDict]对象保存到Request对象中。
Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。
无论前端发送的哪种格式的数据,我们都可以以统一的方式读取数据。
3.1.2 属性
1).data
- request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性,但提供如下特性:
- 包含了解析之后的文件和非文件数据
- 包含了对POST、PUT、PATCH请求方式解析后的数据
- 利用了REST framework的parsers解析器,不仅支持表单类型数据,也支持JSON数据
2).query_params
- request.query_params与Django标准的request.GET相同,只是更换了更正确的名称而
3) 其他的属性用起来跟之前一样
3.2 请求,能够接受的编码格式
# urlencoded
# form-data
# json
三种都支持
限制只能接受某种或某几种编码格式
# 限制方式一:在视图类上写---> 只是局部视图类有效
# 总共有三个:JSONParser, FormParser, MultiPartParser
# json格式 urlencoded form-data
class BookView(APIView):
parser_classes = [JSONParser, FormParser]
# 限制方式二:在配置文件中写---> 全局有效
# drf的配置,统一写成它
REST_FRAMEWORK = {
'DEFAULT_PARSER_CLASSES': [
'rest_framework.parsers.JSONParser',
# 'rest_framework.parsers.FormParser',
# 'rest_framework.parsers.MultiPartParser',
],
}
# 全局配置了只支持json,局部想支持3个
-只需要在局部,视图类中,写3个即可
class BookView(APIView):
parser_classes = [JSONParser, FormParser, MultiPartParser]
# 总结:能够处理的请求方式编码
-优先从视图类中找
-再去项目配置文件找
-再去drf默认的配置中找
4 drf之响应
4.1 响应类的对象Response
4.1.1 Response
rest_framework.response.Response
REST framework提供了一个响应类Response,使用该类构造响应对象时,响应的具体数据内容会被转换(render渲染)成符合前端需求的类型。
REST framework提供了Renderer 渲染器,用来根据请求头中的Accept(接收数据类型声明)来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明,则会采用默认方式处理响应数据,我们可以通过配置来修改默认响应格式
4.1.2 属性
Response(data, status=None, template_name=None, headers=None, content_type=None)
参数:
# return Response({code:100})
-data:响应体的内容,可以字符串,字典,列表
-status:http响应状态码
-drf把所有响应码都定义成了一个常量
template_name:模板名字,用浏览器访问,看到好看的页面,用postman访问,返回正常数据
-自定制页面
-根本不用
headers:响应头加数据(后面讲跨域问题再讲)
-headers={'name':'lqz'}
content_type:响应编码,一般不用
# 三个重要的:data,status,headers
4.2 响应的格式
# 默认是两种:纯json,浏览器看到的样子
# 限制方式一:在视图类上写---> 只是局部视图类有效
# 总共有两个:JSONRenderer,BrowsableAPIRenderer
from rest_framework.renderers import JSONRenderer,BrowsableAPIRenderer
class BookView(APIView):
renderer_classes = [JSONRenderer]
# 限制方式二:在配置文件中写---> 全局有效
# drf的配置,统一写成它
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': [
'rest_framework.renderers.JSONRenderer',
# 'rest_framework.renderers.BrowsableAPIRenderer',
],
}
# 全局配置了只支持json,局部想支持2个
-只需要在局部,视图类中,写2个即可
from rest_framework.renderers import JSONRenderer,BrowsableAPIRenderer
class BookView(APIView):
renderer_classes = [JSONRenderer,BrowsableAPIRenderer]
# 总结:能够处理的响应的格式
-优先从视图类中找
-再去项目配置文件找
-再去drf默认的配置中找
4.3 状态码
为了方便设置状态码,REST framewrok在rest_framework.status模块中提供了常用状态码常量。
使用时,即可以直接写常量了
Response({'status': HTTP_200_OK})
1)信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
2)成功 - 2xx
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS
3)重定向 - 3xx
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT
4)客户端错误 - 4xx
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
5)服务器错误 - 5xx
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
5 视图之两个视图基类
两个视图基类有:
# 视图类:
-APIView:之前用过
-GenericAPIView:GenericAPIView继承了APIView
GenericAPIView的使用
# GenericAPIView
-类属性:
queryset:要序列化的所有数据
serializer_class:序列化类
lookup_field = 'pk' :查询单条时的key值
-方法:
-get_queryset():获取所有要序列化的数据【后期可以重写】
-get_serializer : 返回序列化类【后期可以重写,指定要序列化的类是哪一个】
-get_object :根据pk,获取单个对象,没有返回404
#总结:以后继承GenericAPIView写接口
1 必须配置类属性
queryset
serializer_class
2 想获取要序列化的所有数据
get_queryset()
3 想使用序列化类:
get_serializer
4 想拿单条
get_object
拓展:
get_queryset():其实就是把queryset返回出去了。但为什么要写这个方法呢?
# 写成方法的目的:增加扩展性。
可以在自己的类中重写这个方法。可以根据某个条件返回不同的值,这样能够序列化的数据就变多了,是动态的,而不是写死的。
eg:
def get_queryset(self):
if 某种条件:
return self.queryset
elif 另一个条件:
return Book.objects.all()
5.1 使用APIView+序列化类+Response写接口
from rest_framework.views import APIView
from .serializer import BookSerialzier
from rest_framework.response import Response
from .models import Book
class BookView(APIView):
def get(self, request):
qs = Book.objects.all()
ser = BookSerialzier(qs, many=True)
return Response({'code': 100, 'msg': '成功', 'results': ser.data})
def post(self, request):
ser = BookSerialzier(data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '成功'})
else:
return Response({'code': 100, 'msg': ser.errors})
class BookDetailView(APIView):
def get(self, request, pk):
book = Book.objects.all().get(pk=pk)
ser = BookSerialzier(book)
return Response({'code': 100, 'msg': '成功', 'results': ser.data})
def put(self, request, pk):
book = Book.objects.get(pk=pk)
ser = BookSerialzier(data=request.data, instance=book)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '更新成功'})
else:
return Response({'code': 100, 'msg': ser.errors})
5.2 推导GenericAPIView如何使用
# 咱们写的,伪代码
# 定义一个GenericAPIView类继承APIView
class GenericAPIView(APIView):
query_set = None
serialzier_class = None
def get_queryset(self):
return self.query_set
def get_serializer(self):
return self.serialzier_class
def get_object(self):
return self.query_set.filter(pk=pk)
# 人家写的
# from rest_framework.generics import GenericAPIView
class BookView(GenericAPIView):
queryset = Book.objects.all()
serializer_class = BookSerialzier
def get(self, request):
qs = self.get_queryset()
ser = self.get_serializer(qs, many=True)
return Response({'code': 100, 'msg': '成功', 'results': ser.data})
def post(self, request):
ser = self.get_serializer(data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '成功'})
else:
return Response({'code': 100, 'msg': ser.errors})
class BookDetailView(GenericAPIView):
queryset = Book.objects.all()
serializer_class = BookSerialzier
def get(self, request, pk):
book = self.get_object()
ser = self.get_serializer(book)
return Response({'code': 100, 'msg': '成功', 'results': ser.data})
def put(self, request, pk):
book = self.get_object()
ser = self.get_serializer(data=request.data, instance=book)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '更新成功'})
else:
return Response({'code': 100, 'msg': ser.errors})
5.3 使用GenericAPIView+序列化类+Response写接口
from rest_framework.generics import GenericAPIView
class BookView(GenericAPIView):
# queryset = Book.objects # 可以不用加,但最好加上
queryset = Book.objects.all() #
serializer_class = BookSerialzier #
# lookup_field = 'id'
def get(self, request):
# qs = self.queryset # 这个函数中也可以这么写
qs = self.get_queryset() #
ser = self.get_serializer(qs, many=True) #
return Response({'code': 100, 'msg': '成功', 'results': ser.data})
def post(self, request):
ser = self.get_serializer(data=request.data) #
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '成功'})
else:
return Response({'code': 100, 'msg': ser.errors})
class BookDetailView(GenericAPIView):
queryset = Book.objects.all() #
serializer_class = BookSerialzier #
def get(self, request, pk):
book = self.get_object() #
ser = self.get_serializer(book) #
return Response({'code': 100, 'msg': '成功', 'results': ser.data})
def put(self, request, pk):
book = self.get_object() #
ser = self.get_serializer(data=request.data, instance=book) #
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '更新成功'})
else:
return Response({'code': 100, 'msg': ser.errors})
# 再写publish有关的,就可以复制上面的,改动两个类的名字,改动两个类属性就行
queryset = Publish.objects.all()
serializer_class = PublishSerialzier