Проблема проверки Flask sqlAlchemy с flask_Marshmallow
Используя flask_marshmallow для проверки входных данных, с sche.load(), я не могу зафиксировать ошибки, сгенерированные декоратором @validates в модели
Я зафиксировал результат и ошибки в ресурсе, но ошибки отправляются непосредственно пользователям.
========== ========== model.py
```python
from sqlalchemy.orm import validates
from sqlalchemy import Column, ForeignKey, Integer, String, DateTime
from sqlalchemy.orm import relationship, backref
from sqlalchemy import create_engine
from sqlalchemy.sql import func
from flask_marshmallow import Marshmallow
from flask_sqlalchemy import SQLAlchemy
from datetime import datetime
from sqlalchemy.orm import joinedload
db = SQLAlchemy()
ma = Marshmallow()
class Company(db.Model):
__tablename__ = "company"
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(250), nullable=False)
addressLine1 = db.Column(db.String(250), nullable=False)
addressLine2 = db.Column(db.String(250), nullable=True)
city = db.Column(db.String(250), nullable=False)
state = db.Column(db.String(250), nullable=False)
zipCode = db.Column(db.String(10), nullable=False)
logo = db.Column(db.String(250), nullable=True)
website = db.Column(db.String(250), nullable=False)
recognition = db.Column(db.String(250), nullable=True)
vision = db.Column(db.String(250), nullable=True)
history = db.Column(db.String(250), nullable=True)
mission = db.Column(db.String(250), nullable=True)
jobs = relationship("Job", cascade="all, delete-orphan")
def save_to_db(self):
db.session.add(self)
db.session.commit()
@validates('name')
def validate_name(self, key, name):
print("=====inside validate_name=======")
if not name:
raise AssertionError('No Company name provided')
if Company.query.filter(Company.name == name).first():
raise AssertionError('Company name is already in use')
if len(name) < 4 or len(name) > 120:
raise AssertionError('Company name must be between 3 and 120 characters')
return name
```
========== schemas_company.py==============
```python
from ma import ma
from models.model import Company
class CompanySchema(ma.ModelSchema):
class Meta:
model = Company
```
============= resources_company.py
```python
from schemas.company import CompanySchema
company_schema = CompanySchema(exclude='jobs')
COMPANY_ALREADY_EXIST = "A company with the same name already exists"
COMPANY_CREATED_SUCCESSFULLY = "The company was sucessfully created"
@api.route('/company')
class Company(Resource):
def post(self, *args, **kwargs):
""" Creating a new Company """
data = request.get_json(force=True)
schema = CompanySchema()
if data:
logger.info("Data got by /api/test/testId methd %s" % data)
# Validation with schema.load() OPTION_2
company, errors = schema.load(data)
print(company)
print(errors)
if errors:
return {"errors": errors}, 422
company.save_to_db()
return {"message": COMPANY_CREATED_SUCCESSFULLY}, 201
```
=========== ЗАПРОС ==========
Это запрос POST от пользователя
{
"name": "123",
"addressLine1": "400 S Royal King Ave",
"addressLine2": "Suite 356",
"city": "Miami",
"state": "FL",
"zipCode": "88377",
"logo": "This is the logo",
"website": "http://www.python.com",
"recognition": "Most innovated company in the USA 2018-2019",
"vision": "We want to change for better all that needs to be changed",
"history": "Created in 2016 with the objective of automate all needed process",
"mission": " Our mission is to find solutions to old problems"
}
==== ОПИСАНИЕ ВЫПУСКА ======
Вышеупомянутый запрос POST генерирует исключение AssertionError согласно функции validate_name в model.py, как показано ниже:
File "code/models/model.py", line 95, in validate_name
raise AssertionError('Company name must be between 3 and 120 characters')
AssertionError: Company name must be between 3 and 120 characters
127.0.0.1 - - [30/Dec/2018 13:44:58] "POST /api/company HTTP/1.1" 500 -
Таким образом, ответ, который возвращается пользователю, это бесполезные сообщения об ошибках.
{
"message": "Internal Server Error"
}
Мой вопрос:
Что мне нужно сделать, чтобы поднятое сообщение AssertionError было отправлено пользователям вместо этого ужасного сообщения об ошибке?
AssertionError message
{
"message": "Company name must be between 3 and 120 characters"
}
Exception
{
"message": "Internal Server Error"
}
Я думал, что ошибка будет захватывать исключение, сгенерированное @validates('name'), но похоже, что это не так.
4 ответа
Я нашел решение своей проблемы. Я изменил схему как показано ниже:
from ma import ma
from models.model import Company
from marshmallow import fields, validate
class CompanySchema(ma.ModelSchema):
name = fields.Str(required=True, validate=[validate.Length(min=4, max=250)])
addressLine1 = fields.Str(required=True, validate=[validate.Length(min=5, max=250)])
addressLine2 = fields.Str(required=False, validate=[validate.Length(max=250)])
city = fields.Str(required=True, validate=[validate.Length(min=5, max=100)])
state = fields.Str(required=True, validate=[validate.Length(min=2, max=10)])
zipCode = fields.Str(required=True, validate=[validate.Length(min=5, max=250)])
logo = fields.Str(required=False, validate=[validate.Length(max=250)])
website = fields.Str(required=True, validate=[validate.Length(min=5, max=250)])
recognition = fields.Str(required=False, validate=[validate.Length(max=250)])
vision = fields.Str(required=False, validate=[validate.Length(max=250)])
history = fields.Str(required=False, validate=[validate.Length(max=250)])
mission = fields.Str(required=False, validate=[validate.Length(max=250)])
class Meta:
model = Company
Теперь я ничего не проверяю в моей модели, поэтому моя модель просто
class Company(db.Model):
__tablename__ = "company"
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(250), nullable=False)
addressLine1 = db.Column(db.String(250), nullable=False)
addressLine2 = db.Column(db.String(250), nullable=True)
city = db.Column(db.String(250), nullable=False)
state = db.Column(db.String(250), nullable=False)
zipCode = db.Column(db.String(10), nullable=False)
logo = db.Column(db.String(250), nullable=True)
website = db.Column(db.String(250), nullable=False)
recognition = db.Column(db.String(250), nullable=True)
vision = db.Column(db.String(250), nullable=True)
history = db.Column(db.String(250), nullable=True)
mission = db.Column(db.String(250), nullable=True)
jobs = relationship("Job", cascade="all, delete-orphan")
def save_to_db(self):
print("=====inside save_to_db=======")
db.session.add(self)
db.session.commit()
Итак, в конечной точке ресурса (view) у меня есть:
@ api.route ('/ company') класс Company(Resource):
def post(self, *args, **kwargs):
""" Creating a new Company """
data = request.get_json(force=True)
schema = CompanySchema()
if data:
logger.info("Data got by /api/test/testId method %s" % data)
# Validation with schema.load() OPTION_2
company, errors = schema.load(data)
print(company)
if errors:
return {"errors": errors}, 422
company.save_to_db()
return {"message": COMPANY_CREATED_SUCCESSFULLY}, 201
Так что теперь, когда пользователь делает неправильный запрос с именем длиной до 4 символов, я могу вернуть пользователю красивый ответ об ошибке, как в
{
"errors": {
"name": [
"Length must be between 4 and 250."
]
}
}
Но если вы заметили, почему я это сделал, и "шаблон", который я использовал, вы увидите следующие детали
- -Использование flask_marshmallow для сериализации и десериализации.
- -В моей модели я использовал зефир (не flask_marshmallow) для проверки
- -Валидация работает с schema.load ()
- -Мне интересно, как бы я мог добавить более сложную проверку для ввода, чем тот, который я использовал?
- -Это хороший шаблон для подражания, какие улучшения можно сделать?
Спасибо
Надеюсь, еще не поздно. Пример ниже - это рабочий пример отображения ошибок в ответе api.
Уловка состоит в том, чтобы использовать метод проверки, который возвращает словарь ошибок, или, скорее, список словарей ошибок, которые могут отображаться пользователю.
from flask import request
import datetime as dt
from marshmallow import (
Schema,RAISE,fields,pprint,validate,ValidationError,post_load)
from flask_restplus import Api,Resource
app = Flask(__name__)
api = Api(app, prefix="/api/v1")
class User:
def __init__(self, name,email,age,permission):
self.name = name
self.email = email
self.age = age
self.permission = permission
self.created_at = dt.datetime.utcnow()
def __repr__(self):
return "User(name={})".format(self.name)
class Userschema(Schema):
name = fields.Str(required=True,validate=[validate.Length(min=1)])
email = fields.Email(required=True,validate=[validate.Length(min=1)])
permission = fields.Str(validate=[validate.OneOf(["read","write","admin"])])
age = fields.Int(validate=[validate.Range(min=10,max=30)])
@post_load
def make_user(self,data,**kwargs):
return User(**data)
users = []
class UserCollection(Resource):
def get(self):
return {"subscriberList":users}
def post(self,*args,**kwargs):
schema = Userschema()
data = request.get_json(force=True)
errors = schema.validate(api.payload)
if errors:
return errors, 422
user=schema.load(data)
result = schema.dump(user)
users.append(result)
return {"msg": "Subscriber added"},201
api.add_resource(UserCollection,'/subscribers')
if __name__ == "__main__":
app.run(debug=True)
Ответ на запрос
http://localhost:5000/api/v1/subscribers
Текст сообщения
{
"name": "derrick",
"permission": "esc",
"age": 2,
"email":"me@gmail"
}
отклик
{
"email": [
"Not a valid email address."
],
"permission": [
"Must be one of: read, write, admin."
],
"age": [
"Must be greater than or equal to 10 and less than or equal to 30."
]
}
То, что я делаю, это сделать метод вместо загрузки зефира
def json_loader(schema, json):
try:
assert json is not None, "request body is required"
except AssertionError as assertionError:
raise InvalidUsage(40001, assertionError.args[0], 400)
result = schema.load(json)
if result.errors:
raise InvalidUsage(40001, result.errors, 400)
else:
return result.data
Однако, если используется версия 3.0. Они изменили эту часть. Вот их пример.
from marshmallow import ValidationError
try:
result = UserSchema().load({'name': 'John', 'email': 'foo'})
except ValidationError as err:
err.messages # => {'email': ['"foo" is not a valid email address.']}
valid_data = err.valid_data # => {'name': 'John'}
Я считаю, что ошибка в вашем коде в том, что вы подняли AssertionError в валидаторе вместо зефира ValidationError,
Ваш ответ идет в правильном направлении, создавая схему, которая использует валидаторы зефира (required, Length,...). Вы можете добавить пользовательскую валидацию, определив другие валидаторы (валидаторы полей или схем).
Вы можете использовать веб-теги для проверки входных данных, а не для проверки вручную в функции просмотра. Это использует зефир внутренне, и это поддержано командой зефира.
Возможно, взгляните на:
http://flask.pocoo.org/docs/1.0/errorhandling/
Скорее всего, вы можете зарегистрировать handler для тебя AssertionError,