TypeError: Object of type WorkItem is not JSON serializable

Question

I received this error after running the script below. I would like to create a json file through the result that is generated in this script. What can I do to correct this problem?

I tried to do it via API but I couldn't get the fields I need from this DevOps table.

from azure.devops.connection import Connection
from msrest.authentication import BasicAuthentication
from azure.devops.v5_1.work_item_tracking.models import Wiql
import json

token = 'xxx'
team_instance = 'https://dev.azure.com/xxx'

credentials = BasicAuthentication("", token)
connection = Connection(base_url=team_instance, creds=credentials)

def print_work_items(work_items):
    for work_item in work_items:
        with open('teste_project.json', 'w') as json_file:
            json.dump(work_items, json_file)

wit_client = connection.clients.get_work_item_tracking_client()

def get_TC_from_query(query):
    query_wiql = Wiql(query=query)
    results = wit_client.query_by_wiql(query_wiql).work_items
    # WIQL query gives a WorkItemReference => we get the corresponding WorkItem from id
    work_items = (wit_client.get_work_item(int(result.id)) for result in results)
    print_work_items(work_items)

get_TC_from_query(
    """\
SELECT *
FROM workitems
WHERE
        [System.TeamProject] = 'xxx'
        and [System.WorkItemType] = 'Product Backlog Item'
        and [System.State] = 'Done'
ORDER BY [System.ChangedDate] DESC
"""
)

TypeError: Object of type WorkItem is not JSON serializable

jordanm · Accepted Answer · 2020-02-14 17:20:47Z

2

The following produces a generator, which JSON can not serialize:

work_items = (wit_client.get_work_item(int(result.id)) for result in results)

You can instead make work_items a list, which JSON can serialize:

work_items = [wit_client.get_work_item(int(result.id)) for result in results]

answered Feb 14, 2020 at 17:20

jordanm

35.4k8 gold badges70 silver badges80 bronze badges

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

2 Comments

Felipe FB Over a year ago

I continue with error:"TypeError: Object of type WorkItem is not JSON serializable". I will update the script

jordanm Over a year ago

@FelipeFB either see this question or abstract the data you want out of the WorkItem objects. JSON only supports a handful of basic types.

Levi Lu-MSFT · Accepted Answer · 2020-02-17 10:24:14Z

1

Inspired by the thread provided by @jordanm. You can override the default() method to serialize additional types.

I made below changes to your code, and it worked when i tested.

First make work_items a list:

work_items = [wit_client.get_work_item(int(result.id)) for result in results]

Then in print_work_items method, i override the default method in json.dump() with default = lambda o: o.__dict__. Please check below:

def print_work_items(work_items):
    for work_item in work_items:
        with open('teste_project.json', 'w') as json_file:
            json.dump(work_items, json_file, default = lambda o: o.__dict__, sort_keys=True, indent=4)

answered Feb 17, 2020 at 10:24

Levi Lu-MSFT

30.9k3 gold badges42 silver badges55 bronze badges

1 Comment

Felipe FB Over a year ago

I am not able to read this json generated in a databricks table. I tried to apply StringIO but I was unsuccessful, what can I do to solve this?

Collectives™ on Stack Overflow

TypeError: Object of type WorkItem is not JSON serializable

2 Answers 2

2 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related