Problem using GitHub api with Python dict "Problems parsing JSON"

Question

I am trying to use the GitHub api for creating a new file. As per the documentation

this can be done via a PUT request.

I am using the requests package for making the request. The GitHub api endpoint accepts valid json objects as input, i.e. where strings are within double quotes.

My data has the following format -

{
  'message': 'Updated learn.md',
  'content': 'ZW51bTM0PT0xLjEuNAotZSBnaXQraHR0cHM6Ly9naXRodWIuY29tL29wZW50b2svT3BlbnRvay1QeXRob24tU0RLLmdpdEAwMzU4YTI0ZDM0ZTkzMjVjYzRhODNhYmQxZTVjMGJmYzQ2M2ZkMjYwI2VnZz1vcGVudG9rCnB5dHo9PTIwMTYuNApyZXF1ZXN0cz09Mi4xMC4wCgo=',
  'branch': 'master'
}

Since I am putting the data which is in the form of a Python dictionary it is having single quotes, but GitHub isn't accepting it and is giving a 400 response of "Problems parsing JSON" as shown below

{
  "message": "Problems parsing JSON",
  "documentation_url": "https://developer.github.com/v3/repos/contents/#update-a-file"
}

I have verified that the problem is because of quotes only by using postman to make the PUT request, in that case it was successful.

The correct data is shown below

{
  "message": "Updated learn.md",
  "content": "ZW51bTM0PT0xLjEuNAotZSBnaXQraHR0cHM6Ly9naXRodWIuY29tL29wZW50b2svT3BlbnRvay1QeXRob24tU0RLLmdpdEAwMzU4YTI0ZDM0ZTkzMjVjYzRhODNhYmQxZTVjMGJmYzQ2M2ZkMjYwI2VnZz1vcGVudG9rCnB5dHo9PTIwMTYuNApyZXF1ZXN0cz09Mi4xMC4wCgo=",
  "branch": "master"
}

Here is how I am making the call

def put_data_to_github(self, url, data):
    headers = {}
    headers['Authorization'] = "token " + self.auth_token
    response = requests.put(url, data=data, headers=headers)
    return response

How can I make valid JSON objects in Python so that GitHub api accepts it? How Can I achieve this?

Please can you share the full Traceback error?

amanb
– amanb

2019-04-21 11:49:47 +00:00
Commented Apr 21, 2019 at 11:49 — amanb
– amanb, Commented Apr 21, 2019 at 11:49
Included the error received in the Github response

Shahrukh Mohammad
– Shahrukh Mohammad

2019-04-21 11:52:33 +00:00
Commented Apr 21, 2019 at 11:52 — Shahrukh Mohammad
– Shahrukh Mohammad, Commented Apr 21, 2019 at 11:52

thebjorn · Accepted Answer · 2019-04-21 12:21:53Z

7

You must convert your data to json before sending..

import json
...
response = requests.put(url, data=json.dumps(data), headers=headers)

answered Apr 21, 2019 at 12:21

thebjorn

27.6k12 gold badges107 silver badges152 bronze badges

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

5 Comments

Shahrukh Mohammad Over a year ago

I tried this solution earlier, but my data had a byte string, I decoded it and then used json.dumps, which did the trick. Thanks!

SeaDude Over a year ago

Hm...When using the Update File Contents Github API, the content key requires a b64 encoded value. I get a TypeError: Object of type bytes is not JSON serializable error when trying to use the above solution.

thebjorn Over a year ago

@SeaDude see the comment above yours for the solution.

SeaDude Over a year ago

Yes, I was reading that comment. When the base64 is decoded I can't use it as input for the content key. Here's the write-up.

SeaDude Over a year ago

Now I see what @Shahrukh-Mohammad was doing. I don't know why, but his suggestion coupled with changing the data parameter to json in the request.put() worked for me. See write up above.

Collectives™ on Stack Overflow

Problem using GitHub api with Python dict "Problems parsing JSON"

1 Answer 1

5 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related