RemoteSource

class RemoteSource(path: Path, url: str, force: bool = False, download_kwargs: DownloadKwargs | None = None)

Bases: EnsuredSource

A mixin source for remote sources that must be downloaded before opening.

Attributes Summary

download_kwargs
force
path	The local path where the resource is stored on disk.
url	The remove location of the file.

Methods Summary

ensure()

Ensure the remote dataset is downloaded.

Attributes Documentation

Parameters:

• path (Path)

• url (str)

• force (bool)

• download_kwargs (DownloadKwargs | None)

download_kwargs: DownloadKwargs | None = None

force: bool = False

path: Path = <dataclasses._MISSING_TYPE object>

The local path where the resource is stored on disk.

url: str = <dataclasses._MISSING_TYPE object>

The remove location of the file.

Methods Documentation

ensure() → None

Ensure the remote dataset is downloaded.

Return type:

None