Merge pull request #164 from IndicoDataSolutions/update_submission_examples

updating submission examples to be more realistic

Author: Scott771

examples/submission.py

@@ -1,7 +1,6 @@
 from indico import IndicoClient, IndicoConfig
 from indico.filters import SubmissionFilter, or_
 from indico.queries import (
-    GenerateSubmissionResult,
     JobStatus,
     ListSubmissions,
     RetrieveStorageObject,
@@ -31,34 +30,26 @@
 submission_ids = client.call(
     WorkflowSubmission(workflow_id=workflow_id, files=["./path_to_doc.pdf"])
 )
-submission_id = submission_ids[0]
 
-result_url = client.call(SubmissionResult(submission_id, wait=True))
-result = client.call(RetrieveStorageObject(result_url.result))
+job = client.call(SubmissionResult(submission_ids[0], wait=True))
+result = client.call(RetrieveStorageObject(job.result))
 print(result)
-
-client.call(UpdateSubmission(submission_id, retrieved=True))
+client.call(UpdateSubmission(submission_ids[0], retrieved=True))
 
 """
 Example 2
 List all submissions that are COMPLETE or FAILED
-Generate submission results for these
-Delay gathering the results until required
+Retrieve submission results for all COMPLETE and check errors on any FAILED
 """
 sub_filter = or_(SubmissionFilter(status="COMPLETE"), SubmissionFilter(status="FAILED"))
 submissions = client.call(ListSubmissions(filters=sub_filter))
 
-result_files = {
-    submission: client.call(GenerateSubmissionResult(submission))
-    for submission in submissions
-}
-
-# Do other fun things...
-
-for submission, result_file_job in result_files.items():
-    result_url = client.call(JobStatus(id=result_file_job.id, wait=True))
-    result = client.call(RetrieveStorageObject(result_url.result))
-    print(f"Submission {submission.id} has result:\n{result}")
+for submission in submissions:
+    if submission.status == "COMPLETE":
+        result = client.call(RetrieveStorageObject(submission.result_file))
+        print(f"Submission {submission.id} has result:\n{result}")
+    else:
+        print(f"Submission {submission.id} failed:\n{submission.errors}")
 
 
 """
@@ -90,7 +81,6 @@
 submissions = client.call(WaitForSubmissions(submission_ids))
 submission = submissions[0]
 raw_result = client.call(RetrieveStorageObject(submission.result_file))
-raw_result = client.call(RetrieveStorageObject(submission.result_file))
 changes = raw_result["results"]["document"]["results"]
 rejected = False
 for model, preds in changes.items():

examples/workflow.py

@@ -43,31 +43,20 @@
 
 client.call(modelgroupreq)
 
+
 # Example 2: Simple submission.
 
-# Return a list of workflows for this dataset id or an empty list if there are none
-workflows = client.call(ListWorkflows(dataset_ids=[dataset_id]))
-
-# You can run this with the newly created workflow or with an existing one.
-if workflows:
-    # Send a document through the workflow
-    # Get back one Job per file
-    jobs = client.call(
-        WorkflowSubmission(
-            workflow_id=workflows[0].id,
-            files=["./path/to/sample.pdf"],
-            submission=False,
-        )
+# Send a document through the workflow
+# Get back one submission ID per file (List[int])
+submission_id = client.call(
+    WorkflowSubmission(
+        workflow_id=new_workflow.id, # REPLACE with your [int] workflow ID- can also be found in the UI
+        files=["./path/to/sample.pdf"],
     )
-    job = jobs[0]
-
-    # Retrieve and print your result
-    status = client.call(JobStatus(id=job.id, wait=True))
-    wf_result = client.call(RetrieveStorageObject(status.result))
-    print(wf_result)
+)
+job = client.call(SubmissionResult(submission_id[0], wait=True))
+wf_result = client.call(RetrieveStorageObject(job.result))
 
-else:
-    print("You don't have any workflows for this dataset")
 
 # Example 3 - Adding additional components.