PySide6.QtNetwork.QRestReply¶

class QRestReply¶

QRestReply is a convenience wrapper for QNetworkReply . More…

Added in version 6.7.

Synopsis¶

Methods¶

def __init__()
def error()
def errorString()
def hasError()
def httpStatus()
def isHttpStatusSuccess()
def isSuccess()
def networkReply()
def readBody()
def readJson()
def readText()
def swap()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

QRestReply wraps a QNetworkReply and provides convenience methods for data and status handling. The methods provide convenience for typical RESTful client applications.

QRestReply doesn’t take ownership of the wrapped QNetworkReply , and the lifetime and ownership of the reply is as defined by QNetworkAccessManager documentation.

QRestReply object is not copyable, but is movable.

See also

QRestAccessManager QNetworkReply QNetworkAccessManager setAutoDeleteReplies()

__init__(reply)¶

Parameters:: reply – QNetworkReply

Creates a QRestReply and initializes the wrapped QNetworkReply to reply.

error()¶

Return type:: NetworkError

Returns the last error, if any. The errors include errors such as network and protocol errors, but exclude cases when the server successfully responded with an HTTP status.

See also

httpStatus() isSuccess() hasError() errorString()

errorString()¶

Return type:: str

Returns a human-readable description of the last network error.

See also

httpStatus() isSuccess() hasError() error()

hasError()¶

Return type:: bool

Returns whether an error has occurred. This includes errors such as network and protocol errors, but excludes cases where the server successfully responded with an HTTP error status (for example 500 Internal Server Error). Use httpStatus() or isHttpStatusSuccess() to get the HTTP status information.

See also

httpStatus() isSuccess() error() errorString()

httpStatus()¶

Return type:: int

Returns the HTTP status received in the server response. The value is 0 if not available (the status line has not been received, yet).

Note

The HTTP status is reported as indicated by the received HTTP response. An error() may occur after receiving the status, for instance due to network disconnection while receiving a long response. These potential subsequent errors are not represented by the reported HTTP status.