Как мне настроить Tastypie для обработки поля как уникального? - PullRequest
7 голосов
/ 15 сентября 2011

Как настроить Tastypie для обработки поля как уникального? Я ожидал бы получить в качестве ответа какую-то ошибку, не связанную с 500 (возможно, конфликт 409?), Если я попытаюсь вставить повторяющиеся записи в поле, помеченное как уникальное.


Я просмотрел документы, и, похоже, это должно быть для меня очевидно, но по какой-то причине я не получил ответ, который ожидал увидеть.

Вот ссылка на документацию:

http://readthedocs.org/docs/django-tastypie/en/latest/fields.html?highlight=unique


Пример кода следующий:

urls.py

v1_api = Api(api_name='v1')
v1_api.register(CompanyResource())

urlpatterns = patterns('',
    (r'^api/', include(v1_api.urls)),
)

resource.py

class CompanyResource(ModelResource):

    CompanyName = fields.CharField(attribute='company_name')
    CompanyId = fields.CharField(attribute='company_id', unique=True)
    Contact = fields.CharField(attribute='contact')
    Email = fields.CharField(attribute='email')
    Phone = fields.CharField(attribute='phone')

    class Meta:
        queryset = Company.objects.all()
        authentication = BasicAuthentication()
        authorization = Authorization()
        allowed_methods = ['get', 'post']

models.py

class Company(models.Model):

    company_name = models.TextField(default=None, blank=True, null=True)
    company_id = models.CharField(default='', unique=True, db_index=True, max_length=20)
    contact = models.TextField(default=None, blank=True, null=True)
    email = models.EmailField(default=None, blank=True, null=True)
    phone = models.TextField(default=None, blank=True, null=True)

Я получаю следующее сообщение об ошибке (используя curl для доступа к моей локальной службе):

curl --dump-header - -H "Content-Type: application/json" -X POST --user user:password --data '{"CompanyName": "company", "CompanyId": "1234567890", "Contact": "John", "Email": "example@example.com", "Phone": "555-555-5555"}' http://localhost:8000/api/v1/company/
HTTP/1.0 500 INTERNAL SERVER ERROR
Date: Thu, 15 Sep 2011 18:25:20 GMT
Server: WSGIServer/0.1 Python/2.7.1
Content-Type: application/json; charset=utf-8

{"error_message": "(1062, \"Duplicate entry '1234567890' for key 'api_company_company_id_uniq'\")", 
...<snip>...
raise errorclass, errorvalue\n\nIntegrityError: (1062, \"Duplicate entry '1234567890' for key 'api_company_company_id_uniq'\")\n"}

Когда я удаляю unique=True, db_index=True, из модели Компании, я не получаю сообщение об ошибке целостности, но вместо этого создается новый дубликат ресурса. Опять же, это не ожидаемый результат, так как я ожидал бы, что уникальный преформ выполнит некоторую проверку и вызовет не-500 ответ.

Ответы [ 3 ]

8 голосов
/ 21 сентября 2011

Вот как я решил проблему:

На основании документации для проверки я смог реализовать собственный валидатор, который проверял уникальность поля для меня. http://django -tastypie.readthedocs.org / en / latest / validation.html

В CompanyResource я добавил к мета-классу CustomValidation. Я поместил реализацию для CustomValidation в файл validations.py. Если isValid возвращает ошибки, API вернет 400 с сообщениями, включенными в ошибки.

class CompanyResource(ModelResource):
    """
    CompanyIds should be unique
    """     
    CompanyName = fields.CharField(attribute='company_name')     
    CompanyId = fields.CharField(attribute='company_id', unique=True)     
    Contact = fields.CharField(attribute='contact')     
    Email = fields.CharField(attribute='email')     
    Phone = fields.CharField(attribute='phone')    

    class Meta:        
        queryset = Company.objects.all()        
        authentication = BasicAuthentication()        
        authorization = Authorization()        
        allowed_methods = ['get', 'post']                
        validation = CustomValidation()

validations.py

class CustomValidation(Validation):
    """
    The custom validation checks two things:
       1) that there is data
       2) that the CompanyId exists (unique check)
    """
    def is_valid(self, bundle, request=None):
        if not bundle.data:
            return {'__all__': 'Missing data, please include CompanyName, CompanyId, Contact, Email, and Phone.'}

        errors = {}                                    
        company_id=bundle.data.get('CompanyId', None)

        # manager method, returns true if the company exists, false otherwise
        if Company.objects.company_exists(company_id):
            errors['CompanyId']='Duplicate CompanyId, CompanyId %s already exists.' % company_id
        return errors
5 голосов
/ 09 января 2012

У меня была такая же проблема сегодня.Вот как я с этим справляюсь:

Переопределить метод [request_method] _ [request_type] в определении вашего ресурса.Например, я перезаписываю post_list в FooResource:

def post_list(self, request, **kwargs):
    from django.db import IntegrityError
    try:
        return super(FooResource, self).post_list(request, **kwargs)
    except IntegrityError, e:
        if e.args[0] == 1062:
            return http.HttpConflict()

Надеюсь, это работает для вас.

0 голосов
/ 09 апреля 2014

Несмотря на это, я создал немного другое решение, которое работает лучше для меня.Он основан на ответе Тослина.

Я обнаружил, что проверка e.args [0] == 1062 не удалась.Я почти уверен, что это ошибка MySQL, и я использую Postgres.

Я также реализовал это в методе obj_create, чтобы он обрабатывал все объекты, а не только те, которые выполняются с помощью post_list.

from tastypie.exceptions import ImmediateHttpResponse
from tastypie.http import HttpConflict
from django.db import IntegrityError

...

class MyBaseResource(ModelResource):
    def obj_create(self, bundle, **kwargs):
        try:
            return super(MyBaseResource, self).obj_create(bundle, **kwargs)
        except IntegrityError, e:
            if e.args[0] == 1062 or e.args[0].startswith('duplicate key'):
                raise ImmediateHttpResponse(HttpConflict())

...

class MyResource(MyBaseResource):
    [usual resource stuff]
...