Method translate_document_wait_until_done

deepl/translator.py:882–921

Continually polls the status of the document translation associated with the given handle, sleeping in between requests, and returns the final status when the translation completes (whether successful or not). :param handle: DocumentHandle to the document tra

(
        self,
        handle: DocumentHandle,
        timeout_s: Optional[int] = None,
    )

        )

    def translate_document_wait_until_done(
        self,
        handle: DocumentHandle,
        timeout_s: Optional[int] = None,
    ) -> DocumentStatus:
        """
        Continually polls the status of the document translation associated
        with the given handle, sleeping in between requests, and returns the
        final status when the translation completes (whether successful or
        not).
        :param handle: DocumentHandle to the document translation to wait on.
        :param timeout_s: (beta) (Optional) Maximum time to wait before
            the call raises an error. Note that this is not accurate to the
            second, but only polls every 5 seconds.
        :return: DocumentStatus containing the status when completed.
        """
        status = self.translate_document_get_status(handle)
        start_time_s = time.time()
        while status.ok and not status.done:
            if (
                timeout_s is not None
                and time.time() - start_time_s > timeout_s
            ):
                raise DeepLException(
                    f"Manual timeout of {timeout_s}s exceeded for"
                    + " document translation",
                    should_retry=False,
                )
            else:
                secs = (
                    5.0  # seconds_remaining is currently unreliable, so just
                )
                # poll equidistantly
                util.log_info(
                    f"Rechecking document translation status "
                    f"after sleeping for {secs:.3f} seconds."
                )
                time.sleep(secs)
                status = self.translate_document_get_status(handle)
        return status

    def translate_document_download(
        self,