clarifai-grpc 6.4.0__py3-none-any.whl → 11.10.3__py3-none-any.whl

scripts/app_and_key_for_tests.py

@@ -1,180 +0,0 @@
-import json
-import os
-import sys
-
-try:
-    from urllib.parse import urlparse, urlencode
-    from urllib.request import urlopen, Request, build_opener, HTTPHandler
-    from urllib.error import HTTPError
-except ImportError:
-    from urlparse import urlparse
-    from urllib import urlencode
-    from urllib2 import urlopen, Request, HTTPError, build_opener, HTTPHandler
-
-
-EMAIL = os.environ['CLARIFAI_USER_EMAIL']
-PASSWORD = os.environ['CLARIFAI_USER_PASSWORD']
-
-
-BASE = 'https://api.clarifai.com/v2'
-
-
-def _request(method, url, payload={}, headers={}):
-    opener = build_opener(HTTPHandler)
-    full_url = '%s%s' % (BASE, url)
-    request = Request(full_url, data=json.dumps(payload).encode())
-    for k in headers.keys():
-        request.add_header(k, headers[k])
-    request.get_method = lambda: method
-    return json.loads(opener.open(request).read().decode())
-
-
-def create_app(env_name):
-    session_token, user_id = _login()
-
-    url = '/users/%s/apps' % user_id
-    payload = {'apps': [{'name': 'auto-created-in-%s-ci-test-run' % env_name}]}
-
-    response = _request(method='POST', url=url, payload=payload, headers=_auth_headers(session_token))
-
-    _raise_on_http_error(response)
-    data = response
-    app_id = data['apps'][0]['id']
-
-    # This print needs to be present so we can read the value in CI.
-    print(app_id)
-
-
-def create_key(app_id):
-    session_token, user_id = _login()
-
-    url = '/users/%s/keys' % user_id
-    payload = {
-        'keys': [{
-            'description': 'Auto-created in a CI test run',
-            'scopes': ['All'],
-            'apps': [{'id': app_id, 'user_id': user_id}]
-        }]
-    }
-    response = _request(method='POST', url=url, payload=payload, headers=_auth_headers(session_token))
-    _raise_on_http_error(response)
-    data = response
-    key_id = data['keys'][0]['id']
-
-    # This print needs to be present so we can read the value in CI.
-    print(key_id)
-
-
-def delete(app_id):
-    session_token, user_id = _login()
-
-    # All the related keys will be deleted automatically when the app is deleted
-    _delete_app(session_token, user_id, app_id)
-
-
-def create_sample_workflow(api_key):
-    url = '/workflows'
-    payload = {
-        'workflows': [
-            {
-                'id': 'food-and-general',
-                'nodes': [
-                    {
-                        'id': 'food-workflow-node',
-                        'model': {
-                            'id': 'bd367be194cf45149e75f01d59f77ba7',
-                            'model_version': {
-                                'id': 'dfebc169854e429086aceb8368662641'
-                            }
-                        }
-                    },
-                    {
-                        'id': 'general-workflow-node',
-                        'model': {
-                            'id': 'aaa03c23b3724a16a56b629203edc62c',
-                            'model_version': {
-                                'id': 'aa9ca48295b37401f8af92ad1af0d91d'
-                            }
-                        }
-                    }
-                ]
-            }
-        ]
-    }
-    response = _request(method='POST', url=url, payload=payload, headers=_auth_headers_for_api_key_key(api_key))
-    _raise_on_http_error(response)
-
-
-def _delete_app(session_token, user_id, app_id):
-    url = '/users/%s/apps/%s' % (user_id, app_id)
-    response = _request(method='DELETE', url=url, headers=_auth_headers(session_token))
-    _raise_on_http_error(response)
-
-
-def _auth_headers(session_token):
-    headers = {'Content-Type': 'application/json', 'X-Clarifai-Session-Token': session_token}
-    return headers
-
-
-def _auth_headers_for_api_key_key(api_key):
-    headers = {'Content-Type': 'application/json', 'Authorization': 'Key ' + api_key}
-    return headers
-
-
-def _login():
-    url = '/login'
-    payload = {'email': EMAIL, 'password': PASSWORD}
-    response = _request(method='POST', url=url, payload=payload)
-    _raise_on_http_error(response)
-    data = response
-    user_id = data['v2_user_id']
-    session_token = data['session_token']
-    return session_token, user_id
-
-
-def _raise_on_http_error(response):
-    # TODO: Make this work with urllib.
-    # if int(response.status_code) // 100 != 2:
-    #     raise Exception('Unexpected response %s: %s' % (response.status_code, response.text))
-    pass
-
-
-def run(arguments):
-    command = arguments[0] if arguments else '--help'
-    if command == '--create-app':
-        if len(arguments) != 2:
-            raise Exception('--create-app takes one argument')
-
-        env_name = arguments[1]
-        create_app(env_name)
-    elif command == '--create-key':
-        if len(arguments) != 2:
-            raise Exception('--create-key takes one argument')
-
-        app_id = arguments[1]
-        create_key(app_id)
-    elif command == '--delete-app':
-        if len(arguments) != 2:
-            raise Exception('--delete-app takes one argument')
-        app_id = arguments[1]
-        delete(app_id)
-    elif command == '--create-workflow':
-        if len(arguments) != 2:
-            raise Exception('--create-workflow takes one argument')
-        api_key = arguments[1]
-        create_sample_workflow(api_key)
-    elif command == '--help':
-        print('''DESCRIPTION: Creates and delete applications and API keys
-ARGUMENTS:
---create-app [env_name]      ... Creates a new application.
---create-key [app_id]        ... Creates a new API key.
---delete-app [app_id]        ... Deletes an application (API keys that use it are deleted as well).
---create-workflow [api_key]  ... Creates a sample workflow to be used in int. tests.
---help                       ... This text.''')
-    else:
-        print('Unknown argument. Please see --help')
-        exit(1)
-
-
-if __name__ == '__main__':
-    run(arguments=sys.argv[1:])

tests/helpers.py

@@ -1,105 +0,0 @@
-import time
-
-from clarifai_grpc.channel.clarifai_channel import ClarifaiChannel
-from clarifai_grpc.grpc.api import service_pb2
-from clarifai_grpc.grpc.api.status import status_code_pb2
-
-
-def both_channels(func):
-  """
-  A decorator that runs the test first using the gRPC channel and then using the JSON channel.
-  :param func: The test function.
-  :return: A function wrapper.
-  """
-  def func_wrapper():
-    channel = ClarifaiChannel.get_insecure_grpc_channel()
-    func(channel)
-
-    channel = ClarifaiChannel.get_json_channel()
-    func(channel)
-  return func_wrapper
-
-
-def _wait_for_inputs_upload(stub, metadata, input_ids):
-  for input_id in input_ids:
-    while True:
-      get_input_response = stub.GetInput(
-        service_pb2.GetInputRequest(input_id=input_id),
-        metadata=metadata
-      )
-      _raise_on_failure(get_input_response)
-      if get_input_response.input.status.code == status_code_pb2.INPUT_DOWNLOAD_SUCCESS:
-        break
-      elif get_input_response.input.status.code in (status_code_pb2.INPUT_DOWNLOAD_PENDING,
-                                                    status_code_pb2.INPUT_DOWNLOAD_IN_PROGRESS):
-        time.sleep(1)
-      else:
-        error_message = (
-          str(get_input_response.status.code) + " " +
-          get_input_response.status.description + " " +
-          get_input_response.status.details
-        )
-        raise Exception(
-          f"Expected inputs to upload, but got {error_message}. Full response: {get_input_response}"
-        )
-  # At this point, all inputs have been downloaded successfully.
-
-
-def _wait_for_model_trained(stub, metadata, model_id, model_version_id):
-  while True:
-    response = stub.GetModelVersion(
-      service_pb2.GetModelVersionRequest(model_id=model_id, version_id=model_version_id),
-      metadata=metadata
-    )
-    _raise_on_failure(response)
-    if response.model_version.status.code == status_code_pb2.MODEL_TRAINED:
-      break
-    elif response.model_version.status.code in (status_code_pb2.MODEL_QUEUED_FOR_TRAINING,
-                                                status_code_pb2.MODEL_TRAINING):
-      time.sleep(1)
-    else:
-      error_message = (
-        str(response.status.code) + " " +
-        response.status.description + " " +
-        response.status.details
-      )
-      raise Exception(
-        f"Expected model to train, but got {error_message}. Full response: {response}"
-      )
-  # At this point, the model has successfully finished training.
-
-
-def _wait_for_model_evaluated(stub, metadata, model_id, model_version_id):
-  while True:
-    response = stub.GetModelVersionMetrics(
-      service_pb2.GetModelVersionMetricsRequest(model_id=model_id, version_id=model_version_id),
-      metadata=metadata
-    )
-    _raise_on_failure(response)
-    if response.model_version.metrics.status.code == status_code_pb2.MODEL_EVALUATED:
-      break
-    elif response.model_version.metrics.status.code in (status_code_pb2.MODEL_QUEUED_FOR_EVALUATION,
-                                                        status_code_pb2.MODEL_EVALUATING):
-      time.sleep(1)
-    else:
-      error_message = (
-        str(response.status.code) + " " +
-        response.status.description + " " +
-        response.status.details
-      )
-      raise Exception(
-        f"Expected model to evaluate, but got {error_message}. Full response: {response}"
-      )
-  # At this point, the model has successfully finished evaluation.
-
-
-def _raise_on_failure(response):
-  if response.status.code != status_code_pb2.SUCCESS:
-    error_message = (
-      str(response.status.code) + " " +
-      response.status.description + " " +
-      response.status.details
-    )
-    raise Exception(
-      f"Received failure response `{error_message}`. Whole response object: {response}"
-    )

tests/test_integration.py

@@ -1,243 +0,0 @@
-import os
-import time
-import uuid
-
-import pytest
-
-from clarifai_grpc.grpc.api import service_pb2_grpc, service_pb2, resources_pb2
-from clarifai_grpc.grpc.api.status import status_code_pb2
-from tests.helpers import (both_channels, _raise_on_failure, _wait_for_inputs_upload,
-                           _wait_for_model_trained, _wait_for_model_evaluated)
-
-
-DOG_IMAGE_URL = 'https://samples.clarifai.com/dog2.jpeg'
-TRUCK_IMAGE_URL = "https://s3.amazonaws.com/samples.clarifai.com/red-truck.png"
-NON_EXISTING_IMAGE_URL = "http://example.com/non-existing.jpg"
-
-GENERAL_MODEL_ID = 'aaa03c23b3724a16a56b629203edc62c'
-
-metadata = (('authorization', 'Key %s' % os.environ.get('CLARIFAI_API_KEY')),)
-
-
-@both_channels
-def test_post_model_outputs(channel):
-  stub = service_pb2_grpc.V2Stub(channel)
-  request = service_pb2.PostModelOutputsRequest(
-    model_id=GENERAL_MODEL_ID,
-    inputs=[
-      resources_pb2.Input(data=resources_pb2.Data(image=resources_pb2.Image(url=DOG_IMAGE_URL)))
-    ])
-  response = stub.PostModelOutputs(request, metadata=metadata)
-
-  _raise_on_failure(response)
-
-  assert len(response.outputs[0].data.concepts) > 0
-
-
-@both_channels
-def test_failed_post_model_outputs(channel):
-  stub = service_pb2_grpc.V2Stub(channel)
-  request = service_pb2.PostModelOutputsRequest(
-    model_id=GENERAL_MODEL_ID,
-    inputs=[
-      resources_pb2.Input(
-        data=resources_pb2.Data(image=resources_pb2.Image(url=NON_EXISTING_IMAGE_URL))
-      )
-    ])
-  response = stub.PostModelOutputs(request, metadata=metadata)
-
-  assert response.status.code == status_code_pb2.FAILURE
-  assert response.status.description == "Failure"
-
-  assert response.outputs[0].status.code == status_code_pb2.INPUT_DOWNLOAD_FAILED
-
-
-@both_channels
-def test_mixed_success_post_model_outputs(channel):
-  stub = service_pb2_grpc.V2Stub(channel)
-  request = service_pb2.PostModelOutputsRequest(
-    model_id=GENERAL_MODEL_ID,
-    inputs=[
-      resources_pb2.Input(data=resources_pb2.Data(image=resources_pb2.Image(url=DOG_IMAGE_URL))),
-      resources_pb2.Input(
-        data=resources_pb2.Data(image=resources_pb2.Image(url=NON_EXISTING_IMAGE_URL))
-      )
-    ])
-  response = stub.PostModelOutputs(request, metadata=metadata)
-
-  assert response.status.code == status_code_pb2.MIXED_STATUS
-
-  assert response.outputs[0].status.code == status_code_pb2.SUCCESS
-  assert response.outputs[1].status.code == status_code_pb2.INPUT_DOWNLOAD_FAILED
-
-
-@both_channels
-def test_post_patch_delete_input(channel):
-  stub = service_pb2_grpc.V2Stub(channel)
-
-  post_request = service_pb2.PostInputsRequest(
-    inputs=[
-      resources_pb2.Input(
-        data=resources_pb2.Data(
-          image=resources_pb2.Image(
-            url=TRUCK_IMAGE_URL, allow_duplicate_url=True
-          ),
-          concepts=[resources_pb2.Concept(id='some-concept')]
-        )
-      )
-    ]
-  )
-  post_response = stub.PostInputs(post_request, metadata=metadata)
-
-  _raise_on_failure(post_response)
-
-  input_id = post_response.inputs[0].id
-
-  try:
-    while True:
-      get_request = service_pb2.GetInputRequest(input_id=input_id)
-      get_response = stub.GetInput(get_request, metadata=metadata)
-      status_code = get_response.input.status.code
-      if status_code == status_code_pb2.INPUT_DOWNLOAD_SUCCESS:
-        break
-      elif status_code not in (
-        status_code_pb2.INPUT_DOWNLOAD_PENDING,
-        status_code_pb2.INPUT_DOWNLOAD_IN_PROGRESS
-      ):
-        raise Exception(
-          f'Waiting for input ID {input_id} failed, status code is {status_code}.')
-      time.sleep(0.2)
-
-    patch_request = service_pb2.PatchInputsRequest(
-      action='overwrite',
-      inputs=[
-        resources_pb2.Input(
-          id=input_id,
-          data=resources_pb2.Data(concepts=[resources_pb2.Concept(id='some-new-concept')])
-        )
-      ]
-    )
-    patch_response = stub.PatchInputs(patch_request, metadata=metadata)
-    assert status_code_pb2.SUCCESS == patch_response.status.code
-  finally:
-    delete_request = service_pb2.DeleteInputRequest(input_id=input_id)
-    delete_response = stub.DeleteInput(delete_request, metadata=metadata)
-    assert status_code_pb2.SUCCESS == delete_response.status.code
-
-
-@both_channels
-def test_list_models_with_pagination(channel):
-  stub = service_pb2_grpc.V2Stub(channel)
-
-  response = stub.ListModels(service_pb2.ListModelsRequest(per_page=2), metadata=metadata)
-  _raise_on_failure(response)
-  assert len(response.models) == 2
-
-  # We shouldn 't have 1000*500 number of models, so the result should be empty.
-  response = stub.ListModels(
-    service_pb2.ListModelsRequest(page=1000, per_page=500),
-    metadata=metadata
-  )
-  _raise_on_failure(response)
-  assert len(response.models) == 0
-
-
-@pytest.mark.skip(reason="On Github Actions there's 'Model training had no data' error for some reason")
-@both_channels
-def test_model_creation_training_and_evaluation(channel):
-  model_id = str(uuid.uuid4())
-
-  stub = service_pb2_grpc.V2Stub(channel)
-
-  _raise_on_failure(
-    stub.PostModels(
-      service_pb2.PostModelsRequest(
-        models=[
-          resources_pb2.Model(
-            id=model_id,
-            output_info=resources_pb2.OutputInfo(
-              data=resources_pb2.Data(
-                concepts=[
-                  resources_pb2.Concept(id="dog"),
-                  resources_pb2.Concept(id="toddler"),
-                ]
-              )
-            )
-          )
-        ]
-      ),
-      metadata=metadata)
-  )
-
-  post_inputs_response = stub.PostInputs(
-    service_pb2.PostInputsRequest(
-      inputs=[
-        resources_pb2.Input(
-          data=resources_pb2.Data(
-            image=resources_pb2.Image(
-              url="https://samples.clarifai.com/dog2.jpeg",
-              allow_duplicate_url=True
-            ),
-            concepts=[resources_pb2.Concept(id="dog")],
-          )
-        ),
-        resources_pb2.Input(
-          data=resources_pb2.Data(
-            image=resources_pb2.Image(
-              url="https://samples.clarifai.com/toddler-flowers.jpeg",
-              allow_duplicate_url=True
-            ),
-            concepts=[resources_pb2.Concept(id="toddler")],
-          )
-        ),
-      ]
-    ),
-    metadata=metadata
-  )
-  _raise_on_failure(post_inputs_response)
-
-  input_ids = [i.id for i in post_inputs_response.inputs]
-  _wait_for_inputs_upload(stub, metadata, input_ids)
-
-  response = stub.PostModelVersions(
-    service_pb2.PostModelVersionsRequest(model_id=model_id),
-    metadata=metadata
-  )
-  _raise_on_failure(response)
-
-  model_version_id = response.model.model_version.id
-  _wait_for_model_trained(stub, metadata, model_id, model_version_id)
-
-  _raise_on_failure(stub.PostModelVersionMetrics(
-    service_pb2.PostModelVersionMetricsRequest(
-      model_id=model_id,
-      version_id=model_version_id,
-    ),
-    metadata=metadata
-  ))
-
-  _wait_for_model_evaluated(stub, metadata, model_id, model_version_id)
-
-  response = stub.GetModelVersionMetrics(
-    service_pb2.GetModelVersionMetricsRequest(
-      model_id=model_id,
-      version_id=model_version_id,
-      fields=resources_pb2.FieldsValue(
-        confusion_matrix=True,
-        cooccurrence_matrix=True,
-        label_counts=True,
-        binary_metrics=True,
-        test_set=True,
-      )
-    ),
-    metadata=metadata
-  )
-  _raise_on_failure(response)
-
-  _raise_on_failure(
-    stub.DeleteModel(service_pb2.DeleteModelRequest(model_id=model_id), metadata=metadata)
-  )
-
-  _raise_on_failure(
-    stub.DeleteInputs(service_pb2.DeleteInputsRequest(ids=input_ids), metadata=metadata)
-  )