Adding a ct.get_all_results() function

[Andrew-S-Rosen]

What should we add?

There is currently a ct.get_result(<dispatch ID>) function, which works perfectly. It would be even more awesome if there were an option to do ct.get_all_results() that would automatically return all results!

The "manual" way I'd come up with is something like this (it's a bit messy but you get the idea):

config_results_dir = ct.get_config()["dispatcher"]["results_dir"]
dispatch_ids = os.listdir(config_results_dir)
# ^ hmm.... guess this relies on you being on the same machine (how else to get all dispatch IDs?)

# Populate the docs
docs = []
for d_id in dispatch_ids:
    try:
        result_obj = ct.get_result(d_id)
    except MissingLatticeRecordError:
        continue
    if result_obj and result_obj.status == "COMPLETED": # the "COMPLETED" check could be optional
        docs.append({"dispatch_id": d_id, "result": result_obj})
return docs

I'm not sure if there is a more efficient way. Of course, I'm happy to open a PR based on this if what I've proposed is the optimal route.

Describe alternatives you've considered.

Looping, like above! :)

[santoshkumarradha]

@arosen93 , thanks again ! this is a nice feature. Could you also add a bit more about the UX of how one might want to deal with if its a large graph and the objects are significant as well? Maybe it returns a generator instead of list ?

[Andrew-S-Rosen]

That's a great question! Yes, I think a generator would probably be the ideal solution for this problem.

[wjcunningham7]

As a part of this issue, we want to be able to filter by a list of dispatch IDs and statuses. Additionally include fields such as started_before, started_after, completed_before, and completed_after.

[wjcunningham7]

This issue is a part of Hacktoberfest. Closing this issue will earn you 2 points.

[akash47angadi]

In which folder is the above function located?

[Aady7]

Would like to work on the issue

[Andrew-S-Rosen]

@akash47angadi: It's here: https://github.com/AgnostiqHQ/covalent/blob/develop/covalent/_results_manager/results_manager.py#L38

[Ceres445]

Are there any alternative ways to get the list of dispatch ids?

[adirao-projects]

I've added a pull request (#1901) with the the desired implementation. I think everything checks out but if any changes are required I can make them. If @Andrew-S-Rosen or @wjcunningham7 could take a look (or anyone else) and let me know if I need to fix anything else.