def resolve_filter_field(self, auto_schema, model, filterset_class, field_name, filter_field): from django_filters import filters unambiguous_mapping = { filters.CharFilter: OpenApiTypes.STR, filters.BooleanFilter: OpenApiTypes.BOOL, filters.DateFilter: OpenApiTypes.DATE, filters.DateTimeFilter: OpenApiTypes.DATETIME, filters.IsoDateTimeFilter: OpenApiTypes.DATETIME, filters.TimeFilter: OpenApiTypes.TIME, filters.UUIDFilter: OpenApiTypes.UUID, filters.DurationFilter: OpenApiTypes.DURATION, filters.OrderingFilter: OpenApiTypes.STR, filters.TimeRangeFilter: OpenApiTypes.TIME, filters.DateFromToRangeFilter: OpenApiTypes.DATE, filters.IsoDateTimeFromToRangeFilter: OpenApiTypes.DATETIME, filters.DateTimeFromToRangeFilter: OpenApiTypes.DATETIME, } if has_override(filter_field, 'field'): annotation = get_override(filter_field, 'field') if is_basic_type(annotation): schema = build_basic_type(annotation) else: schema = annotation elif isinstance(filter_field, tuple(unambiguous_mapping)): for cls in filter_field.__class__.__mro__: if cls in unambiguous_mapping: schema = build_basic_type(unambiguous_mapping[cls]) break elif isinstance(filter_field, (filters.NumberFilter, filters.NumericRangeFilter)): # NumberField is underspecified by itself. try to find the # type that makes the most sense or default to generic NUMBER if filter_field.method: schema = self._build_filter_method_type( filterset_class, filter_field) if schema['type'] not in ['integer', 'number']: schema = build_basic_type(OpenApiTypes.NUMBER) else: model_field = self._get_model_field(filter_field, model) if isinstance(model_field, (models.IntegerField, models.AutoField)): schema = build_basic_type(OpenApiTypes.INT) elif isinstance(model_field, models.FloatField): schema = build_basic_type(OpenApiTypes.FLOAT) elif isinstance(model_field, models.DecimalField): schema = build_basic_type( OpenApiTypes.NUMBER) # TODO may be improved else: schema = build_basic_type(OpenApiTypes.NUMBER) elif filter_field.method: # try to make best effort on the given method schema = self._build_filter_method_type(filterset_class, filter_field) else: try: # the last resort is to lookup the type via the model or queryset field. # first search for the field in the model as this has the least amount of # potential side effects. Only after that fails, attempt to call # get_queryset() to check for potential query annotations. model_field = self._get_model_field(filter_field, model) if not isinstance(model_field, models.Field): qs = auto_schema.view.get_queryset() model_field = qs.query.annotations[ filter_field.field_name].field schema = auto_schema._map_model_field(model_field, direction=None) except Exception as exc: warn( f'Exception raised while trying resolve model field for django-filter ' f'field "{field_name}". Defaulting to string (Exception: {exc})' ) schema = build_basic_type(OpenApiTypes.STR) # primary keys are usually non-editable (readOnly=True) and map_model_field correctly # signals that attribute. however this does not apply in this context. schema.pop('readOnly', None) # enrich schema with additional info from filter_field enum = schema.pop('enum', None) if 'choices' in filter_field.extra: enum = [c for c, _ in filter_field.extra['choices']] if enum: schema['enum'] = sorted(enum, key=str) description = schema.pop('description', None) if filter_field.extra.get('help_text', None): description = filter_field.extra['help_text'] elif filter_field.label is not None: description = filter_field.label # parameter style variations based on filter base class if isinstance(filter_field, filters.BaseCSVFilter): schema = build_array_type(schema) field_names = [field_name] explode = False style = 'form' elif isinstance(filter_field, filters.MultipleChoiceFilter): schema = build_array_type(schema) field_names = [field_name] explode = True style = 'form' elif isinstance(filter_field, (filters.RangeFilter, filters.NumericRangeFilter)): try: suffixes = filter_field.field_class.widget.suffixes except AttributeError: suffixes = ['min', 'max'] field_names = [ f'{field_name}_{suffix}' if suffix else field_name for suffix in suffixes ] explode = None style = None else: field_names = [field_name] explode = None style = None return [ build_parameter_type(name=field_name, required=filter_field.extra['required'], location=OpenApiParameter.QUERY, description=description, schema=schema, explode=explode, style=style) for field_name in field_names ]
def _map_serializer_field(self, field, direction): if has_override(field, 'field'): override = get_override(field, 'field') if is_basic_type(override): return build_basic_type(override) else: return self._map_serializer_field(override, direction) meta = self._get_serializer_field_meta(field) serializer_field_extension = OpenApiSerializerFieldExtension.get_match( field) if serializer_field_extension: schema = serializer_field_extension.map_serializer_field( self, direction) return append_meta(schema, meta) # nested serializer if isinstance(field, serializers.Serializer): component = self.resolve_serializer(field, direction) return append_meta(component.ref, meta) if component else None # nested serializer with many=True gets automatically replaced with ListSerializer if isinstance(field, serializers.ListSerializer): if is_serializer(field.child): component = self.resolve_serializer(field.child, direction) return append_meta(build_array_type(component.ref), meta) if component else None else: schema = self._map_serializer_field(field.child, direction) return append_meta(build_array_type(schema), meta) # Related fields. if isinstance(field, serializers.ManyRelatedField): schema = self._map_serializer_field(field.child_relation, direction) # remove hand-over initkwargs applying only to outer scope schema.pop('description', None) schema.pop('readOnly', None) return append_meta(build_array_type(schema), meta) if isinstance(field, serializers.PrimaryKeyRelatedField): # read_only fields do not have a Manager by design. go around and get field # from parent. also avoid calling Manager. __bool__ as it might be customized # to hit the database. if getattr(field, 'queryset', None) is not None: model_field = field.queryset.model._meta.pk else: if isinstance(field.parent, serializers.ManyRelatedField): model_field = field.parent.parent.Meta.model._meta.pk else: model_field = field.parent.Meta.model._meta.pk # primary keys are usually non-editable (readOnly=True) and map_model_field correctly # signals that attribute. however this does not apply in the context of relations. schema = self._map_model_field(model_field, direction) schema.pop('readOnly', None) return append_meta(schema, meta) if isinstance(field, serializers.StringRelatedField): return append_meta(build_basic_type(OpenApiTypes.STR), meta) if isinstance(field, serializers.SlugRelatedField): return append_meta(build_basic_type(OpenApiTypes.STR), meta) if isinstance(field, serializers.HyperlinkedIdentityField): return append_meta(build_basic_type(OpenApiTypes.URI), meta) if isinstance(field, serializers.HyperlinkedRelatedField): return append_meta(build_basic_type(OpenApiTypes.URI), meta) if isinstance(field, serializers.MultipleChoiceField): return append_meta(build_array_type(build_choice_field(field)), meta) if isinstance(field, serializers.ChoiceField): return append_meta(build_choice_field(field), meta) if isinstance(field, serializers.ListField): if isinstance(field.child, _UnvalidatedField): return append_meta(build_array_type({}), meta) elif is_serializer(field.child): component = self.resolve_serializer(field.child, direction) return append_meta(build_array_type(component.ref), meta) if component else None else: schema = self._map_serializer_field(field.child, direction) return append_meta(build_array_type(schema), meta) # DateField and DateTimeField type is string if isinstance(field, serializers.DateField): return append_meta(build_basic_type(OpenApiTypes.DATE), meta) if isinstance(field, serializers.DateTimeField): return append_meta(build_basic_type(OpenApiTypes.DATETIME), meta) if isinstance(field, serializers.TimeField): return append_meta(build_basic_type(OpenApiTypes.TIME), meta) if isinstance(field, serializers.EmailField): return append_meta(build_basic_type(OpenApiTypes.EMAIL), meta) if isinstance(field, serializers.URLField): return append_meta(build_basic_type(OpenApiTypes.URI), meta) if isinstance(field, serializers.UUIDField): return append_meta(build_basic_type(OpenApiTypes.UUID), meta) if isinstance(field, serializers.DurationField): return append_meta(build_basic_type(OpenApiTypes.STR), meta) if isinstance(field, serializers.IPAddressField): # TODO this might be a DRF bug. protocol is not propagated to serializer although it # should have been. results in always 'both' (thus no format) if 'ipv4' == field.protocol.lower(): schema = build_basic_type(OpenApiTypes.IP4) elif 'ipv6' == field.protocol.lower(): schema = build_basic_type(OpenApiTypes.IP6) else: schema = build_basic_type(OpenApiTypes.STR) return append_meta(schema, meta) # DecimalField has multipleOf based on decimal_places if isinstance(field, serializers.DecimalField): if getattr(field, 'coerce_to_string', api_settings.COERCE_DECIMAL_TO_STRING): content = { **build_basic_type(OpenApiTypes.STR), 'format': 'decimal' } else: content = build_basic_type(OpenApiTypes.DECIMAL) if field.max_whole_digits: content['maximum'] = int(field.max_whole_digits * '9') + 1 content['minimum'] = -content['maximum'] self._map_min_max(field, content) return append_meta(content, meta) if isinstance(field, serializers.FloatField): content = build_basic_type(OpenApiTypes.FLOAT) self._map_min_max(field, content) return append_meta(content, meta) if isinstance(field, serializers.IntegerField): content = build_basic_type(OpenApiTypes.INT) self._map_min_max(field, content) # 2147483647 is max for int32_size, so we use int64 for format if int(content.get('maximum', 0)) > 2147483647 or int( content.get('minimum', 0)) > 2147483647: content['format'] = 'int64' return append_meta(content, meta) if isinstance(field, serializers.FileField): if spectacular_settings.COMPONENT_SPLIT_REQUEST and direction == 'request': content = build_basic_type(OpenApiTypes.BINARY) else: use_url = getattr(field, 'use_url', api_settings.UPLOADED_FILES_USE_URL) content = build_basic_type( OpenApiTypes.URI if use_url else OpenApiTypes.STR) return append_meta(content, meta) if isinstance(field, serializers.SerializerMethodField): method = getattr(field.parent, field.method_name) return append_meta(self._map_response_type_hint(method), meta) if anyisinstance( field, [serializers.BooleanField, serializers.NullBooleanField]): return append_meta(build_basic_type(OpenApiTypes.BOOL), meta) if isinstance(field, serializers.JSONField): return append_meta(build_basic_type(OpenApiTypes.OBJECT), meta) if anyisinstance(field, [serializers.DictField, serializers.HStoreField]): content = build_basic_type(OpenApiTypes.OBJECT) if not isinstance(field.child, _UnvalidatedField): content['additionalProperties'] = self._map_serializer_field( field.child, direction) return append_meta(content, meta) if isinstance(field, serializers.CharField): return append_meta(build_basic_type(OpenApiTypes.STR), meta) if isinstance(field, serializers.ReadOnlyField): # direct source from the serializer assert field.source_attrs, f'ReadOnlyField "{field}" needs a proper source' target = follow_field_source(field.parent.Meta.model, field.source_attrs) if callable(target): schema = self._map_response_type_hint(target) elif isinstance(target, models.Field): schema = self._map_model_field(target, direction) else: assert False, f'ReadOnlyField target "{field}" must be property or model field' return append_meta(schema, meta) # DRF was not able to match the model field to an explicit SerializerField and therefore # used its generic fallback serializer field that simply wraps the model field. if isinstance(field, serializers.ModelField): schema = self._map_model_field(field.model_field, direction) return append_meta(schema, meta) warn( f'could not resolve serializer field "{field}". defaulting to "string"' ) return append_meta(build_basic_type(OpenApiTypes.STR), meta)