Skip to content

Tasks

Service for managing long-running operations (tasks).

Provides utilities to poll and wait for async operations like merges.

Example

Start a merge operation

task_url = client.companies.merge(primary_id, duplicate_id)

Wait for completion with timeout

task = client.tasks.wait(task_url, timeout=60.0) if task.status == "success": print("Merge completed!")

Source code in affinity/services/tasks.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
class TaskService:
    """
    Service for managing long-running operations (tasks).

    Provides utilities to poll and wait for async operations like merges.

    Example:
        # Start a merge operation
        task_url = client.companies.merge(primary_id, duplicate_id)

        # Wait for completion with timeout
        task = client.tasks.wait(task_url, timeout=60.0)
        if task.status == "success":
            print("Merge completed!")
    """

    def __init__(self, client: HTTPClient):
        self._client = client

    def get(self, task_url: str) -> MergeTask:
        """
        Get the current status of a task.

        Args:
            task_url: The task URL returned from an async operation

        Returns:
            MergeTask with current status
        """
        # Extract task path from full URL if needed
        data = self._client.get_url(task_url)
        return MergeTask.model_validate(data)

    def list_merge_tasks(
        self,
        kind: Literal["company", "person"],
        *,
        status: str | None = None,
        limit: int | None = None,
        cursor: str | None = None,
    ) -> PaginatedResponse[MergeTask]:
        """One page of company or person merge tasks (batches of merges), newest first.

        ``status`` is ``"in-progress"``, ``"success"`` or ``"failed"``. Needs the "Manage
        duplicates" permission and the organization admin role.
        """
        if kind not in ("company", "person"):
            raise ValueError("'kind' must be 'company' or 'person'")
        check_cursor_alone(cursor, status, limit)
        if cursor is not None:
            return page_of(MergeTask, self._client.get_url(cursor))
        params = merge_params(status=status, task_id=None, limit=limit)
        return page_of(MergeTask, self._client.get(f"/tasks/{kind}-merges", params=params or None))

    def iter_merge_tasks(
        self, kind: Literal["company", "person"], *, status: str | None = None
    ) -> Iterator[MergeTask]:
        """All company or person merge tasks (every page); see :meth:`list_merge_tasks`."""

        def fetch_page(next_url: str | None) -> PaginatedResponse[MergeTask]:
            if next_url:
                return self.list_merge_tasks(kind, cursor=next_url)
            return self.list_merge_tasks(kind, status=status)

        return PageIterator(fetch_page)

    def wait(
        self,
        task_url: str,
        *,
        timeout: float = 300.0,
        poll_interval: float = 2.0,
        max_poll_interval: float = 30.0,
    ) -> MergeTask:
        """
        Wait for a task to complete with exponential backoff.

        Args:
            task_url: The task URL returned from an async operation
            timeout: Maximum time to wait in seconds (default: 5 minutes)
            poll_interval: Initial polling interval in seconds
            max_poll_interval: Maximum polling interval after backoff

        Returns:
            MergeTask with final status

        Raises:
            TimeoutError: If task doesn't complete within timeout
            AffinityError: If task fails
        """
        start_time = time.monotonic()
        current_interval = poll_interval

        while True:
            task = self.get(task_url)

            if task.status in (TaskStatus.SUCCESS, TaskStatus.FAILED):
                if task.status == TaskStatus.FAILED:
                    raise AffinityError(
                        f"Task failed: {task_url}",
                        status_code=None,
                        response_body={"task": task.model_dump()},
                    )
                return task

            # Check timeout
            remaining = timeout - (time.monotonic() - start_time)
            if remaining <= 0:
                raise AffinityTimeoutError(f"Task did not complete within {timeout}s: {task_url}")

            # Wait with jitter before next poll, never past the deadline (the poll after that
            # last sleep is the final one)
            jitter = random.uniform(0, current_interval * 0.1)
            time.sleep(min(current_interval + jitter, remaining))

            # Exponential backoff, capped at max
            current_interval = min(current_interval * 1.5, max_poll_interval)

get(task_url: str) -> MergeTask

Get the current status of a task.

Parameters:

Name Type Description Default
task_url str

The task URL returned from an async operation

 required

Returns:

Type Description
MergeTask

MergeTask with current status
Source code in affinity/services/tasks.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
def get(self, task_url: str) -> MergeTask:
    """
    Get the current status of a task.

    Args:
        task_url: The task URL returned from an async operation

    Returns:
        MergeTask with current status
    """
    # Extract task path from full URL if needed
    data = self._client.get_url(task_url)
    return MergeTask.model_validate(data)

iter_merge_tasks(kind: Literal['company', 'person'], *, status: str | None = None) -> Iterator[MergeTask]

All company or person merge tasks (every page); see :meth:list_merge_tasks.

Source code in affinity/services/tasks.py 
88
89
90
91
92
93
94
95
96
97
98
def iter_merge_tasks(
    self, kind: Literal["company", "person"], *, status: str | None = None
) -> Iterator[MergeTask]:
    """All company or person merge tasks (every page); see :meth:`list_merge_tasks`."""

    def fetch_page(next_url: str | None) -> PaginatedResponse[MergeTask]:
        if next_url:
            return self.list_merge_tasks(kind, cursor=next_url)
        return self.list_merge_tasks(kind, status=status)

    return PageIterator(fetch_page)

list_merge_tasks(kind: Literal['company', 'person'], *, status: str | None = None, limit: int | None = None, cursor: str | None = None) -> PaginatedResponse[MergeTask]

One page of company or person merge tasks (batches of merges), newest first.

status is "in-progress", "success" or "failed". Needs the "Manage duplicates" permission and the organization admin role.

Source code in affinity/services/tasks.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def list_merge_tasks(
    self,
    kind: Literal["company", "person"],
    *,
    status: str | None = None,
    limit: int | None = None,
    cursor: str | None = None,
) -> PaginatedResponse[MergeTask]:
    """One page of company or person merge tasks (batches of merges), newest first.

    ``status`` is ``"in-progress"``, ``"success"`` or ``"failed"``. Needs the "Manage
    duplicates" permission and the organization admin role.
    """
    if kind not in ("company", "person"):
        raise ValueError("'kind' must be 'company' or 'person'")
    check_cursor_alone(cursor, status, limit)
    if cursor is not None:
        return page_of(MergeTask, self._client.get_url(cursor))
    params = merge_params(status=status, task_id=None, limit=limit)
    return page_of(MergeTask, self._client.get(f"/tasks/{kind}-merges", params=params or None))

wait(task_url: str, *, timeout: float = 300.0, poll_interval: float = 2.0, max_poll_interval: float = 30.0) -> MergeTask

Wait for a task to complete with exponential backoff.

Parameters:

Name Type Description Default
task_url str

The task URL returned from an async operation

 required
timeout float

Maximum time to wait in seconds (default: 5 minutes)

 300.0
poll_interval float

Initial polling interval in seconds

 2.0
max_poll_interval float

Maximum polling interval after backoff

 30.0

Returns:

Type Description
MergeTask

MergeTask with final status

Raises:

Type Description
TimeoutError

If task doesn't complete within timeout
AffinityError

If task fails
Source code in affinity/services/tasks.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def wait(
    self,
    task_url: str,
    *,
    timeout: float = 300.0,
    poll_interval: float = 2.0,
    max_poll_interval: float = 30.0,
) -> MergeTask:
    """
    Wait for a task to complete with exponential backoff.

    Args:
        task_url: The task URL returned from an async operation
        timeout: Maximum time to wait in seconds (default: 5 minutes)
        poll_interval: Initial polling interval in seconds
        max_poll_interval: Maximum polling interval after backoff

    Returns:
        MergeTask with final status

    Raises:
        TimeoutError: If task doesn't complete within timeout
        AffinityError: If task fails
    """
    start_time = time.monotonic()
    current_interval = poll_interval

    while True:
        task = self.get(task_url)

        if task.status in (TaskStatus.SUCCESS, TaskStatus.FAILED):
            if task.status == TaskStatus.FAILED:
                raise AffinityError(
                    f"Task failed: {task_url}",
                    status_code=None,
                    response_body={"task": task.model_dump()},
                )
            return task

        # Check timeout
        remaining = timeout - (time.monotonic() - start_time)
        if remaining <= 0:
            raise AffinityTimeoutError(f"Task did not complete within {timeout}s: {task_url}")

        # Wait with jitter before next poll, never past the deadline (the poll after that
        # last sleep is the final one)
        jitter = random.uniform(0, current_interval * 0.1)
        time.sleep(min(current_interval + jitter, remaining))

        # Exponential backoff, capped at max
        current_interval = min(current_interval * 1.5, max_poll_interval)

Async version of TaskService.

Example

Start a merge operation

task_url = await client.companies.merge(primary_id, duplicate_id)

Wait for completion with timeout

task = await client.tasks.wait(task_url, timeout=60.0)

Source code in affinity/services/tasks.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
class AsyncTaskService:
    """
    Async version of TaskService.

    Example:
        # Start a merge operation
        task_url = await client.companies.merge(primary_id, duplicate_id)

        # Wait for completion with timeout
        task = await client.tasks.wait(task_url, timeout=60.0)
    """

    def __init__(self, client: AsyncHTTPClient):
        self._client = client

    async def get(self, task_url: str) -> MergeTask:
        """
        Get the current status of a task.

        Args:
            task_url: The task URL returned from an async operation

        Returns:
            MergeTask with current status
        """
        data = await self._client.get_url(task_url)
        return MergeTask.model_validate(data)

    async def list_merge_tasks(
        self,
        kind: Literal["company", "person"],
        *,
        status: str | None = None,
        limit: int | None = None,
        cursor: str | None = None,
    ) -> PaginatedResponse[MergeTask]:
        """One page of company or person merge tasks (batches of merges), newest first.

        ``status`` is ``"in-progress"``, ``"success"`` or ``"failed"``. Needs the "Manage
        duplicates" permission and the organization admin role.
        """
        if kind not in ("company", "person"):
            raise ValueError("'kind' must be 'company' or 'person'")
        check_cursor_alone(cursor, status, limit)
        if cursor is not None:
            return page_of(MergeTask, await self._client.get_url(cursor))
        params = merge_params(status=status, task_id=None, limit=limit)
        return page_of(
            MergeTask, await self._client.get(f"/tasks/{kind}-merges", params=params or None)
        )

    def iter_merge_tasks(
        self, kind: Literal["company", "person"], *, status: str | None = None
    ) -> AsyncIterator[MergeTask]:
        """All company or person merge tasks (every page); see :meth:`list_merge_tasks`."""

        async def fetch_page(next_url: str | None) -> PaginatedResponse[MergeTask]:
            if next_url:
                return await self.list_merge_tasks(kind, cursor=next_url)
            return await self.list_merge_tasks(kind, status=status)

        return AsyncPageIterator(fetch_page)

    async def wait(
        self,
        task_url: str,
        *,
        timeout: float = 300.0,
        poll_interval: float = 2.0,
        max_poll_interval: float = 30.0,
    ) -> MergeTask:
        """
        Wait for a task to complete with exponential backoff.

        Args:
            task_url: The task URL returned from an async operation
            timeout: Maximum time to wait in seconds (default: 5 minutes)
            poll_interval: Initial polling interval in seconds
            max_poll_interval: Maximum polling interval after backoff

        Returns:
            MergeTask with final status

        Raises:
            TimeoutError: If task doesn't complete within timeout
            AffinityError: If task fails
        """
        start_time = time.monotonic()
        current_interval = poll_interval

        while True:
            task = await self.get(task_url)

            if task.status in (TaskStatus.SUCCESS, TaskStatus.FAILED):
                if task.status == TaskStatus.FAILED:
                    raise AffinityError(
                        f"Task failed: {task_url}",
                        status_code=None,
                        response_body={"task": task.model_dump()},
                    )
                return task

            # Check timeout
            remaining = timeout - (time.monotonic() - start_time)
            if remaining <= 0:
                raise AffinityTimeoutError(f"Task did not complete within {timeout}s: {task_url}")

            # Wait with jitter before next poll, never past the deadline (the poll after that
            # last sleep is the final one)
            jitter = random.uniform(0, current_interval * 0.1)
            await asyncio.sleep(min(current_interval + jitter, remaining))

            # Exponential backoff, capped at max
            current_interval = min(current_interval * 1.5, max_poll_interval)

get(task_url: str) -> MergeTask async

Get the current status of a task.

Parameters:

Name Type Description Default
task_url str

The task URL returned from an async operation

 required

Returns:

Type Description
MergeTask

MergeTask with current status
Source code in affinity/services/tasks.py 
168
169
170
171
172
173
174
175
176
177
178
179
async def get(self, task_url: str) -> MergeTask:
    """
    Get the current status of a task.

    Args:
        task_url: The task URL returned from an async operation

    Returns:
        MergeTask with current status
    """
    data = await self._client.get_url(task_url)
    return MergeTask.model_validate(data)

iter_merge_tasks(kind: Literal['company', 'person'], *, status: str | None = None) -> AsyncIterator[MergeTask]

All company or person merge tasks (every page); see :meth:list_merge_tasks.

Source code in affinity/services/tasks.py 
204
205
206
207
208
209
210
211
212
213
214
def iter_merge_tasks(
    self, kind: Literal["company", "person"], *, status: str | None = None
) -> AsyncIterator[MergeTask]:
    """All company or person merge tasks (every page); see :meth:`list_merge_tasks`."""

    async def fetch_page(next_url: str | None) -> PaginatedResponse[MergeTask]:
        if next_url:
            return await self.list_merge_tasks(kind, cursor=next_url)
        return await self.list_merge_tasks(kind, status=status)

    return AsyncPageIterator(fetch_page)

list_merge_tasks(kind: Literal['company', 'person'], *, status: str | None = None, limit: int | None = None, cursor: str | None = None) -> PaginatedResponse[MergeTask] async

One page of company or person merge tasks (batches of merges), newest first.

status is "in-progress", "success" or "failed". Needs the "Manage duplicates" permission and the organization admin role.

Source code in affinity/services/tasks.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
async def list_merge_tasks(
    self,
    kind: Literal["company", "person"],
    *,
    status: str | None = None,
    limit: int | None = None,
    cursor: str | None = None,
) -> PaginatedResponse[MergeTask]:
    """One page of company or person merge tasks (batches of merges), newest first.

    ``status`` is ``"in-progress"``, ``"success"`` or ``"failed"``. Needs the "Manage
    duplicates" permission and the organization admin role.
    """
    if kind not in ("company", "person"):
        raise ValueError("'kind' must be 'company' or 'person'")
    check_cursor_alone(cursor, status, limit)
    if cursor is not None:
        return page_of(MergeTask, await self._client.get_url(cursor))
    params = merge_params(status=status, task_id=None, limit=limit)
    return page_of(
        MergeTask, await self._client.get(f"/tasks/{kind}-merges", params=params or None)
    )

wait(task_url: str, *, timeout: float = 300.0, poll_interval: float = 2.0, max_poll_interval: float = 30.0) -> MergeTask async

Wait for a task to complete with exponential backoff.

Parameters:

Name Type Description Default
task_url str

The task URL returned from an async operation

 required
timeout float

Maximum time to wait in seconds (default: 5 minutes)

 300.0
poll_interval float

Initial polling interval in seconds

 2.0
max_poll_interval float

Maximum polling interval after backoff

 30.0

Returns:

Type Description
MergeTask

MergeTask with final status

Raises:

Type Description
TimeoutError

If task doesn't complete within timeout
AffinityError

If task fails
Source code in affinity/services/tasks.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
async def wait(
    self,
    task_url: str,
    *,
    timeout: float = 300.0,
    poll_interval: float = 2.0,
    max_poll_interval: float = 30.0,
) -> MergeTask:
    """
    Wait for a task to complete with exponential backoff.

    Args:
        task_url: The task URL returned from an async operation
        timeout: Maximum time to wait in seconds (default: 5 minutes)
        poll_interval: Initial polling interval in seconds
        max_poll_interval: Maximum polling interval after backoff

    Returns:
        MergeTask with final status

    Raises:
        TimeoutError: If task doesn't complete within timeout
        AffinityError: If task fails
    """
    start_time = time.monotonic()
    current_interval = poll_interval

    while True:
        task = await self.get(task_url)

        if task.status in (TaskStatus.SUCCESS, TaskStatus.FAILED):
            if task.status == TaskStatus.FAILED:
                raise AffinityError(
                    f"Task failed: {task_url}",
                    status_code=None,
                    response_body={"task": task.model_dump()},
                )
            return task

        # Check timeout
        remaining = timeout - (time.monotonic() - start_time)
        if remaining <= 0:
            raise AffinityTimeoutError(f"Task did not complete within {timeout}s: {task_url}")

        # Wait with jitter before next poll, never past the deadline (the poll after that
        # last sleep is the final one)
        jitter = random.uniform(0, current_interval * 0.1)
        await asyncio.sleep(min(current_interval + jitter, remaining))

        # Exponential backoff, capped at max
        current_interval = min(current_interval * 1.5, max_poll_interval)