DRF: how to create custom FilterSet to filter nearest users by distance

Issue

I’m trying to create custom FilterSet for filtering nearby users by distance using django-filter
For example if I send
GET /api/list/?distance=300, I want to get all nearby users who are lower or equals to 300m far away

My model has 2 fields:

latitude = models.DecimalField(  # [-90.000000, 90.000000]
    max_digits=8,
    decimal_places=6,
    null=True
)
longitude = models.DecimalField(  # [-180.000000, 180.000000]
    max_digits=9,
    decimal_places=6,
    null=True
)

objects = ClientManager()

My ClientManager has function for getting coords from model:

def get_geo_coordinates(self, pk):
    """
    :param pk: - client id
    :return: client's coords
    """

    instance = self.get(pk=pk)
    data = (instance.latitude, instance.longitude)
    return data

My GetListAPIView

class GetClientListAPIView(ListAPIView):

    """
        Returns list with filtering capability
        Available filter fields:
            gender, first_name, last_name, distance
    """

    serializer_class = ClientSerializer
    queryset = Client.objects.all()
    permission_classes = [IsAuthenticated]
    filter_backends = [DjangoFilterBackend]
    filter_class = ClientFilter

My ClientFilter

class ClientFilter(FilterSet):

    distance = filters.NumberFilter(method='get_nearest_clients')

    def get_nearest_clients(self, queryset, name, value):
        sender_coords = Client.objects.get_geo_coordinates(pk=self.request.user.id)
        test_coords = Client.objects.get_geo_coordinates(pk=31)
        dist = get_great_circle_distance(sender_coords, test_coords)

    class Meta:
        model = Client
        fields = ['gender', 'first_name', 'last_name']

Here I’m using my function for calculating distance between two clients:

def get_great_circle_distance(first_coords, second_coords):
    """
        :param first_coords: (first_client_latitude, first_client_longitude) in degrees
        :param second_coords: (second_client_latitude, second_client_longitude) in degrees
        :return: distance
    """

    earth_radius = 6_400_000  # in metres

    la_1, lo_1 = map(radians, first_coords)
    la_2, lo_2 = map(radians, second_coords)

    coefficient = acos(
        cos(la_1) * cos(la_2) * cos(lo_1 - lo_2) +
        sin(la_1) * sin(la_2)
    )
    distance = earth_radius * coefficient

    return distance

I do not know how to filter the queryset and do it optimally from the database accesses side.

Solution

I fixed this issue

class ClientFilter(FilterSet):
"""
     Custom ClientFilter
"""

distance = filters.NumberFilter(method='get_nearest_clients')

def get_nearest_clients(self, queryset: QuerySet, name: str, dist_value: int):
    sender_id = self.request.user.id
    sender_la, sender_lo = map(radians, Client.objects.get_geo_coordinates(pk=sender_id))
    earth_radius = 6_400_000

    queryset = (
        queryset.exclude(pk=sender_id)
        .alias(
            rad_lat=Radians('latitude'),
            rad_long=Radians('longitude'),
            distance=ExpressionWrapper(
                ACos(
                    Cos('rad_lat') * Cos(sender_la) * Cos(F('rad_long') - sender_lo)
                    + Sin('rad_lat') * Sin(sender_la)
                ) * earth_radius,
                output_field=FloatField()
            )
        )
        .exclude(distance__gte=dist_value)
        .order_by('distance')
    )

    return queryset

Answered By – max_bstr

This Answer collected from stackoverflow, is licensed under cc by-sa 2.5 , cc by-sa 3.0 and cc by-sa 4.0