# remote_file_downloader

Python API: `luxonis_ml.data.utils.remote_file_downloader`

## 类

### RemoteFileAPIClient

#### 方法

##### download

```python
def download(url: str, destination: Path, *, timeout: float):
```

### RemoteFileDownloader

下载远程文件，可选择进行图像验证。

#### 方法

##### init

```python
def __init__(api_client: RemoteFileAPIClient | None = None):
```

创建一个远程文件下载器。

参数

 * `api_client` (`RemoteFileAPIClient | None`): 用于 HTTP 和 HTTPS 下载的可选客户端。如果省略，则使用
   [RequestsRemoteFileAPIClient](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/remote_file_downloader.md)。

##### download

```python
def download(url: str, destination: Path, *, timeout: float = 30.0, validate_image: bool = False) -> Path:
```

将文件下载到 `destination`。

现有目标文件将被重用。当 `validate_image` 为 true 时，重用和新下载的文件都将通过 Pillow 和目标后缀进行检查。

参数

 * `url` (`str`): 源 URL。支持的方案有 `file`、`http`、`https`、`gcs`、`gs` 和 `s3`。
 * `destination` (`Path`): 本地目标路径。
 * `timeout` (`float`): HTTP 请求超时时间（秒）。
 * `validate_image` (`bool`): 下载后是否验证图像内容和格式兼容性。

返回

 * `Path`: 本地目标路径。

引发

 * `ValueError`: 如果 URL 方案不受支持，目标图像后缀不受支持，下载的文件不是有效的图像，或者图像格式与后缀不匹配。

#### 属性

##### api_client

用于 HTTP 和 HTTPS 下载的客户端。

### RequestsRemoteFileAPIClient

#### 方法

##### download

```python
def download(url: str, destination: Path, *, timeout: float):
```

## 函数

### download_remote_file

```python
def download_remote_file(url: str, destination: Path, *, timeout: float = 30.0, validate_image: bool = False) -> Path:
```

将远程文件下载到请求的目标。

参数

 * `url` (`str`): 源 URL。
 * `destination` (`Path`): 本地目标路径。
 * `timeout` (`float`): HTTP 请求超时时间（秒）。
 * `validate_image` (`bool`): 下载后是否验证图像内容和格式兼容性。

返回

 * `Path`: 本地目标路径。

引发

 * `ValueError`: 如果 URL 方案不受支持或图像验证失败。

## 属性

### ALLOWED_IMAGE_SUFFIXES

### ALLOWED_IMAGE_SUFFIXES_BY_FORMAT

### ALLOWED_PILLOW_FORMATS_BY_FORMAT

### ALLOWED_REMOTE_URL_SCHEMES

### FS_REMOTE_URL_SCHEMES
