aboutsummaryrefslogtreecommitdiff
path: root/jb/managers/amt.py
diff options
context:
space:
mode:
authorstuppie2026-11-04 12:11:03 -0600
committerstuppie2026-11-04 12:11:03 -0600
commit671a7b1b02503cfa5c9aecd40c27a0c2729a285b (patch)
tree6cb1bd7c33e3e1d243ee5ae74decc57faaa5742d /jb/managers/amt.py
parente99ec6b7e38113a2237dc1ff402d8f4337c651d5 (diff)
downloadamt-jb-671a7b1b02503cfa5c9aecd40c27a0c2729a285b.tar.gz
amt-jb-671a7b1b02503cfa5c9aecd40c27a0c2729a285b.zip
strip out AMT
Diffstat (limited to 'jb/managers/amt.py')
-rw-r--r--jb/managers/amt.py270
1 files changed, 0 insertions, 270 deletions
diff --git a/jb/managers/amt.py b/jb/managers/amt.py
deleted file mode 100644
index 488bbb8..0000000
--- a/jb/managers/amt.py
+++ /dev/null
@@ -1,270 +0,0 @@
-import logging
-from datetime import datetime, timezone
-from typing import Any
-
-import botocore.exceptions
-from generalresearch.currency import USDCent
-from mypy_boto3_mturk import MTurkClient
-from mypy_boto3_mturk.type_defs import (
- AssignmentTypeDef,
- BonusPaymentTypeDef,
- CreateHITTypeResponseTypeDef,
- CreateHITWithHITTypeResponseTypeDef,
- GetHITResponseTypeDef,
-)
-from pydantic import ValidationError
-
-from jb.config import TOPIC_ARN
-from jb.models.amt import AMTAccount
-from jb.models.assignment import Assignment
-from jb.models.bonus import Bonus
-from jb.models.definitions import HitStatus
-from jb.models.hit import Hit, HitQuestion, HitType
-
-LOG = logging.getLogger("amtjb")
-
-REJECT_MESSAGE_UNKNOWN_ASSIGNMENT = "Unknown assignment"
-REJECT_MESSAGE_NO_WORK = "Assignment was submitted with no attempted work."
-REJECT_MESSAGE_BADDIE = "Quality has dropped below an acceptable level"
-APPROVAL_MESSAGE = "Thank you!"
-NO_WORK_APPROVAL_MESSAGE = (
- REJECT_MESSAGE_NO_WORK + " In the future, if you are not sent into a task, "
- "please return the assignment, otherwise it will be rejected!"
-)
-BONUS_MESSAGE = "Great job! Bonus for a survey complete"
-
-
-class AMTManager:
- """
- I am type annotating this more than needed (depending on the editor),
- however it's only because AMT on boto3 is not intuitive... at all.
- """
-
- def __init__(
- self,
- amt_client: MTurkClient,
- **kwargs, # type: ignore
- ):
- super().__init__(**kwargs)
- self.amt_client = amt_client
-
- def fetch_account(self) -> AMTAccount:
- res = self.amt_client.get_account_balance()
-
- return AMTAccount.model_validate(
- {
- "available_balance": res["AvailableBalance"],
- "onhold_balance": res.get("OnHoldBalance", 0),
- }
- )
-
- def get_hit_if_exists(self, amt_hit_id: str) -> tuple[Hit | None, str | None]:
- try:
- res: GetHITResponseTypeDef = self.amt_client.get_hit(HITId=amt_hit_id)
-
- except self.amt_client.exceptions.RequestError as e:
- msg = e.response.get("Error", {}).get("Message", "")
- return None, msg
-
- hit = Hit.from_amt_get_hit(res["HIT"])
- return hit, None
-
- def get_hit_status(self, amt_hit_id: str) -> HitStatus:
- res, msg = self.get_hit_if_exists(amt_hit_id=amt_hit_id)
-
- if res is None:
- if msg is None:
- return HitStatus.Unassignable
-
- if " does not exist. (" in msg:
- return HitStatus.Disposed
-
- else:
- LOG.warning(msg)
- return HitStatus.Unassignable
-
- return res.status
-
- def create_hit_type(self, hit_type: HitType) -> HitType:
- assert hit_type.amt_hit_type_id is None
-
- res: CreateHITTypeResponseTypeDef = self.amt_client.create_hit_type(
- **hit_type.to_api_request_body()
- ) # type: ignore
-
- hit_type.amt_hit_type_id = res["HITTypeId"]
-
- # TODO: Assert / Check that the SNS Notification was
- # successfully created.
- self.amt_client.update_notification_settings(
- HITTypeId=hit_type.amt_hit_type_id,
- Notification={
- "Destination": TOPIC_ARN,
- "Transport": "SNS",
- "Version": "2006-05-05",
- # you can add more events, see mypy_boto3_mturk.literals.EventTypeType
- "EventTypes": ["AssignmentSubmitted"],
- },
- Active=True,
- )
-
- return hit_type
-
- def create_hit_with_hit_type(self, hit_type: HitType, question: HitQuestion) -> Hit:
- """
- HITTypeId: str
- LifetimeInSeconds: int
- MaxAssignments: NotRequired[int]
- Question: NotRequired[str]
- UniqueRequestToken: NotRequired[str]
- """
- assert hit_type.id is not None
- assert hit_type.amt_hit_type_id is not None
-
- data = hit_type.generate_hit_amt_request(question=question)
- res: CreateHITWithHITTypeResponseTypeDef = (
- self.amt_client.create_hit_with_hit_type(**data)
- )
-
- return Hit.from_amt_create_hit(res["HIT"], hit_type=hit_type, question=question)
-
- def get_assignment(self, amt_assignment_id: str) -> Assignment:
- """
- You CANNOT get an Assignment if it has been only ACCEPTED (by the
- worker). The api is stupid, it will only show up once it is Submitted
- """
- res = self.amt_client.get_assignment(AssignmentId=amt_assignment_id)
- ass_res: AssignmentTypeDef = res["Assignment"]
- try:
- assignment = Assignment.from_amt_get_assignment(ass_res)
- except ValidationError as e:
- # Baddies have been known to submit assignments with purposely
- # malformed "answer" (xml) section, which will raise
- # a pydantic validation error. Try to parse again with no Answer.
- LOG.exception(e)
- ass_res["Answer"] = None
- # If it wasn't the Answer that caused the ValidationError, it'll raise again
- assignment = Assignment.from_amt_get_assignment(ass_res)
-
- # to be clear, this has not checked whether it exists in our db
- assert assignment.id is None
- return assignment
-
- def get_assignment_if_exists(self, amt_assignment_id: str) -> Assignment | None:
- expected_err_msg = f"Assignment {amt_assignment_id} does not exist"
-
- try:
- return self.get_assignment(amt_assignment_id=amt_assignment_id)
- except botocore.exceptions.ClientError as e:
- LOG.warning(e)
- error_code = e.response["Error"]["Code"]
- error_msg = e.response["Error"]["Message"]
- if error_code == "RequestError" and expected_err_msg in error_msg:
- return None
- raise e
-
- def reject_assignment_if_possible(
- self, amt_assignment_id: str, msg: str = REJECT_MESSAGE_UNKNOWN_ASSIGNMENT
- ) -> dict[str, Any] | None:
-
- # Unclear to me when this would fail
- try:
- return self.amt_client.reject_assignment(
- AssignmentId=amt_assignment_id, RequesterFeedback=msg
- )
-
- except botocore.exceptions.ClientError as e:
- LOG.warning(e)
- return None
-
- def approve_assignment_if_possible(
- self,
- amt_assignment_id: str,
- msg: str = APPROVAL_MESSAGE,
- override_rejection: bool = False,
- ) -> dict[str, Any] | None:
-
- # Unclear to me when this would fail
- try:
- return self.amt_client.approve_assignment(
- AssignmentId=amt_assignment_id,
- RequesterFeedback=msg,
- OverrideRejection=override_rejection,
- )
-
- except botocore.exceptions.ClientError as e:
- LOG.warning(e)
- return None
-
- def update_hit_review_status(self, amt_hit_id: str, revert: bool = False) -> None:
- try:
- # Reviewable to Reviewing
- self.amt_client.update_hit_review_status(HITId=amt_hit_id, Revert=revert)
-
- except botocore.exceptions.ClientError as e:
- LOG.warning(f"{amt_hit_id=}, {e}")
- error_msg = e.response["Error"]["Message"]
-
- if "does not exist" in error_msg:
- raise ValueError(error_msg)
-
- # elif "This HIT is currently in the state 'Reviewing'" in error_msg:
- # logging.warning(error_msg)
-
- def send_bonus(
- self,
- amt_worker_id: str,
- amount: USDCent,
- amt_assignment_id: str,
- reason: str,
- unique_request_token: str,
- ) -> dict[str, Any] | None:
- try:
- return self.amt_client.send_bonus(
- WorkerId=amt_worker_id,
- BonusAmount=str(amount.to_usd()),
- AssignmentId=amt_assignment_id,
- Reason=reason,
- UniqueRequestToken=unique_request_token,
- )
-
- except botocore.exceptions.ClientError as e:
- LOG.warning(f"{amt_worker_id=} {amt_assignment_id=}, {e}")
- return None
-
- def get_bonus(self, amt_assignment_id: str, payout_event_id: str) -> Bonus | None:
-
- res: list[BonusPaymentTypeDef] = self.amt_client.list_bonus_payments(
- AssignmentId=amt_assignment_id
- )["BonusPayments"]
-
- assert len(res) <= 1, (
- f"{amt_assignment_id=} Expected 1 or 0 bonuses, got {len(res)}"
- )
- d = res[0] if res else None
-
- if d:
- return Bonus.model_validate(
- {
- "amt_worker_id": d["WorkerId"],
- "amount": USDCent(round(float(d["BonusAmount"]) * 100)),
- "amt_assignment_id": d["AssignmentId"],
- "reason": d["Reason"],
- "grant_time": d["GrantTime"].astimezone(tz=timezone.utc),
- "payout_event_id": payout_event_id,
- }
- )
-
- return None
-
- def expire_all_hits(self) -> None:
- # Used in testing only (or in an emergency I guess)
- now = datetime.now(tz=timezone.utc)
- paginator = self.amt_client.get_paginator("list_hits")
-
- for page in paginator.paginate():
- for hit in page["HITs"]:
- if hit["HITStatus"] in ("Assignable", "Reviewable", "Reviewing"):
- self.amt_client.update_expiration_for_hit(
- HITId=hit["HITId"], ExpireAt=now
- )