Skip to content

Commit 7faf55f

Browse files
bisgaard-itisbisgaard-itis
committed
@sanderegg @pcrespov remove 'rpc' from classnames
1 parent 1718df8 commit 7faf55f

File tree

8 files changed

+70
-70
lines changed

8 files changed

+70
-70
lines changed

‎packages/models-library/src/models_library/api_schemas_rpc_async_jobs/async_jobs.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
from pydantic import BaseModel, Field, PositiveFloat, model_validator
66
from typing_extensions import Self
77

8-
AsyncJobRpcId: TypeAlias = UUID
8+
AsyncJobId: TypeAlias = UUID
99

1010

11-
class AsyncJobRpcStatus(BaseModel):
12-
job_id: AsyncJobRpcId
11+
class AsyncJobStatus(BaseModel):
12+
job_id: AsyncJobId
1313
task_progress: PositiveFloat = Field(..., ge=0.0, le=1.0)
1414
done: bool
1515
started: datetime
@@ -26,16 +26,16 @@ def _check_consistency(self) -> Self:
2626
return self
2727

2828

29-
class AsyncJobRpcResult(BaseModel):
29+
class AsyncJobResult(BaseModel):
3030
result: Any | None
3131
error: Any | None
3232

3333

34-
class AsyncJobRpcGet(BaseModel):
35-
job_id: AsyncJobRpcId
34+
class AsyncJobGet(BaseModel):
35+
job_id: AsyncJobId
3636
task_name: str
3737

3838

39-
class AsyncJobRpcAbort(BaseModel):
39+
class AsyncJobAbort(BaseModel):
4040
result: bool
41-
job_id: AsyncJobRpcId
41+
job_id: AsyncJobId

‎packages/models-library/src/models_library/storage_schemas.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
from pydantic.networks import AnyUrl
3232

3333
from .api_schemas_rpc_async_jobs.async_jobs import (
34-
AsyncJobRpcGet,
35-
AsyncJobRpcResult,
36-
AsyncJobRpcStatus,
34+
AsyncJobGet,
35+
AsyncJobResult,
36+
AsyncJobStatus,
3737
)
3838
from .api_schemas_storage.data_export_async_jobs import DataExportTaskStartInput
3939
from .basic_regex import DATCORE_DATASET_NAME_RE, S3_BUCKET_NAME_RE
@@ -395,7 +395,7 @@ class AsyncJobGet(BaseModel):
395395
job_id: UUID
396396

397397
@classmethod
398-
def from_async_job_rpc_get(cls, async_job_rpc_get: AsyncJobRpcGet) -> "AsyncJobGet":
398+
def from_async_job_rpc_get(cls, async_job_rpc_get: AsyncJobGet) -> "AsyncJobGet":
399399
return AsyncJobGet(job_id=async_job_rpc_get.job_id)
400400

401401

@@ -408,7 +408,7 @@ class AsyncJobStatus(BaseModel):
408408

409409
@classmethod
410410
def from_async_job_rpc_status(
411-
cls, async_job_rpc_status: AsyncJobRpcStatus
411+
cls, async_job_rpc_status: AsyncJobStatus
412412
) -> "AsyncJobStatus":
413413
return AsyncJobStatus(
414414
job_id=async_job_rpc_status.job_id,
@@ -425,7 +425,7 @@ class AsyncJobResult(BaseModel):
425425

426426
@classmethod
427427
def from_async_job_rpc_result(
428-
cls, async_job_rpc_result: AsyncJobRpcResult
428+
cls, async_job_rpc_result: AsyncJobResult
429429
) -> "AsyncJobResult":
430430
return AsyncJobResult(
431431
result=async_job_rpc_result.result, error=async_job_rpc_result.error

‎packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/async_jobs/async_jobs.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
from typing import Final
22

33
from models_library.api_schemas_rpc_async_jobs.async_jobs import (
4-
AsyncJobRpcAbort,
5-
AsyncJobRpcId,
6-
AsyncJobRpcResult,
7-
AsyncJobRpcStatus,
4+
AsyncJobAbort,
5+
AsyncJobId,
6+
AsyncJobResult,
7+
AsyncJobStatus,
88
)
99
from models_library.rabbitmq_basic_types import RPCMethodName, RPCNamespace
1010
from pydantic import NonNegativeInt, TypeAdapter
@@ -20,45 +20,45 @@ async def abort(
2020
rabbitmq_rpc_client: RabbitMQRPCClient,
2121
*,
2222
rpc_namespace: RPCNamespace,
23-
job_id: AsyncJobRpcId
24-
) -> AsyncJobRpcAbort:
23+
job_id: AsyncJobId
24+
) -> AsyncJobAbort:
2525
result = await rabbitmq_rpc_client.request(
2626
rpc_namespace,
2727
_RPC_METHOD_NAME_ADAPTER.validate_python("abort"),
2828
job_id=job_id,
2929
timeout_s=_DEFAULT_TIMEOUT_S,
3030
)
31-
assert isinstance(result, AsyncJobRpcAbort)
31+
assert isinstance(result, AsyncJobAbort)
3232
return result
3333

3434

3535
async def get_status(
3636
rabbitmq_rpc_client: RabbitMQRPCClient,
3737
*,
3838
rpc_namespace: RPCNamespace,
39-
job_id: AsyncJobRpcId
40-
) -> AsyncJobRpcStatus:
39+
job_id: AsyncJobId
40+
) -> AsyncJobStatus:
4141
result = await rabbitmq_rpc_client.request(
4242
rpc_namespace,
4343
_RPC_METHOD_NAME_ADAPTER.validate_python("get_status"),
4444
job_id=job_id,
4545
timeout_s=_DEFAULT_TIMEOUT_S,
4646
)
47-
assert isinstance(result, AsyncJobRpcStatus)
47+
assert isinstance(result, AsyncJobStatus)
4848
return result
4949

5050

5151
async def get_result(
5252
rabbitmq_rpc_client: RabbitMQRPCClient,
5353
*,
5454
rpc_namespace: RPCNamespace,
55-
job_id: AsyncJobRpcId
56-
) -> AsyncJobRpcResult:
55+
job_id: AsyncJobId
56+
) -> AsyncJobResult:
5757
result = await rabbitmq_rpc_client.request(
5858
rpc_namespace,
5959
_RPC_METHOD_NAME_ADAPTER.validate_python("get_result"),
6060
job_id=job_id,
6161
timeout_s=_DEFAULT_TIMEOUT_S,
6262
)
63-
assert isinstance(result, AsyncJobRpcResult)
63+
assert isinstance(result, AsyncJobResult)
6464
return result

‎packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/storage/data_export.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from typing import Final
22

3-
from models_library.api_schemas_rpc_async_jobs.async_jobs import AsyncJobRpcGet
3+
from models_library.api_schemas_rpc_async_jobs.async_jobs import AsyncJobGet
44
from models_library.api_schemas_storage import STORAGE_RPC_NAMESPACE
55
from models_library.api_schemas_storage.data_export_async_jobs import (
66
DataExportTaskStartInput,
@@ -17,12 +17,12 @@
1717

1818
async def start_data_export(
1919
rabbitmq_rpc_client: RabbitMQRPCClient, *, paths: DataExportTaskStartInput
20-
) -> AsyncJobRpcGet:
20+
) -> AsyncJobGet:
2121
result = await rabbitmq_rpc_client.request(
2222
STORAGE_RPC_NAMESPACE,
2323
_RPC_METHOD_NAME_ADAPTER.validate_python("start_data_export"),
2424
paths=paths,
2525
timeout_s=_DEFAULT_TIMEOUT_S,
2626
)
27-
assert isinstance(result, AsyncJobRpcGet)
27+
assert isinstance(result, AsyncJobGet)
2828
return result

‎services/storage/src/simcore_service_storage/api/rpc/_async_jobs.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
from fastapi import FastAPI
44
from models_library.api_schemas_rpc_async_jobs.async_jobs import (
5-
AsyncJobRpcAbort,
6-
AsyncJobRpcId,
7-
AsyncJobRpcResult,
8-
AsyncJobRpcStatus,
5+
AsyncJobAbort,
6+
AsyncJobId,
7+
AsyncJobResult,
8+
AsyncJobStatus,
99
)
1010
from models_library.api_schemas_rpc_async_jobs.exceptions import (
1111
ResultError,
@@ -17,15 +17,15 @@
1717

1818

1919
@router.expose()
20-
async def abort(app: FastAPI, job_id: AsyncJobRpcId) -> AsyncJobRpcAbort:
20+
async def abort(app: FastAPI, job_id: AsyncJobId) -> AsyncJobAbort:
2121
assert app # nosec
22-
return AsyncJobRpcAbort(result=True, job_id=job_id)
22+
return AsyncJobAbort(result=True, job_id=job_id)
2323

2424

2525
@router.expose(reraise_if_error_type=(StatusError,))
26-
async def get_status(app: FastAPI, job_id: AsyncJobRpcId) -> AsyncJobRpcStatus:
26+
async def get_status(app: FastAPI, job_id: AsyncJobId) -> AsyncJobStatus:
2727
assert app # nosec
28-
return AsyncJobRpcStatus(
28+
return AsyncJobStatus(
2929
job_id=job_id,
3030
task_progress=0.5,
3131
done=False,
@@ -35,7 +35,7 @@ async def get_status(app: FastAPI, job_id: AsyncJobRpcId) -> AsyncJobRpcStatus:
3535

3636

3737
@router.expose(reraise_if_error_type=(ResultError,))
38-
async def get_result(app: FastAPI, job_id: AsyncJobRpcId) -> AsyncJobRpcResult:
38+
async def get_result(app: FastAPI, job_id: AsyncJobId) -> AsyncJobResult:
3939
assert app # nosec
4040
assert job_id # nosec
41-
return AsyncJobRpcResult(result="Here's your result.", error=None)
41+
return AsyncJobResult(result="Here's your result.", error=None)

‎services/storage/src/simcore_service_storage/api/rpc/_data_export.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from uuid import uuid4
22

33
from fastapi import FastAPI
4-
from models_library.api_schemas_rpc_async_jobs.async_jobs import AsyncJobRpcGet
4+
from models_library.api_schemas_rpc_async_jobs.async_jobs import AsyncJobGet
55
from models_library.api_schemas_storage.data_export_async_jobs import (
66
AccessRightError,
77
DataExportError,
@@ -22,9 +22,9 @@
2222
)
2323
async def start_data_export(
2424
app: FastAPI, paths: DataExportTaskStartInput
25-
) -> AsyncJobRpcGet:
25+
) -> AsyncJobGet:
2626
assert app # nosec
27-
return AsyncJobRpcGet(
27+
return AsyncJobGet(
2828
job_id=uuid4(),
2929
task_name=", ".join(str(p) for p in paths.paths),
3030
)

‎services/storage/tests/unit/test_data_export.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
from faker import Faker
88
from fastapi import FastAPI
99
from models_library.api_schemas_rpc_async_jobs.async_jobs import (
10-
AsyncJobRpcAbort,
11-
AsyncJobRpcGet,
12-
AsyncJobRpcId,
13-
AsyncJobRpcResult,
14-
AsyncJobRpcStatus,
10+
AsyncJobAbort,
11+
AsyncJobGet,
12+
AsyncJobId,
13+
AsyncJobResult,
14+
AsyncJobStatus,
1515
)
1616
from models_library.api_schemas_storage import STORAGE_RPC_NAMESPACE
1717
from models_library.api_schemas_storage.data_export_async_jobs import (
@@ -80,30 +80,30 @@ async def test_start_data_export(rpc_client: RabbitMQRPCClient, faker: Faker):
8080
rpc_client,
8181
paths=DataExportTaskStartInput(location_id=0, paths=[Path(faker.file_path())]),
8282
)
83-
assert isinstance(result, AsyncJobRpcGet)
83+
assert isinstance(result, AsyncJobGet)
8484

8585

8686
async def test_abort_data_export(rpc_client: RabbitMQRPCClient, faker: Faker):
87-
_job_id = AsyncJobRpcId(faker.uuid4())
87+
_job_id = AsyncJobId(faker.uuid4())
8888
result = await async_jobs.abort(
8989
rpc_client, rpc_namespace=STORAGE_RPC_NAMESPACE, job_id=_job_id
9090
)
91-
assert isinstance(result, AsyncJobRpcAbort)
91+
assert isinstance(result, AsyncJobAbort)
9292
assert result.job_id == _job_id
9393

9494

9595
async def test_get_data_export_status(rpc_client: RabbitMQRPCClient, faker: Faker):
96-
_job_id = AsyncJobRpcId(faker.uuid4())
96+
_job_id = AsyncJobId(faker.uuid4())
9797
result = await async_jobs.get_status(
9898
rpc_client, rpc_namespace=STORAGE_RPC_NAMESPACE, job_id=_job_id
9999
)
100-
assert isinstance(result, AsyncJobRpcStatus)
100+
assert isinstance(result, AsyncJobStatus)
101101
assert result.job_id == _job_id
102102

103103

104104
async def test_get_data_export_result(rpc_client: RabbitMQRPCClient, faker: Faker):
105-
_job_id = AsyncJobRpcId(faker.uuid4())
105+
_job_id = AsyncJobId(faker.uuid4())
106106
result = await async_jobs.get_result(
107107
rpc_client, rpc_namespace=STORAGE_RPC_NAMESPACE, job_id=_job_id
108108
)
109-
assert isinstance(result, AsyncJobRpcResult)
109+
assert isinstance(result, AsyncJobResult)

‎services/web/server/tests/unit/with_dbs/03/test_storage_rpc.py‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
from aiohttp.test_utils import TestClient
77
from faker import Faker
88
from models_library.api_schemas_rpc_async_jobs.async_jobs import (
9-
AsyncJobRpcAbort,
10-
AsyncJobRpcGet,
11-
AsyncJobRpcId,
12-
AsyncJobRpcResult,
13-
AsyncJobRpcStatus,
9+
AsyncJobAbort,
10+
AsyncJobGet,
11+
AsyncJobId,
12+
AsyncJobResult,
13+
AsyncJobStatus,
1414
)
1515
from models_library.api_schemas_rpc_async_jobs.exceptions import (
1616
ResultError,
@@ -57,7 +57,7 @@ def side_effect(*args, **kwargs):
5757
@pytest.mark.parametrize(
5858
"backend_result_or_exception",
5959
[
60-
AsyncJobRpcGet(job_id=AsyncJobRpcId(_faker.uuid4()), task_name=_faker.text()),
60+
AsyncJobGet(job_id=AsyncJobId(_faker.uuid4()), task_name=_faker.text()),
6161
InvalidFileIdentifierError(file_id=Path("/my/file")),
6262
AccessRightError(user_id=_faker.pyint(min_value=0), file_id=Path("/my/file")),
6363
DataExportError(job_id=_faker.pyint(min_value=0)),
@@ -81,7 +81,7 @@ async def test_data_export(
8181
response = await client.post(
8282
"/v0/storage/locations/0/export-data", data=_body.model_dump_json()
8383
)
84-
if isinstance(backend_result_or_exception, AsyncJobRpcGet):
84+
if isinstance(backend_result_or_exception, AsyncJobGet):
8585
assert response.status == status.HTTP_202_ACCEPTED
8686
Envelope[AsyncJobGet].model_validate(await response.json())
8787
elif isinstance(backend_result_or_exception, InvalidFileIdentifierError):
@@ -97,7 +97,7 @@ async def test_data_export(
9797
@pytest.mark.parametrize(
9898
"backend_result_or_exception",
9999
[
100-
AsyncJobRpcStatus(
100+
AsyncJobStatus(
101101
job_id=_faker.uuid4(),
102102
task_progress=0.5,
103103
done=False,
@@ -115,11 +115,11 @@ async def test_get_async_jobs_status(
115115
create_storage_rpc_client_mock: Callable[[str, Any], None],
116116
backend_result_or_exception: Any,
117117
):
118-
_job_id = AsyncJobRpcId(_faker.uuid4())
118+
_job_id = AsyncJobId(_faker.uuid4())
119119
create_storage_rpc_client_mock(get_status.__name__, backend_result_or_exception)
120120

121121
response = await client.get(f"/v0/storage/async-jobs/{_job_id}/status")
122-
if isinstance(backend_result_or_exception, AsyncJobRpcStatus):
122+
if isinstance(backend_result_or_exception, AsyncJobStatus):
123123
assert response.status == status.HTTP_200_OK
124124
response_body_data = (
125125
Envelope[AsyncJobGet].model_validate(await response.json()).data
@@ -141,9 +141,9 @@ async def test_abort_async_jobs(
141141
faker: Faker,
142142
abort_success: bool,
143143
):
144-
_job_id = AsyncJobRpcId(faker.uuid4())
144+
_job_id = AsyncJobId(faker.uuid4())
145145
create_storage_rpc_client_mock(
146-
abort.__name__, AsyncJobRpcAbort(result=abort_success, job_id=_job_id)
146+
abort.__name__, AsyncJobAbort(result=abort_success, job_id=_job_id)
147147
)
148148

149149
response = await client.post(f"/v0/storage/async-jobs/{_job_id}:abort")
@@ -158,7 +158,7 @@ async def test_abort_async_jobs(
158158
@pytest.mark.parametrize(
159159
"backend_result_or_exception",
160160
[
161-
AsyncJobRpcResult(result=None, error=_faker.text()),
161+
AsyncJobResult(result=None, error=_faker.text()),
162162
ResultError(job_id=_faker.uuid4()),
163163
],
164164
ids=lambda x: type(x).__name__,
@@ -171,12 +171,12 @@ async def test_get_async_job_result(
171171
faker: Faker,
172172
backend_result_or_exception: Any,
173173
):
174-
_job_id = AsyncJobRpcId(faker.uuid4())
174+
_job_id = AsyncJobId(faker.uuid4())
175175
create_storage_rpc_client_mock(get_result.__name__, backend_result_or_exception)
176176

177177
response = await client.get(f"/v0/storage/async-jobs/{_job_id}/result")
178178

179-
if isinstance(backend_result_or_exception, AsyncJobRpcResult):
179+
if isinstance(backend_result_or_exception, AsyncJobResult):
180180
assert response.status == status.HTTP_200_OK
181181
elif isinstance(backend_result_or_exception, ResultError):
182182
assert response.status == status.HTTP_500_INTERNAL_SERVER_ERROR

0 commit comments

Comments
 (0)