arkindex-base-worker 0.4.0rc5__py3-none-any.whl → 0.5.0__py3-none-any.whl

arkindex_worker/worker/version.py

@@ -1,58 +0,0 @@
-"""
-ElementsWorker methods for worker versions.
-"""
-
-import functools
-from warnings import warn
-
-
-def worker_version_deprecation(func):
-    @functools.wraps(func)
-    def wrapper(self, *args, **kwargs):
-        warn("WorkerVersion usage is deprecated.", DeprecationWarning, stacklevel=2)
-        return func(self, *args, **kwargs)
-
-    return wrapper
-
-
-class WorkerVersionMixin:
-    @worker_version_deprecation
-    def get_worker_version(self, worker_version_id: str) -> dict:
-        """
-        Warns:
-        ----
-        This method is **deprecated**.
-
-        Retrieve a worker version, using the [ElementsWorker][arkindex_worker.worker.ElementsWorker]'s internal cache when possible.
-
-        :param worker_version_id: ID of the worker version to retrieve.
-        :returns: The requested worker version, as returned by the ``RetrieveWorkerVersion`` API endpoint.
-        """
-        if worker_version_id is None:
-            raise ValueError("No worker version ID")
-
-        if worker_version_id in self._worker_version_cache:
-            return self._worker_version_cache[worker_version_id]
-
-        worker_version = self.api_client.request(
-            "RetrieveWorkerVersion", id=worker_version_id
-        )
-        self._worker_version_cache[worker_version_id] = worker_version
-
-        return worker_version
-
-    @worker_version_deprecation
-    def get_worker_version_slug(self, worker_version_id: str) -> str:
-        """
-        Warns:
-        ----
-        This method is **deprecated**.
-
-        Retrieve the slug of the worker of a worker version, from a worker version UUID.
-        Uses a worker version from the internal cache if possible, otherwise makes an API request.
-
-        :param worker_version_id: ID of the worker version to find a slug for.
-        :returns: Slug of the worker of this worker version.
-        """
-        worker_version = self.get_worker_version(worker_version_id)
-        return worker_version["worker"]["slug"]

tests/test_elements_worker/test_entity_list_and_check.py

@@ -1,160 +0,0 @@
-import pytest
-from responses import matchers
-
-from arkindex_worker.models import Transcription
-from arkindex_worker.worker.entity import MissingEntityType
-from tests import CORPUS_ID
-
-from . import BASE_API_CALLS
-
-
-def test_check_required_entity_types(responses, mock_elements_worker):
-    # Set one entity type
-    mock_elements_worker.entity_types = {"person": "person-entity-type-id"}
-
-    checked_types = ["person", "new-entity"]
-
-    # Call to create new entity type
-    responses.add(
-        responses.POST,
-        "http://testserver/api/v1/entity/types/",
-        status=200,
-        match=[
-            matchers.json_params_matcher(
-                {
-                    "name": "new-entity",
-                    "corpus": CORPUS_ID,
-                }
-            )
-        ],
-        json={
-            "id": "new-entity-id",
-            "corpus": CORPUS_ID,
-            "name": "new-entity",
-            "color": "ffd1b3",
-        },
-    )
-
-    mock_elements_worker.check_required_entity_types(
-        entity_types=checked_types,
-    )
-
-    # Make sure the entity_types entry has been updated
-    assert mock_elements_worker.entity_types == {
-        "person": "person-entity-type-id",
-        "new-entity": "new-entity-id",
-    }
-
-    assert len(responses.calls) == len(BASE_API_CALLS) + 1
-    assert [
-        (call.request.method, call.request.url) for call in responses.calls
-    ] == BASE_API_CALLS + [
-        (
-            "POST",
-            "http://testserver/api/v1/entity/types/",
-        ),
-    ]
-
-
-def test_check_required_entity_types_no_creation_allowed(
-    responses, mock_elements_worker
-):
-    # Set one entity type
-    mock_elements_worker.entity_types = {"person": "person-entity-type-id"}
-
-    checked_types = ["person", "new-entity"]
-
-    with pytest.raises(
-        MissingEntityType, match="Entity type `new-entity` was not in the corpus."
-    ):
-        mock_elements_worker.check_required_entity_types(
-            entity_types=checked_types, create_missing=False
-        )
-
-    assert len(responses.calls) == len(BASE_API_CALLS)
-    assert [
-        (call.request.method, call.request.url) for call in responses.calls
-    ] == BASE_API_CALLS
-
-
-def test_list_transcription_entities_deprecation(fake_dummy_worker):
-    transcription = Transcription({"id": "fake_transcription_id"})
-    worker_version = "worker_version_id"
-    fake_dummy_worker.api_client.add_response(
-        "ListTranscriptionEntities",
-        id=transcription.id,
-        worker_version=worker_version,
-        response={"id": "entity_id"},
-    )
-    with pytest.deprecated_call(
-        match="`worker_version` usage is deprecated. Consider using `worker_run` instead."
-    ):
-        assert fake_dummy_worker.list_transcription_entities(
-            transcription, worker_version=worker_version
-        ) == {"id": "entity_id"}
-
-    assert len(fake_dummy_worker.api_client.history) == 1
-    assert len(fake_dummy_worker.api_client.responses) == 0
-
-
-def test_list_transcription_entities(fake_dummy_worker):
-    transcription = Transcription({"id": "fake_transcription_id"})
-    worker_run = "worker_run_id"
-    fake_dummy_worker.api_client.add_response(
-        "ListTranscriptionEntities",
-        id=transcription.id,
-        worker_run=worker_run,
-        response={"id": "entity_id"},
-    )
-    assert fake_dummy_worker.list_transcription_entities(
-        transcription, worker_run=worker_run
-    ) == {"id": "entity_id"}
-
-    assert len(fake_dummy_worker.api_client.history) == 1
-    assert len(fake_dummy_worker.api_client.responses) == 0
-
-
-def test_list_corpus_entities(responses, mock_elements_worker):
-    responses.add(
-        responses.GET,
-        f"http://testserver/api/v1/corpus/{CORPUS_ID}/entities/",
-        json={
-            "count": 1,
-            "next": None,
-            "results": [
-                {
-                    "id": "fake_entity_id",
-                }
-            ],
-        },
-    )
-
-    mock_elements_worker.list_corpus_entities()
-
-    assert mock_elements_worker.entities == {
-        "fake_entity_id": {
-            "id": "fake_entity_id",
-        }
-    }
-
-    assert len(responses.calls) == len(BASE_API_CALLS) + 1
-    assert [
-        (call.request.method, call.request.url) for call in responses.calls
-    ] == BASE_API_CALLS + [
-        (
-            "GET",
-            f"http://testserver/api/v1/corpus/{CORPUS_ID}/entities/",
-        ),
-    ]
-
-
-@pytest.mark.parametrize("wrong_name", [1234, 12.5])
-def test_list_corpus_entities_wrong_name(mock_elements_worker, wrong_name):
-    with pytest.raises(AssertionError, match="name should be of type str"):
-        mock_elements_worker.list_corpus_entities(name=wrong_name)
-
-
-@pytest.mark.parametrize("wrong_parent", [{"id": "element_id"}, 12.5, "blabla"])
-def test_list_corpus_entities_wrong_parent(mock_elements_worker, wrong_parent):
-    with pytest.raises(AssertionError, match="parent should be of type Element"):
-        mock_elements_worker.list_corpus_entities(parent=wrong_parent)

tests/test_elements_worker/test_version.py

@@ -1,60 +0,0 @@
-import pytest
-
-TEST_VERSION_ID = "test_123"
-TEST_SLUG = "some_slug"
-
-
-def test_get_worker_version(fake_dummy_worker):
-    api_client = fake_dummy_worker.api_client
-
-    response = {"worker": {"slug": TEST_SLUG}}
-
-    api_client.add_response("RetrieveWorkerVersion", response, id=TEST_VERSION_ID)
-
-    with pytest.deprecated_call(match="WorkerVersion usage is deprecated."):
-        res = fake_dummy_worker.get_worker_version(TEST_VERSION_ID)
-
-    assert res == response
-    assert fake_dummy_worker._worker_version_cache[TEST_VERSION_ID] == response
-
-
-def test_get_worker_version__uses_cache(fake_dummy_worker):
-    api_client = fake_dummy_worker.api_client
-
-    response = {"worker": {"slug": TEST_SLUG}}
-
-    api_client.add_response("RetrieveWorkerVersion", response, id=TEST_VERSION_ID)
-
-    with pytest.deprecated_call(match="WorkerVersion usage is deprecated."):
-        response_1 = fake_dummy_worker.get_worker_version(TEST_VERSION_ID)
-
-    with pytest.deprecated_call(match="WorkerVersion usage is deprecated."):
-        response_2 = fake_dummy_worker.get_worker_version(TEST_VERSION_ID)
-
-    assert response_1 == response
-    assert response_1 == response_2
-
-    # assert that only one call to the API
-    assert len(api_client.history) == 1
-    assert not api_client.responses
-
-
-def test_get_worker_version_slug(mocker, fake_dummy_worker):
-    fake_dummy_worker.get_worker_version = mocker.MagicMock()
-    fake_dummy_worker.get_worker_version.return_value = {
-        "id": TEST_VERSION_ID,
-        "worker": {"slug": "mock_slug"},
-    }
-
-    with pytest.deprecated_call(match="WorkerVersion usage is deprecated."):
-        slug = fake_dummy_worker.get_worker_version_slug(TEST_VERSION_ID)
-    assert slug == "mock_slug"
-
-
-def test_get_worker_version_slug_none(fake_dummy_worker):
-    # WARNING: pytest.deprecated_call must be placed BEFORE pytest.raises, otherwise `match` argument won't be checked
-    with (
-        pytest.deprecated_call(match="WorkerVersion usage is deprecated."),
-        pytest.raises(ValueError, match="No worker version ID"),
-    ):
-        fake_dummy_worker.get_worker_version_slug(None)