Skip to content

Commit 17e08db

Browse files
committed
feat(lab-4021): rename set_consensus method to update_consensus
1 parent 2594b0f commit 17e08db

File tree

3 files changed

+36
-9
lines changed

3 files changed

+36
-9
lines changed

src/kili/adapters/kili_api_gateway/asset/operations_mixin.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,8 @@ def count_assets_annotations(self, filters: AssetFilters) -> int:
168168
count: int = count_result["data"]
169169
return count
170170

171-
def set_asset_consensus(self, asset_id: str, project_id: str, is_consensus: bool) -> bool:
172-
"""Set consensus on an asset."""
171+
def update_asset_consensus(self, asset_id: str, project_id: str, is_consensus: bool) -> bool:
172+
"""Update consensus on an asset."""
173173
payload = {
174174
"assetId": asset_id,
175175
"projectId": project_id,

src/kili/domain_api/assets.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ class AssetsNamespace(DomainNamespace):
265265
- move_to_next_step(): Move assets to the next workflow step
266266
- assign(): Assign assets to labelers
267267
- update_priority(): Update asset priorities
268-
- add_consensus(): Activate or deactivate consensus on an asset
268+
- update_consensus(): Activate or deactivate consensus on an asset
269269
270270
Examples:
271271
>>> kili = Kili()
@@ -2177,7 +2177,7 @@ def update_priority(
21772177
)
21782178

21792179
@typechecked
2180-
def add_consensus(
2180+
def update_consensus(
21812181
self,
21822182
*,
21832183
asset_id: str,
@@ -2196,22 +2196,22 @@ def add_consensus(
21962196
21972197
Examples:
21982198
>>> # Activate consensus on an asset
2199-
>>> result = kili.assets.add_consensus(
2199+
>>> result = kili.assets.update_consensus(
22002200
... asset_id="ckg22d81r0jrg0885unmuswj8",
22012201
... project_id="my_project",
22022202
... is_consensus=True
22032203
... )
22042204
>>> # result is True
22052205
22062206
>>> # Deactivate consensus on an asset
2207-
>>> result = kili.assets.add_consensus(
2207+
>>> result = kili.assets.update_consensus(
22082208
... asset_id="ckg22d81r0jrg0885unmuswj8",
22092209
... project_id="my_project",
22102210
... is_consensus=False
22112211
... )
22122212
>>> # result is False
22132213
"""
2214-
return self._client.set_asset_consensus(
2214+
return self._client.update_asset_consensus(
22152215
asset_id=asset_id,
22162216
project_id=project_id,
22172217
is_consensus=is_consensus,

src/kili/presentation/client/asset.py

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -766,10 +766,37 @@ def count_assets(
766766
return asset_use_cases.count_assets(filters)
767767

768768
@typechecked
769-
def set_asset_consensus(
769+
def update_asset_consensus(
770770
self,
771771
asset_id: str,
772772
project_id: str,
773773
is_consensus: bool,
774774
) -> bool:
775-
return self.kili_api_gateway.set_asset_consensus(asset_id, project_id, is_consensus)
775+
"""Activate or deactivate consensus on an asset.
776+
777+
Args:
778+
asset_id: The internal asset ID to modify.
779+
project_id: The project ID.
780+
is_consensus: Whether to activate (True) or deactivate (False) consensus on the asset.
781+
782+
Returns:
783+
The consensus value that was set (True if consensus was activated, False if deactivated).
784+
785+
Examples:
786+
>>> # Activate consensus on an asset
787+
>>> result = kili.update_asset_consensus(
788+
... asset_id="ckg22d81r0jrg0885unmuswj8",
789+
... project_id="my_project",
790+
... is_consensus=True
791+
... )
792+
>>> # result is True
793+
794+
>>> # Deactivate consensus on an asset
795+
>>> result = kili.update_asset_consensus(
796+
... asset_id="ckg22d81r0jrg0885unmuswj8",
797+
... project_id="my_project",
798+
... is_consensus=False
799+
... )
800+
>>> # result is False
801+
"""
802+
return self.kili_api_gateway.update_asset_consensus(asset_id, project_id, is_consensus)

0 commit comments

Comments
 (0)