QJsonValue露

PyQt5.QtCore.QJsonValue

Description露

The QJsonValue class encapsulates a value in JSON.

A value in JSON can be one of 6 basic types:

JSON is a format to store structured data. It has 6 basic data types:

bool Bool
double Double
string String
array Array
object Object
null Null

A value can represent any of the above data types. In addition, QJsonValue has one special flag to represent undefined values. This can be queried with isUndefined().

The type of the value can be queried with type() or accessors like isBool(), isString(), and so on. Likewise, the value can be converted to the type stored in it using the toBool(), toString() and so on.

Values are strictly typed internally and contrary to QVariant will not attempt to do any implicit type conversions. This implies that converting to a type that is not stored in the value will return a default constructed return value.

QJsonValueRef露

QJsonValueRef is a helper class for QJsonArray and QJsonObject. When you get an object of type QJsonValueRef, you can use it as if it were a reference to a QJsonValue. If you assign to it, the assignment will apply to the element in the QJsonArray or QJsonObject from which you got the reference.

The following methods return QJsonValueRef:

QJsonArray::operator[](int i)
QJsonObject::operator[](const QString & key) const

Enums露

Type

This enum describes the type of the JSON value.

Member	Value	Description
Array	0x4	An array. Use toArray() to convert to a QJsonArray.
Bool	0x1	A boolean value. Use toBool() to convert to a bool.
Double	0x2	A double. Use toDouble() to convert to a double.
Null	0x0	A Null value
Object	0x5	An object. Use toObject() to convert to a QJsonObject.
String	0x3	A string. Use toString() to convert to a QString.
Undefined	0x80	The value is undefined. This is usually returned as an error condition, when trying to read an out of bounds value in an array or a non existent key in an object.

Methods露

__init__(type: Type = Null)

Creates a QJsonValue of type type.

The default is to create a Null value.

__init__(Union[QJsonValue, Type, Iterable[QJsonValue], bool, int, float, str]): Creates a copy of other.

__eq__(Union[QJsonValue, Type, Iterable[QJsonValue], bool, int, float, str]) → bool: TODO

@staticmethod fromVariant(Any) → QJsonValue: TODO

__getitem__(str) → QJsonValue: TODO

__getitem__(int) → QJsonValue: TODO

__hash__() → int: TODO

isArray() → bool: TODO

isBool() → bool: TODO

isDouble() → bool: TODO

isNull() → bool: TODO

isObject() → bool: TODO

isString() → bool: TODO

isUndefined() → bool: TODO

__ne__(Union[QJsonValue, Type, Iterable[QJsonValue], bool, int, float, str]) → bool: TODO

swap(QJsonValue): TODO

toArray() → List[QJsonValue]

This is an overloaded function.

Converts the value to an array and returns it.

If type() is not Array, a QJsonArray() will be returned.

toArray(Iterable[QJsonValue]) → List[QJsonValue]

Converts the value to an array and returns it.

If type() is not Array, the defaultValue will be returned.

toBool(defaultValue: bool = False) → bool

Converts the value to a bool and returns it.

If type() is not bool, the defaultValue will be returned.

toDouble(defaultValue: float = 0) → float

Converts the value to a double and returns it.

If type() is not Double, the defaultValue will be returned.

toInt(defaultValue: int = 0) → int

Converts the value to an int and returns it.

If type() is not Double or the value is not a whole number, the defaultValue will be returned.

toObject() → Dict[str, Union[QJsonValue, Type, Iterable[QJsonValue], bool, int, float, str]]

This is an overloaded function.

Converts the value to an object and returns it.

If type() is not Object, the QJsonObject() will be returned.

toObject(Dict[str, Union[QJsonValue, Type, Iterable[QJsonValue], bool, int, float, str]]) → Dict[str, Union[QJsonValue, Type, Iterable[QJsonValue], bool, int, float, str]]: TODO

toString() → str

Converts the value to a QString and returns it.

If type() is not String, a null QString will be returned.

Constant	Description
Null	QMetaType::Nullptr
Bool	Bool
Double	Double
String	QString
Array	QVariantList
Object	QVariantMap
Undefined	__init__()