Deprecate Task.completed(), use Task.mark_completed() instead

This commit is contained in:
allegroai 2021-08-20 00:29:41 +03:00
parent 087938671c
commit 99327ecb62
3 changed files with 12 additions and 3 deletions

View File

@ -5,6 +5,7 @@ import logging
import os
import re
import sys
import warnings
from copy import copy
from datetime import datetime
from enum import Enum
@ -559,6 +560,14 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
return self.send(tasks.StoppedRequest(self.id, force=force), ignore_errors=ignore_errors)
def completed(self, ignore_errors=True):
# type: (bool) -> ()
"""
.. note:: Deprecated in 1.1.0
"""
warnings.warn("'completed' is deprecated; use 'mark_completed' instead.", DeprecationWarning)
return self.mark_completed(ignore_errors=ignore_errors)
def mark_completed(self, ignore_errors=True):
# type: (bool) -> ()
""" The signal indicating that this Task completed. """
if hasattr(tasks, 'CompletedRequest') and callable(tasks.CompletedRequest):

View File

@ -417,7 +417,7 @@ class Dataset(object):
self._task.flush(wait_for_uploads=True)
else:
self._task.close()
self._task.completed()
self._task.mark_completed()
if self._task_pinger:
self._task_pinger.unregister()

View File

@ -2237,7 +2237,7 @@ class Task(_Task):
Metrics.report_offline_session(task, session_folder)
# print imported results page
print('ClearML results page: {}'.format(task.get_output_log_web_page()))
task.completed()
task.mark_completed()
# close task
task.close()
@ -3054,7 +3054,7 @@ class Task(_Task):
elif task_status[0] == 'failed':
self.mark_failed(status_reason=task_status[1])
elif task_status[0] == 'completed':
self.completed()
self.mark_completed()
elif task_status[0] == 'stopped':
self.stopped()