FileObject

class docushare.FileObject(docushare, hdl, title, filename)

Bases: DocuShareBaseObject

Represents one file object in DocuShare.

Parameters

• docushare (DocuShare) – The DocuShare site that this object belongs to.

• hdl (Handle) – The DocuShare handle that represents this object.

• title (str) – Title of this file.

• filename (str) – File name of this file.

Attributes Summary

docushare	The DocuShare site that this object belongs to.
download_url	URL to download this document.
filename	File name of this document.
handle	The DocuShare handle that represents this object.
title	Title of this document.

Methods Summary

download([path, size_for_progress_report])

Download this document from the DocuShare site to the local storage.

Attributes Documentation

docushare

The DocuShare site that this object belongs to.

Type

DocuShare

download_url

URL to download this document.

Type

str

filename

File name of this document.

Type

str

handle

The DocuShare handle that represents this object.

Type

Handle

title

Title of this document.

Type

str

Methods Documentation

download(path=None, size_for_progress_report=1000000)

Download this document from the DocuShare site to the local storage.

Parameters

• path (path-like object or None) – If it is None, this method downloads the document as a file in the current directory and the file name is determined as suggested by the DocuShare site. If it is a directory path, the document is downloaded as a file in the given directory and the file name is determined as suggested by the DocuShare site. If the given path is not a directory or does not exist, the document is downloaded as a file to the given path.

• size_for_progress_report (int) – This method shows a progress bar using tqdm <https://tqdm.github.io/> if the file size is more than the specified size in bytes.

Returns

Path to the downloaded file.

Return type

path-like object