Django-rest-framework: 중첩된 직렬 변환기가 보기 컨텍스트를 수신하지 않습니다.

컨텍스트는 부모 직렬 변환기에서 선언될 때 초기화되기 때문에 초기화 시점에서 필드(또는 중첩 직렬 변환기)로 전달되지 않습니다(전달될 수 없음)...

class MySerializer(Serializer):
    child = ChildSerializer()  <--- We've just initialized this.

가장 좋은 것은 MySerializer.__init__ 에서 이와 같은 동작을 수행하는 것입니다. 예를 들어...

def __init__(self, *args, **kwargs):
    super(MySerializer, self).__init__(*args, **kwargs)
    self.fields['child'].default = ...

그 시점에서 컨텍스트에 대한 액세스 권한이 _do_ 있습니다.

정말로 원한다면 필드가 부모에 바인딩되는 지점에서 몇 가지 작업을 수행할 수 있습니다.

class ChildSerializer(Serializer):
    def bind(self, *args, **kwargs):
        super(ChildSerializer, self).bind(*args, **kwargs)
        # do stuff with self.context.

이것은 비공개 API로 간주되어야 하며 위에 나열된 상위 __init__ 스타일이 선호되어야 합니다.

예, 당신이 설명하는 것을 이해합니다. 그래서인지 조금 까다롭다고 생각합니다. 그래서 내 해결 방법은 부모의 __ini__ 에 중첩된 직렬 변환기를 만드는 것입니다. 그러나 중첩된 직렬 변환기 __init__ 는 deepcopy를 사용하기 때문에 새 직렬 변환기 인스턴스가 생성될 때마다 호출되지만 상위 인스턴스를 몰래 들어갈 수는 없습니다...
그래서 v2에서 볼 수 있듯이 필드에는 부모 직렬 변환기를 기반으로 기본값을 초기화하기에 완벽한 initialize 메소드가 있었습니다.

따라서 bind 가 좋을 것 같습니다.

이것은 비공개 API로 간주되어야 하며 위에 나열된 상위 __init__ 스타일이 선호되어야 합니다.

그러나 __init__ 를 사용할 수는 없기 때문에 현재 보기에서 생성된 모든 사용 가능한 환경에 액세스할 수 없으므로 모든 것이 있을 때 필드(serializer)에서 호출되는 공개 API 메서드가 있어야 합니다. 사용 가능. initialize 처럼.

DRF 2에서 작동합니까?

유감스럽게도 컨텍스트가 더 이상 중첩된 직렬 변환기로 전파되지 않습니다.

유감스럽게도 컨텍스트가 더 이상 중첩된 직렬 변환기로 전파되지 않습니다.

너 그거 어디서 얻었 니 ? Afaik, 컨텍스트가 중첩된 직렬 변환기로 전파되었습니다.

@xordoquy 이상합니다. 최신 drf에 대한 테스트 케이스를 만들었고 문제를 재현할 수 없습니다. 더구나 내 자신의 코드에 대해 재현할 수 없습니다. 문제 해결됨.

@xiaohanyu 실제로 다시 한 번이 문제를 발견했습니다. 그리고 좀 이상합니다.

>>> serializer
Out[12]: 
# Note there is context passed in constructor
CouponSerializer(<Coupon: Coupon Coupon #0 for offer Offer #0000>, context={'publisher': <User: John ZusPJRryIzYZ>}):
    id = IntegerField(label='ID', read_only=True)
    title = CharField(max_length=100, required=True)
    short_title = CharField(max_length=30)
    offer_details = OfferLimitedSerializer(read_only=True, source='offer'):
        id = IntegerField(label='ID', read_only=True)
        title = CharField(help_text='The Offer Title will be used for the Network, Advertisers and Publishers to identify the specific offer within the application.', read_only=True)       
        status_name = CharField(read_only=True, source='get_status_display')
        is_access_limited = SerializerMethodField()    
    exclusive = BooleanField(required=False)    
    categories_details = OfferCategorySerializer(many=True, read_only=True, source='categories'):
        id = IntegerField(read_only=True)
        category = CharField(read_only=True, source='code')
        category_name = CharField(read_only=True, source='get_code_display')    

# all fields except one got context propagated
>>> [f.field_name for f in serializer.fields.values() if not f.context]
Out[20]: 
['offer_details']

# offer_details is no different than categories_details, both are nested, read only, model serializers..
>>> serializer.fields['categories_details'].context
Out[21]: 
{'publisher': <User: John ZusPJRryIzYZ>}

# lets look inside problematic serializer
>>> offer_details = serializer.fields['offer_details']
>>> offer_details
Out[25]: 

OfferLimitedSerializer(read_only=True, source='offer'):
    id = IntegerField(label='ID', read_only=True)
    title = CharField(help_text='The Offer Title will be used for the Network, Advertisers and Publishers to identify the specific offer within the application.', read_only=True)    
    status_name = CharField(read_only=True, source='get_status_display')
    url = SerializerMethodField()
    is_access_limited = SerializerMethodField()
>>> offer_details.context
Out[23]: 
{}
>>> offer_details._context
Out[24]: 
{}
# ! surprisingly context is available inside fields... but not in the parent
>>> offer_details.fields['is_access_limited'].context
Out[26]: 
{'publisher': <User: John ZusPJRryIzYZ>}

# context is available in all of them!
>>> [x.field_name for x in offer_details.fields.values() if not x.context]
Out[27]: 
[]

@tomchristie 귀찮게 해서 미안하지만, 그게 어떻게 가능한지 알 수 있을까요?

그동안 나는 이 해킹을 사용하여 문제를 해결해야 했습니다.

class Serializer(serializers.Serializer):

    def __init__(self, *args, **kwargs):
        super(Serializer, self).__init__(*args, **kwargs)
        # propagate context to nested complex serializers
        if self.context:
            for field in six.itervalues(self.fields):
                if not field.context:
                    delattr(field, 'context')
                    setattr(field, '_context', self.context)

@pySilver 간단한 테스트 케이스 없이는 큰 도움이 되지 않습니다. 컨텍스트 전파를 중단하는 일부 사용자 정의 코드가 있을 수 있는 여러 직렬 변환기를 사용하고 있습니다.

여러 클래스가 serializers.Serializer의 자식인 복잡한 mro 때문에 발생하는 것으로 나타났습니다. 그런 것

class MyMixin(serializers.Serializer):
   # some code within __init__, calling parent too

class MyModelSerializer(serializers.ModelSerializer):
   # some code within __init__, calling parent too

class MyProblematicSerializer(MyModelSerializer, MyMixin)
    # this one will not receive context somehow.
     pass

어쨌든 지역 문제라고 생각할 수 있습니다.

피드백 감사합니다 👍

@xordoquy @tomchristie 실제로 문제가 정말 이상해졌습니다. 나는 운이 없이 fields 속성에서 그렇게 하려고 했습니다. 다음은 테스트 케이스입니다.

def test_serializer_context(self):
        class MyBaseSerializer(serializers.Serializer):
            def __init__(self, *args, **kwargs):
                super(MyBaseSerializer, self).__init__(*args, **kwargs)
                x = 0
                if self.context.get('x'):
                    x = self.context['x']

        class SubSerializer(MyBaseSerializer):
            char = serializers.CharField()
            integer = serializers.IntegerField()

        class ParentSerializer(MyBaseSerializer):
            with_context = serializers.CharField()
            without_context = SubSerializer()

        serializer = ParentSerializer(data={}, context={'what': 42})
        assert serializer.context == {'what': 42}
        assert serializer.fields['with_context'].context == {'what': 42}
        assert serializer.fields['without_context'].context == {'what': 42}

그러나 이것은 통과할 것입니다. imho 재정의된 메서드에서 컨텍스트에 액세스하는 데 문제가 있을 수 있다는 점을 소스에서 언급해야 합니다...

def test_serializer_context(self):
        class MyBaseSerializer(serializers.Serializer):
            <strong i="12">@property</strong>
            def fields(self):
                fields = super(MyBaseSerializer, self).fields
                x = 0
                if self.root.context.get('x'):
                    x = 1
                return fields


        class SubSerializer(MyBaseSerializer):
            char = serializers.CharField()
            integer = serializers.IntegerField()

        class ParentSerializer(MyBaseSerializer):
            with_context = serializers.CharField()
            without_context = SubSerializer()

        serializer = ParentSerializer(data={}, context={'what': 42})
        assert serializer.context == {'what': 42}
        assert serializer.fields['with_context'].context == {'what': 42}
        assert serializer.fields['without_context'].context == {'what': 42}

명확히 하자면, 여기서 내가 하고 있는 것은 컨텍스트를 기반으로 필드의 동작을 변경하는 것입니다.

UPD: 어떤 경우에는 마지막 코드도 신뢰할 수 없습니다. 만지는 컨텍스트가 위험하다는 것이 밝혀졌습니다.

__init__ 컨텍스트에 액세스할 수 없다는 것은 불행한 일입니다. 컨텍스트의 무언가를 기반으로 직렬 변환기에서 필드를 동적으로 생성하려는 경우 어디에서 수행하시겠습니까?

위에서 제안한 대로 bind 에서 작동하지 않는 것 같습니다. 예를 들어 self.fields['asdf'] = serializers.CharField() . bind 가 호출될 때 필드가 이미 평가되었다고 가정합니다.

fields 속성에서 수행하는 것도 좋지 않은 것 같습니다. 해당 항목이 많이 호출되고 지연 평가로 인해 self._fields 에 캐싱 메커니즘이 있으므로 복제해야 하기 때문입니다. 구체적인 직렬 변환기에서. 내부적으로 캐시되기 전에 필드를 한 번 수정할 수 있는 것이 좋습니다.

직렬화기를 직접 호출하지 않고 필드로 중첩을 수행했다면 문제가 되지 않을 것이라고 생각합니다.

이와 같이:

class ChildSerializer(serializers.Serializer):
    ...

class ParentSerializer(serializers.Serializer):
    child = serializers.NestedField(serializer=ChildSerializer)

그러면 ChildSerializer ParentSerializer 의 필드 선언에서 직접 인스턴스화되지 않기 때문에 __init__ 의 컨텍스트에 액세스할 수 있습니다.

컨텍스트의 무언가를 기반으로 직렬 변환기에서 필드를 동적으로 생성하려는 경우 어디에서 수행하시겠습니까?

구체적인 예의 맥락에서 이에 대해 이야기해 보겠습니다. 멋진 간단한 사용 사례를 생각해 내고 이를 해결하는 가장 좋은 방법을 알아낼 수 있습니다.

직렬화기를 직접 호출하지 않고 필드로 중첩을 수행했다면 문제가 되지 않을 것이라고 생각합니다.

시도해보십시오. 우리가 그 길을 갈 것 같지는 않지만. 이것은 현재 우리가 하는 일에 큰 변화를 가져왔으며, 또한 자식 직렬 변환기에 인수를 설정할 수 없습니다. 그런 스타일에 타당한 경우가 있다고 생각하지만 이 시점에서 우리가 특별히 변하는 것을 보지는 못합니다.

@tomchristie 답변 감사합니다.

내가 지금 가지고 있는 한 가지 사용 사례는 현재 로그인한 사용자의 속성에 따라 중첩된 자식 직렬 변환기에서 두 개의 서로 다른 필드 집합 사이를 전환하는 것입니다.

Type A 사용자는 Type B 사용자와 관련된 필드를 절대 볼 수 없으며 그 반대의 경우도 마찬가지입니다.

다음과 같이 보입니다.

class ChildSerializer(serializers.Serializer):
  # relevant for all users
  name = serializers.CharField()

  # only relevant for users of Type A
  phone = serializers.CharField()

  # only relevant for users of Type B
  ssn = serializers.CharField()

그러나 저는 drf 직렬 변환기 및/또는 django 양식을 사용하여 api 및 html 양식 모두에서 다양한 방식으로 필드를 정기적으로 수정합니다. 동적으로 필드를 추가하고, 필드를 제거하고, 속성을 수정하는 위의 예는 유일한 방법이 아닙니다. 나는 이전에 중첩된 자식에서 그것을 할 필요가 없었고 이것에 완전히 당황했습니다.

@tomchristie 내 일반적인 사용 사례는 컨텍스트를 기반으로 필드가 필요한지 여부를 제어하는 ​​것입니다(사용자 및 관리자를 위한 직렬 변환기를 상상해 보십시오. 여기서 컨텍스트를 통해 전달되기 때문에 사용자 ID를 제공할 필요가 없습니다.) 이 스레드의 이전 게시물에서 솔루션을 사용하십시오.

한 가지 해결 방법은 필드 선언 대신 ParentSerializer 의 __init__ 메서드에서 항상 중첩된 ChildSerializer 을 인스턴스화하는 것입니다. 그러면 컨텍스트를 수동으로 전달할 수 있습니다.

이와 같이:

class ChildSerializer(serializers.Serializer):
    ...

class ParentSerializer(serializers.Serializer):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['child'] = ChildSerializer(context=self.context)

초기 테스트에서 작동하는 것 같습니다. 이것에 어떤 캐치가 있는지 확실하지 않습니다.

같은 제안을 하려고 했어, 네.

글쎄, 어떤 경우에는 저에게 효과가 없었습니다. 아마도 다중 상속 때문일 것입니다.

2016년 10월 12일 수요일 오후 2시 56분 +0200에 "Tom Christie" [email protected] 이 작성했습니다.

같은 제안을 하려고 했어, 네.

—
당신이 언급되었기 때문에 이것을 받는 것입니다.
이 이메일에 직접 답장하거나 GitHub에서 보거나 스레드를 음소거하세요.

default 속성(내 경우에는 CurrentUserDefault() 값 포함)을 처리하는 __init__ 메서드를 서브클래싱한 (중첩) 직렬 변환기 필드로 설정할 때도 동일한 문제가 있습니다. self.context 속성에서 KeyError $는 컨텍스트에서 request 를 찾을 수 없음을 보여줍니다(아무 것도 포함하지 않음, 즉 상위에서 전달되지 않음).
예제 코드:

class UserSerializer(serializers.ModelSerializer):
# ...
    def __init__(self, *args, **kwargs):
        kwargs.pop('fields', None)
        super().__init__(*args, **kwargs)
        if 'list' in self.context: # Once I remove this, it will work
            self.fields['friend_count'] = serializers.SerializerMethodField()
# ...

class CommentSerializer(serializers.ModelSerializer):
    person = UserSerializer(read_only=True, default=serializers.CurrentUserDefault())
# ...

오류 기록:

Environment:


Request Method: POST
Request URL: http://127.0.0.1:8000/api/comments/98/

Django Version: 1.9.7
Python Version: 3.4.3
Installed Applications:
['django.contrib.admin',
 'django.contrib.auth',
 'django.contrib.contenttypes',
 'django.contrib.sessions',
 'django.contrib.messages',
 'django.contrib.staticfiles',
 'django.contrib.sites',
 'rest_framework',
 'rest_framework.authtoken',
 'generic_relations',
 'decorator_include',
 'allauth',
 'allauth.account',
 'allauth.socialaccount',
 'allauth.socialaccount.providers.facebook',
 'allauth.socialaccount.providers.google',
 'phonenumber_field',
 'bootstrap3',
 'stronghold',
 'captcha',
 'django_settings_export',
 'main']
Installed Middleware:
['django.middleware.security.SecurityMiddleware',
 'django.contrib.sessions.middleware.SessionMiddleware',
 'django.middleware.common.CommonMiddleware',
 'django.middleware.csrf.CsrfViewMiddleware',
 'django.contrib.auth.middleware.AuthenticationMiddleware',
 'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
 'django.contrib.messages.middleware.MessageMiddleware',
 'django.middleware.clickjacking.XFrameOptionsMiddleware',
 'stronghold.middleware.LoginRequiredMiddleware']



Traceback:

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/django/core/handlers/base.py" in get_response
  149.                     response = self.process_exception_by_middleware(e, request)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/django/core/handlers/base.py" in get_response
  147.                     response = wrapped_callback(request, *callback_args, **callback_kwargs)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/django/views/decorators/csrf.py" in wrapped_view
  58.         return view_func(*args, **kwargs)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/django/views/generic/base.py" in view
  68.             return self.dispatch(request, *args, **kwargs)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/views.py" in dispatch
  466.             response = self.handle_exception(exc)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/views.py" in dispatch
  463.             response = handler(request, *args, **kwargs)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/generics.py" in post
  246.         return self.create(request, *args, **kwargs)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/mixins.py" in create
  20.         serializer.is_valid(raise_exception=True)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/serializers.py" in is_valid
  213.                 self._validated_data = self.run_validation(self.initial_data)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/serializers.py" in run_validation
  407.         value = self.to_internal_value(data)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/serializers.py" in to_internal_value
  437.                 validated_value = field.run_validation(primitive_value)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/serializers.py" in run_validation
  403.         (is_empty_value, data) = self.validate_empty_values(data)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/fields.py" in validate_empty_values
  453.             return (True, self.get_default())

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/fields.py" in get_default
  437.                 self.default.set_context(self)

File "/home/mikisoft/django-dev/lib/python3.4/site-packages/rest_framework/fields.py" in set_context
  239.         self.user = serializer_field.context['request'].user

Exception Type: KeyError at /api/comments/98/
Exception Value: 'request'

추가된 필드에는 직렬 변환기가 메타클래스를 통해 수행하는 몇 가지 작업이 부족합니다. 그것들을 설정하는 것은 당신에게 달려 있습니다.

위에서 이미 말했듯이 __init__ 메서드에서 컨텍스트 검색을 제거하면 모든 것이 잘 작동합니다. 따라서 컨텍스트가 부모로부터 전달되기 때문에 필드 설정은 확실히 문제가 되지 않습니다. 사례.

맞아, 내 전화에 있었다, 그 부분을 눈치 채지 못했습니다.
그런 다음 중첩된 직렬 변환기가 최상위 직렬 변환기보다 훨씬 전에 인스턴스화되기 때문에 정상입니다.
컨텍스트의 목적은 실제로 인스턴스화가 발생한 후에 컨텍스트를 전달하는 것입니다. 따라서 init에서 작동하지 않는 것은 놀라운 일이 아닙니다.

괜찮아. 마지막 참고로, 오류 로그가 표시하는 것처럼 __init__ 메서드에 나타나지 않고 CurrentUserDefault() 개체( set_context 방법). 그러나 컨텍스트 매개변수에 대한 직접 호출이 있는 경우, 즉 존재를 확인하지 않고 __init__ 에도 표시되는지 확인하십시오(전체 컨텍스트가 비어 있기 때문에 전달되지 않기 때문입니다).
또한 다른 사람이 위에서 결론을 내린 것을 반복하고 싶습니다. 중첩이 없는 경우(그리고 컨텍스트가 인스턴스화 방법에 사용되는 경우) 모든 것이 예상대로 작동합니다.

컨텍스트를 어린이에게 전파하는 데 문제가 있었습니다. https://github.com/encode/django-rest-framework/pull/5304 에서 해결해야 합니다 None 캐싱과 관련된 많은 문제가 있었을 것 같습니다.

최근에 이 문제가 발생했습니다. 이것은 나를 위해 일한 솔루션입니다.

class MyBaseSerializer(serializers.HyperlinkedModelSerializer):

    def get_fields(self):
        '''
        Override get_fields() method to pass context to other serializers of this base class.

        If the context contains query param "omit_data" as set to true, omit the "data" field
        '''
        fields = super().get_fields()

        # Cause fields with this same base class to inherit self._context
        for field_name in fields:
            if isinstance(fields[field_name], serializers.ListSerializer):
                if isinstance(fields[field_name].child, MyBaseSerializer):
                    fields[field_name].child._context = self._context

            elif isinstance(fields[field_name], MyBaseSerializer):
                fields[field_name]._context = self._context

        # Check for "omit_data" in the query params and remove data field if true
        if 'request' in self._context:
            omit_data = self._context['request'].query_params.get('omit_data', False)

            if omit_data and omit_data.lower() in ['true', '1']:
                fields.pop('data')

        return fields

위에서 get_fields() 를 재정의하고 동일한 기본 클래스가 있는 자식 직렬 변환기에 self._context 를 전달하는 직렬 변환기 기본 클래스를 만듭니다. ListSerializers의 경우 컨텍스트를 자식에 연결합니다.

그런 다음 쿼리 매개변수 "omit_data"를 확인하고 "data" 필드가 요청되면 제거합니다.

여전히 이에 대한 답변을 찾고 있는 사람에게 이것이 도움이 되기를 바랍니다.

이것이 오래된 스레드라는 것을 알고 있지만 __init__ 조합을 사용하고 내 사용자 지정 믹스인에 바인딩하여 요청(컨텍스트에서)을 기반으로 쿼리 세트를 필터링한다는 사실을 공유하고 싶었습니다. 이 믹스인은 get_objects_for_user 메소드가 쿼리 세트에 존재한다고 가정하거나 그렇지 않으면 Guardian.shortcuts.get_objects_for_user를 사용합니다. POST 또는 PATCHing 시에도 중첩된 직렬 변환기에 대해 매우 잘 작동합니다.