V0.5routes update

* fix: tag name

* feat: support non status response of submit job and delay on get results

* fix: add some waiting for job to be ready

* fix: change test model

* fix: helper methods

Author: raul-casallas

modzy/jobs.py

@@ -172,15 +172,15 @@ def block_until_complete(self, job, timeout=60, poll_interval=5):
         """
         identifier = Job._coerce_identifier(job)
         endby = time.time() + timeout if (timeout is not None) else None
-        while True:  # poll at least once
+        while True:  # wait one poll at least once
+            self.logger.debug("waiting... %g", poll_interval)
+            time.sleep(poll_interval)
             job = self.get(identifier)
             self.logger.debug("job %s", job)
             if job.status not in (Jobs.status.SUBMITTED, Jobs.status.IN_PROGRESS):
                 return job
             if (endby is not None) and (time.time() > endby - poll_interval):
                 raise Timeout('timed out before completion')
-            self.logger.debug("waiting... %g", poll_interval)
-            time.sleep(poll_interval)
         # TODO: should probably ramp up poll_interval as wait time increases
 
     def submit_text(self, model, version, source, source_name='job'):
@@ -608,6 +608,10 @@ class Job(ApiObject):
         key name (``job.job_identifier`` or ``job.jobIdentifier``). Alternatively, the original
         "camelCase" JSON key can be used with bracketed key access notation (``job['jobIdentifier']``).
     """
+    def __init__(self, json_obj, api_client=None):
+        if 'status' not in json_obj:
+            json_obj['status'] = Jobs.status.SUBMITTED
+        super().__init__(json_obj, api_client)
 
     @classmethod
     def _coerce_identifier(cls, maybe_job):

tests/test_jobs.py

@@ -5,8 +5,10 @@
 import os
 import dotenv
 import pytest
+import time
 from datetime import datetime, timedelta
 from modzy import ApiClient, error
+from modzy.jobs import Jobs
 
 dotenv.load_dotenv()
 
@@ -83,7 +85,7 @@ def test_get_job_history_by_date(client, logger):
     try:
         client.jobs.get_history(**params)
     except error.ApiError as ae:
-        logger.debug("jobs history: by %s %d", params, ae)
+        logger.debug("jobs history: by %s %s", params, ae)
         api_error = ae
     assert api_error
     # by start and end date
@@ -97,7 +99,7 @@ def test_get_job_history_by_date(client, logger):
     try:
         client.jobs.get_history(**params)
     except error.ApiError as ae:
-        logger.debug("jobs history: by %s %d", params, ae)
+        logger.debug("jobs history: by %s %s", params, ae)
         api_error = ae
     assert api_error
 
@@ -119,6 +121,7 @@ def test_get_job_history_by_status(client, logger):
     # by pending
     params = {'status': "pending"}
     client.jobs.submit_text(MODEL_ID, '0.0.27', {'input.txt': 'Modzy is great!'})
+    time.sleep(5)
     jobs = client.jobs.get_history(**params)
     logger.debug("jobs history: by %s %d", params, len(jobs))
     assert len(jobs)
@@ -157,18 +160,25 @@ def test_submit_job(client, logger):
 def test_get_job(client, logger):
     job = client.jobs.submit_text(MODEL_ID, '0.0.27', {'input.txt': 'Modzy is great!'})
     logger.debug("job %s", job)
+    time.sleep(5)
     job = client.jobs.get(job.job_identifier)  # by id
     logger.debug("job copy by id %s", job)
     assert job.job_identifier
-    assert job.status == client.jobs.status.SUBMITTED
-
+    assert job.status
+    
 
 def test_cancel_job(client, logger):
     job = client.jobs.submit_text_bulk(MODEL_ID, '0.0.27', {
         str(i): {'input.txt': 'Modzy is great!'}
         for i in range(2)
-    })
-    logger.debug("job before cancel %s", job)
-    job = client.jobs.cancel(job.job_identifier)
-    logger.debug("job after cancel %s", job)
-    assert job.status == client.jobs.status.CANCELED
+    })    
+    time.sleep(5)
+    job = client.jobs.get(job.job_identifier)  # by id    
+    logger.debug("job %s", job)
+    if job.status != Jobs.status.COMPLETED:    
+        logger.debug("job before cancel %s", job)
+        job = client.jobs.cancel(job.job_identifier)
+        logger.debug("job after cancel %s", job)
+    
+    assert job.status == client.jobs.status.CANCELED or job.status == client.jobs.status.COMPLETED
+

tests/test_models.py

@@ -56,7 +56,7 @@ def test_get_single_model(client, logger):
     assert model.modelId == model_copy.modelId
 
 def test_get_model_by_name(client, logger):
-    model = client.models.get_by_name("Sentiment Analysis")  # by name
+    model = client.models.get_by_name("Military Equipment Classification")  # by name
     logger.debug("model_modelId: %s", model.modelId)
     assert model.modelId
     logger.debug("model_latestVersion: %s", model.latestVersion)

tests/test_results.py

@@ -16,6 +16,14 @@
 MODEL_ID = 'ed542963de'  # sentiment-analysis
 BLOCK_TIMEOUT = 600  # how long to wait until giving up on real api
 
+@pytest.fixture()
+def client():
+    return ApiClient(base_url=BASE_URL, api_key=API_KEY)
+
+@pytest.fixture()
+def logger():
+    return logging.getLogger(__name__)
+
 def test_get_results(client, logger):
     job = client.jobs.submit_text(MODEL_ID, '0.0.27', {'input.txt': 'Modzy is great!'})
     logger.debug("job %s", job)

tests/test_tags.py

@@ -36,7 +36,7 @@ def test_get_all_tags(client, logger):
 
 
 def test_get_tags_and_models(client, logger):
-    tags, models = client.tags.get_tags_and_models('computer-vision')  # by identifier
+    tags, models = client.tags.get_tags_and_models('computer_vision')  # by identifier
     logger.debug("tags by computer_vision: %d", len(models))
     for tag in tags:
         logger.debug("tag: %s", tag)