QWebEngineDownloadItem

The QWebEngineDownloadItem class provides information about a download. More…

Inheritance diagram of PySide2.QtWebEngineWidgets.QWebEngineDownloadItem

Synopsis

Functions

Slots

Signals

Detailed Description

QWebEngineDownloadItem models a download throughout its life cycle, starting with a pending download request and finishing with a completed download. It can be used, for example, to get information about new downloads, to monitor progress, and to pause, resume, and cancel downloads.

Downloads are usually triggered by user interaction on a web page. It is the QWebEngineProfile ‘s responsibility to notify the application of new download requests, which it does by emitting the downloadRequested signal together with a newly created QWebEngineDownloadItem . The application can then examine this item and decide whether to accept it or not. A signal handler must explicitly call accept() on the item for Qt WebEngine to actually start downloading and writing data to disk. If no signal handler calls accept() , then the download request will be automatically rejected and nothing will be written to disk.

Note

Some properties, such as setting the path and file name where the file will be saved (see downloadDirectory() and downloadFileName() ), can only be changed before calling accept() .

Object Life Cycle

All items are guaranteed to be valid during the emission of the downloadRequested signal. If accept() is not called by any signal handler, then the item will be deleted immediately after signal emission. This means that the application must not keep references to rejected download items. It also means the application should not use a queued connection to this signal.

If accept() is called by a signal handler, then the QWebEngineProfile will take ownership of the item. However, it is safe for the application to delete the item at any time, except during the handling of the downloadRequested signal. The QWebEngineProfile being a long-lived object, it is in fact recommended that the application delete any items it is no longer interested in.

Note

Deleting an item will also automatically cancel a download since 5.12.2, but it is recommended to cancel manually before deleting for portability.

Web Page Downloads

In addition to normal file downloads, which consist simply of retrieving some raw bytes from the network and writing them to disk, Qt WebEngine also supports saving complete web pages, which involves parsing the page’s HTML, downloading any dependent resources, and potentially packaging everything into a special file format ( savePageFormat ). To check if a download is for a file or a web page, use isSavePageDownload .

See also

QWebEngineProfile downloadRequested download save

class PySide2.QtWebEngineWidgets.QWebEngineDownloadItem
PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.DownloadState

This enum describes the state of the download:

Constant

Description

QWebEngineDownloadItem.DownloadRequested

Download has been requested, but has not been accepted yet.

QWebEngineDownloadItem.DownloadInProgress

Download is in progress.

QWebEngineDownloadItem.DownloadCompleted

Download completed successfully.

QWebEngineDownloadItem.DownloadCancelled

Download has been cancelled.

QWebEngineDownloadItem.DownloadInterrupted

Download has been interrupted (by the server or because of lost connectivity).
PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.SavePageFormat

This enum describes the format that is used to save a web page.

Constant

Description

QWebEngineDownloadItem.UnknownSaveFormat

This is not a request for downloading a complete web page.

QWebEngineDownloadItem.SingleHtmlSaveFormat

The page is saved as a single HTML page. Resources such as images are not saved.

QWebEngineDownloadItem.CompleteHtmlSaveFormat

The page is saved as a complete HTML page, for example a directory containing the single HTML page and the resources.

QWebEngineDownloadItem.MimeHtmlSaveFormat

The page is saved as a complete web page in the MIME HTML format.
PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.DownloadInterruptReason

Describes the reason why a download was interrupted:

Constant

Description

QWebEngineDownloadItem.NoReason

Unknown reason or not interrupted.

QWebEngineDownloadItem.FileFailed

General file operation failure.

QWebEngineDownloadItem.FileAccessDenied

The file cannot be written locally, due to access restrictions.

QWebEngineDownloadItem.FileNoSpace

Insufficient space on the target drive.

QWebEngineDownloadItem.FileNameTooLong

The directory or file name is too long.

QWebEngineDownloadItem.FileTooLarge

The file size exceeds the file system limitation.

QWebEngineDownloadItem.FileVirusInfected

The file is infected with a virus.

QWebEngineDownloadItem.FileTransientError

Temporary problem (for example the file is in use, out of memory, or too many files are opened at once).

QWebEngineDownloadItem.FileBlocked

The file was blocked due to local policy.

QWebEngineDownloadItem.FileSecurityCheckFailed

An attempt to check the safety of the download failed due to unexpected reasons.

QWebEngineDownloadItem.FileTooShort

An attempt was made to seek past the end of a file when opening a file (as part of resuming a previously interrupted download).

QWebEngineDownloadItem.FileHashMismatch

The partial file did not match the expected hash.

QWebEngineDownloadItem.NetworkFailed

General network failure.

QWebEngineDownloadItem.NetworkTimeout

The network operation has timed out.

QWebEngineDownloadItem.NetworkDisconnected

The network connection has been terminated.

QWebEngineDownloadItem.NetworkServerDown

The server has gone down.

QWebEngineDownloadItem.NetworkInvalidRequest

The network request was invalid (for example, the original or redirected URL is invalid, has an unsupported scheme, or is disallowed by policy).

QWebEngineDownloadItem.ServerFailed

General server failure.

QWebEngineDownloadItem.ServerBadContent

The server does not have the requested data.

QWebEngineDownloadItem.ServerUnauthorized

The server did not authorize access to the resource.

QWebEngineDownloadItem.ServerCertProblem

A problem with the server certificate occurred.

QWebEngineDownloadItem.ServerForbidden

Access forbidden by the server.

QWebEngineDownloadItem.ServerUnreachable

Unexpected server response (might indicate that the responding server may not be the intended server).

QWebEngineDownloadItem.UserCanceled

The user canceled the download.
PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.DownloadType

Describes the requested download’s type.

Constant

Description

QWebEngineDownloadItem.Attachment

The web server’s response includes a Content-Disposition header with the attachment directive. If Content-Disposition is present in the reply, the web server is indicating that the client should prompt the user to save the content regardless of the content type. See RFC 2616 section 19.5.1 for details.

QWebEngineDownloadItem.DownloadAttribute

The user clicked a link with the download attribute.

QWebEngineDownloadItem.UserRequested

The user initiated the download, for example by selecting a web action.

QWebEngineDownloadItem.SavePage

Saving of the current page was requested (for example by the SavePage web action).
PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.accept()

Accepts the current download request, which will start the download.

If the item is in the DownloadRequested state, then it will transition into the DownloadInProgress state and the downloading will begin. If the item is in any other state, then nothing will happen.

See also

finished() stateChanged()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.cancel()

Cancels the current download.

If the item is in the DownloadInProgress state, then it will transition into the DownloadCancelled state, the downloading will stop, and partially downloaded files will be deleted from disk.

If the item is in the DownloadCompleted state, then nothing will happen. If the item is in any other state, then it will transition into the DownloadCancelled state without further effect.

See also

finished() stateChanged()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.downloadDirectory()
Return type:

str

Returns the download directory path.

See also

setDownloadDirectory()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.downloadFileName()
Return type:

str

Returns the file name to download the file to.

See also

setDownloadFileName()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.downloadProgress(bytesReceived, bytesTotal)
Parameters:

  • bytesReceived – int

  • bytesTotal – int

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.finished()
PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.id()
Return type:

int

Returns the download item’s ID.

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.interruptReason()
Return type:

DownloadInterruptReason

Returns the reason why the download was interrupted.

See also

interruptReasonString()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.interruptReasonString()
Return type:

str

Returns a human-readable description of the reason for interrupting the download.

See also

interruptReason()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.isFinished()
Return type:

bool

Returns whether this download is finished (completed, cancelled, or non-resumable interrupted state).

See also

finished() state()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.isPaused()
Return type:

bool

Returns whether this download is paused.

See also

pause() resume()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.isPausedChanged(isPaused)
Parameters:

isPaused – bool

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.isSavePageDownload()
Return type:

bool

Returns true if this is a download request for saving a web page.

See also

savePageFormat() setSavePageFormat()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.mimeType()
Return type:

str

Returns the MIME type of the download.

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.page()
Return type:

PySide2.QtWebEngineWidgets.QWebEnginePage

Returns the page the download was requested on. If the download was not triggered by content in a page, nullptr is returned.

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.path()
Return type:

str

Note

This function is deprecated.

Use suggestedFileName() , downloadDirectory() , and downloadFileName() instead.

Returns the full target path where data is being downloaded to.

The path includes the file name. The default suggested path is the standard download location and file name is deduced not to overwrite already existing files.

See also

setPath()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.pause()

Pauses the download.

Has no effect if the state is not DownloadInProgress . Does not change the state.

See also

resume() isPaused()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.receivedBytes()
Return type:

int

Returns the amount of data in bytes that has been downloaded so far.

-1 means the size is unknown.

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.resume()

Resumes the current download if it was paused or interrupted.

Has no effect if the state is not DownloadInProgress or DownloadInterrupted . Does not change the state.

See also

pause() isPaused() state()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.savePageFormat()
Return type:

SavePageFormat

Returns the format the web page will be saved in if this is a download request for a web page.

See also

setSavePageFormat() isSavePageDownload()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.setDownloadDirectory(directory)
Parameters:

directory – str

Sets directory as the directory path to download the file to.

The download directory path can only be set in response to the downloadRequested() signal before the download is accepted. Past that point, this function has no effect on the download item’s state.

See also

downloadDirectory()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.setDownloadFileName(fileName)
Parameters:

fileName – str

Sets fileName as the file name to download the file to.

The download file name can only be set in response to the downloadRequested() signal before the download is accepted. Past that point, this function has no effect on the download item’s state.

See also

downloadFileName()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.setPath(path)
Parameters:

path – str

Note

This function is deprecated.

Use setDownloadDirectory() and setDownloadFileName() instead.

Sets the full target path to download the file to.

The path should also include the file name. The download path can only be set in response to the downloadRequested() signal before the download is accepted. Past that point, this function has no effect on the download item’s state.

See also

path()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.setSavePageFormat(format)
Parameters:

format – SavePageFormat

Sets the format the web page will be saved in if this is a download request for a web page.

See also

savePageFormat() isSavePageDownload()

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.state()
Return type:

DownloadState

Returns the download item’s current state.

See also

DownloadState

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.stateChanged(state)
Parameters:

state – DownloadState

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.suggestedFileName()
Return type:

str

Returns the suggested file name.

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.totalBytes()
Return type:

int

Returns the the total amount of data to download in bytes.

-1 means the size is unknown.

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.type()
Return type:

DownloadType

Note

This function is deprecated.

Returns the requested download’s type.

Note

This property works unreliably, except for SavePage downloads. Use isSavePageDownload() instead.

PySide2.QtWebEngineWidgets.QWebEngineDownloadItem.url()
Return type:

PySide2.QtCore.QUrl

Returns the download’s origin URL.