return object from django query

Question

I'm newbie in Python and building API in Django using rest framework and using mysql for database. I'm using filter query to get user info object but its returning array.

In Login API my code is:

is_valid_user = users.objects.filter(email=req_email, password=req_password)
serializer = usersSerializer(is_valid_user,many=True)
    if is_valid_user:
        response = {
            'message': 'success',
            'code': 1,
            'data':serializer.data
    else:
        response = {
            'message': 'User not found',
            'code': 0,
        }
    return Response(response)

My usersSerializer Class :

class usersSerializer(serializers.ModelSerializer):
    class Meta:
        model = users
        fields = ('uid', 'first_name', 'last_name', 'email', 'gender')

For this code response is :

{
      "message": "success",
      "code": 1,
      "data": [
        {
          "uid": 6,
          "first_name": "anuj",
          "last_name": "sharma",
          "email": "[email protected]",
          "gender": "0"
        }
      ]
 }

But for this I don't want array of data . Expected result should be :

  {
    "message": "success",
    "code": 1,
    "data": {
        "uid": 6,
        "first_name": "anuj",
        "last_name": "sharma",
        "email": "[email protected]",
        "gender": "0"
    }
}

Kindly help me for this.

You're avoiding everything that django-rest-framework gives you by doing this. If you used a serializer you could easily get the result you want. — Daniel Roseman
– Daniel Roseman, Commented May 9, 2017 at 9:52
@DanielRoseman Thanks for your suggestion. I will read rest framework documentation for this. — Anuj Sharma
– Anuj Sharma, Commented May 9, 2017 at 9:54
what about isValidUser.values('uid','first_name','last_name', 'email','gender')[0] — itzMEonTV
– itzMEonTV, Commented May 9, 2017 at 9:54
@L_S I was thinking of that naive approach, too. But maybe it is an XY problem. This might be the wrong way to the solution. It'll work, however going for a more elegant solutions within the means of the framework would be the right way to go. — cezar
– cezar, Commented May 9, 2017 at 9:57
@DanielRoseman I've read about serializers and updated my code, But still getting same response. — Anuj Sharma
– Anuj Sharma, Commented May 9, 2017 at 10:58

cezar · Accepted Answer · 2018-01-16 08:01:48Z

2

The comments under your questions should point you to another solution. Here I'd like to give an explanation, why you're getting an array, and not an object.

In this line:


isValidUser = users.objects.filter(email=req_email, password=req_password)

you use the filter method, which may return more than 1 result (or none). You'll always get an array (a list in python), regardless of the number of results. The filter() method returns a new QuerySet.

If you want to retrieve a single result explicitly, and you have a unique field in your model class, then you should use the method get(), which doesn't return a QuerySet, but an object.

So if, let's say the field email is set to be unique, you could do this:


isValidUser = users.objects.get(email=req_email)

That will return an object, if there is an entry that can be matched.

Also, it is a good practice to follow the naming conventions for Python and name the variables with snake case:

is_valid_user

instead of

isValidUser

edited Jan 16, 2018 at 8:01

answered May 9, 2017 at 10:07

cezar

12.1k6 gold badges51 silver badges92 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Anuj Sharma Over a year ago

Thanks for explaining. How can I get each and every information from that object. isValidUser.uid will give id from that object. How can I retrieve all information like id, first_name, etc in single statement ?

cezar Over a year ago

If you want to get the values for all properties in a single statement, then you should use a serializer. DRF offers many tools for achieving this. You can set the depth for associated model classes, use hyperlinked serializers, inherit serializers and many other things.

Collectives™ on Stack Overflow

return object from django query

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related