mirror of
https://github.com/spalencsar/bearhub.git
synced 2026-07-06 22:54:16 +02:00
48 lines
1.6 KiB
Python
48 lines
1.6 KiB
Python
from abc import ABC, abstractmethod
|
|
from typing import Iterable, List, Optional, Tuple
|
|
|
|
from bauh.api.abstract.handler import ProcessWatcher
|
|
|
|
|
|
class FileDownloader(ABC):
|
|
|
|
@abstractmethod
|
|
def download(self, file_url: str, watcher: Optional[ProcessWatcher], output_path: str, cwd: str, root_password: str = None, substatus_prefix: str = None, display_file_size: bool = True, max_threads: int = None, known_size: int = None) -> bool:
|
|
"""
|
|
:param file_url:
|
|
:param watcher:
|
|
:param output_path: the downloaded file output path. Leave None for the current directory and the same file name
|
|
:param cwd: current working directory. Leave None if does not matter.
|
|
:param root_password: (if the output directory is protected)
|
|
:param substatus_prefix: custom substatus prefix ('prefix downloading xpto')
|
|
:param display_file_size: if the file size should be displayed on the substatus
|
|
:param max_threads: maximum number of threads (only available for multi-threaded download)
|
|
:param known_size: known file size
|
|
:return: success / failure
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def is_multithreaded(self) -> bool:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def can_work(self) -> bool:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_supported_multithreaded_clients(self) -> Iterable[str]:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def is_multithreaded_client_available(self, name: str) -> bool:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def list_available_multithreaded_clients(self) -> List[str]:
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_supported_clients(self) -> tuple:
|
|
pass
|