QByteArray¶

PyQt5.QtCore.QByteArray

Description¶

The QByteArray class provides an array of bytes.

QByteArray can be used to store both raw bytes (including ‘\0’s) and traditional 8-bit ‘\0’-terminated strings. Using QByteArray is much more convenient than using const char \*. Behind the scenes, it always ensures that the data is followed by a ‘\0’ terminator, and uses implicit sharing (copy-on-write) to reduce memory usage and avoid needless copying of data.

In addition to QByteArray, Qt also provides the QString class to store string data. For most purposes, QString is the class you want to use. It stores 16-bit Unicode characters, making it easy to store non-ASCII/non-Latin-1 characters in your application. Furthermore, QString is used throughout in the Qt API. The two main cases where QByteArray is appropriate are when you need to store raw binary data, and when memory conservation is critical (e.g., with Qt for Embedded Linux).

One way to initialize a QByteArray is simply to pass a const char \* to its constructor. For example, the following code creates a byte array of size 5 containing the data “Hello”:

# QByteArray ba("Hello");

Although the size() is 5, the byte array also maintains an extra ‘\0’ character at the end so that if a function is used that asks for a pointer to the underlying data (e.g. a call to data()), the data pointed to is guaranteed to be ‘\0’-terminated.

QByteArray makes a deep copy of the const char \* data, so you can modify it later without experiencing side effects. (If for performance reasons you don’t want to take a deep copy of the character data, use QByteArray::fromRawData() instead.)

Another approach is to set the size of the array using resize() and to initialize the data byte per byte. QByteArray uses 0-based indexes, just like C arrays. To access the byte at a particular index position, you can use operator[](). On non-const byte arrays, operator[]() returns a reference to a byte that can be used on the left side of an assignment. For example:

# QByteArray ba;
# ba.resize(5);
# ba[0] = 0x3c;
# ba[1] = 0xb8;
# ba[2] = 0x64;
# ba[3] = 0x18;
# ba[4] = 0xca;

For read-only access, an alternative syntax is to use at():

# for (int i = 0; i < ba.size();   i) {
#     if (ba.at(i) >= 'a' && ba.at(i) <= 'f')
#         cout << "Found character in range [a-f]" << endl;
# }

at() can be faster than operator[](), because it never causes a deep copy to occur.

To extract many bytes at a time, use left(), right(), or mid().

A QByteArray can embed ‘\0’ bytes. The size() function always returns the size of the whole array, including embedded ‘\0’ bytes, but excluding the terminating ‘\0’ added by QByteArray. For example:

# QByteArray ba1("ca\0r\0t");
# ba1.size();                     // Returns 2.
# ba1.constData();                // Returns "ca" with terminating \0.

# QByteArray ba2("ca\0r\0t", 3);
# ba2.size();                     // Returns 3.
# ba2.constData();                // Returns "ca\0" with terminating \0.

# QByteArray ba3("ca\0r\0t", 4);
# ba3.size();                     // Returns 4.
# ba3.constData();                // Returns "ca\0r" with terminating \0.

# const char cart[] = {'c', 'a', '\0', 'r', '\0', 't'};
# QByteArray ba4(QByteArray::fromRawData(cart, 6));
# ba4.size();                     // Returns 6.
# ba4.constData();                // Returns "ca\0r\0t" without terminating \0.

If you want to obtain the length of the data up to and excluding the first ‘\0’ character, call qstrlen() on the byte array.

After a call to resize(), newly allocated bytes have undefined values. To set all the bytes to a particular value, call fill().

To obtain a pointer to the actual character data, call data() or constData(). These functions return a pointer to the beginning of the data. The pointer is guaranteed to remain valid until a non-const function is called on the QByteArray. It is also guaranteed that the data ends with a ‘\0’ byte unless the QByteArray was created from a fromRawData(). This ‘\0’ byte is automatically provided by QByteArray and is not counted in size().

QByteArray provides the following basic functions for modifying the byte data: append(), prepend(), insert(), replace(), and remove(). For example:

# QByteArray x("and");
# x.prepend("rock ");         // x == "rock and"
# x.append(" roll");          // x == "rock and roll"
# x.replace(5, 3, "&");       // x == "rock & roll"

The replace() and remove() functions’ first two arguments are the position from which to start erasing and the number of bytes that should be erased.

When you append() data to a non-empty array, the array will be reallocated and the new data copied to it. You can avoid this behavior by calling reserve(), which preallocates a certain amount of memory. You can also call capacity() to find out how much memory QByteArray actually allocated. Data appended to an empty array is not copied.

A frequent requirement is to remove whitespace characters from a byte array (’\n’, ‘\t’, ‘ ‘, etc.). If you want to remove whitespace from both ends of a QByteArray, use trimmed(). If you want to remove whitespace from both ends and replace multiple consecutive whitespaces with a single space character within the byte array, use simplified().

If you want to find all occurrences of a particular character or substring in a QByteArray, use indexOf() or lastIndexOf(). The former searches forward starting from a given index position, the latter searches backward. Both return the index position of the character or substring if they find it; otherwise, they return -1. For example, here’s a typical loop that finds all occurrences of a particular substring:

# QByteArray ba("We must be <b>bold</b>, very <b>bold</b>");
# int j = 0;
# while ((j = ba.indexOf("<b>", j)) != -1) {
#     cout << "Found <b> tag at index position " << j << endl;
#       j;
# }

If you simply want to check whether a QByteArray contains a particular character or substring, use contains(). If you want to find out how many times a particular character or substring occurs in the byte array, use count(). If you want to replace all occurrences of a particular value with another, use one of the two-parameter replace() overloads.

QByteArrays can be compared using overloaded operators such as operator<(), operator<=(), operator==(), operator>=(), and so on. The comparison is based exclusively on the numeric values of the characters and is very fast, but is not what a human would expect. QString::localeAwareCompare() is a better choice for sorting user-interface strings.

For historical reasons, QByteArray distinguishes between a null byte array and an empty byte array. A null byte array is a byte array that is initialized using QByteArray’s default constructor or by passing (const char *)0 to the constructor. An empty byte array is any byte array with size 0. A null byte array is always empty, but an empty byte array isn’t necessarily null:

# QByteArray().isNull();          // returns true
# QByteArray().isEmpty();         // returns true

# QByteArray("").isNull();        // returns false
# QByteArray("").isEmpty();       // returns true

# QByteArray("abc").isNull();     // returns false
# QByteArray("abc").isEmpty();    // returns false

All functions except isNull() treat null byte arrays the same as empty byte arrays. For example, data() returns a pointer to a ‘\0’ character for a null byte array (not a null pointer), and QByteArray compares equal to QByteArray(“”). We recommend that you always use isEmpty() and avoid isNull().

Notes on Locale¶

Number-String Conversions¶

Functions that perform conversions between numeric data types and strings are performed in the C locale, irrespective of the user’s locale settings. Use QString to perform locale-aware conversions between numbers and strings.

8-bit Character Comparisons¶

In QByteArray, the notion of uppercase and lowercase and of which character is greater than or less than another character is locale dependent. This affects functions that support a case insensitive option or that compare or lowercase or uppercase their arguments. Case insensitive operations and comparisons will be accurate if both strings contain only ASCII characters. (If $LC_CTYPE is set, most Unix systems do “the right thing”.) Functions that this affects include contains(), indexOf(), lastIndexOf(), operator<(), operator<=(), operator>(), operator>=(), isLower(), isUpper(), toLower() and toUpper().

This issue does not apply to QStrings since they represent characters using Unicode.

Classes¶

Base64Options

FromBase64Result

Enums¶

Base64DecodingStatus

TODO

Member	Value	Description
IllegalCharacter	TODO	TODO
IllegalInputLength	TODO	TODO
IllegalPadding	TODO	TODO
Ok	TODO	TODO

Base64Option

TODO

Member	Value	Description
AbortOnBase64DecodingErrors	TODO	TODO
Base64Encoding	TODO	TODO
Base64UrlEncoding	TODO	TODO
IgnoreBase64DecodingErrors	TODO	TODO
KeepTrailingEquals	TODO	TODO
OmitTrailingEquals	TODO	TODO

Methods¶

__init__(): TODO

__init__(Union[QByteArray, bytes, bytearray]): TODO

__init__(int, str): TODO

__add__(Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

append(Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

append(str) → QByteArray: TODO

append(int, str) → QByteArray: TODO

at(int) → str: TODO

capacity() → int: TODO

chop(int): TODO

chopped(int) → QByteArray: TODO

clear(): TODO

compare(Union[QByteArray, bytes, bytearray], cs: CaseSensitivity = CaseSensitive) → int: TODO

contains(Union[QByteArray, bytes, bytearray]) → bool: TODO

__contains__(Union[QByteArray, bytes, bytearray]) → int: TODO

count() → int: TODO

count(Union[QByteArray, bytes, bytearray]) → int: TODO

data() → bytes: TODO

endsWith(Union[QByteArray, bytes, bytearray]) → bool: TODO

__eq__(str) → bool: TODO

__eq__(Union[QByteArray, bytes, bytearray]) → bool: TODO

fill(str, size: int = -1) → QByteArray: TODO

@staticmethod fromBase64(Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

@staticmethod fromBase64(Union[QByteArray, bytes, bytearray], Union[Base64Options, Base64Option]) → QByteArray: TODO

@staticmethod fromBase64Encoding(Union[QByteArray, bytes, bytearray], options: Union[Base64Options, Base64Option] = Base64Encoding) → FromBase64Result: TODO

@staticmethod fromHex(Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

@staticmethod fromPercentEncoding(Union[QByteArray, bytes, bytearray], percent: str = '%') → QByteArray: TODO

@staticmethod fromRawData(bytes) → QByteArray: TODO

__ge__(str) → bool: TODO

__ge__(Union[QByteArray, bytes, bytearray]) → bool: TODO

__getitem__(int) → str: TODO

__getitem__(slice) → QByteArray: TODO

__gt__(str) → bool: TODO

__gt__(Union[QByteArray, bytes, bytearray]) → bool: TODO

__hash__() → int: TODO

__iadd__(Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

__iadd__(str) → QByteArray: TODO

__imul__(int) → QByteArray: TODO

indexOf(Union[QByteArray, bytes, bytearray], from: int = 0) → int: TODO

indexOf(str, from: int = 0) → int: TODO

insert(int, Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

insert(int, str) → QByteArray: TODO

insert(int, int, str) → QByteArray: TODO

isEmpty() → bool: TODO

isLower() → bool: TODO

isNull() → bool: TODO

isUpper() → bool: TODO

lastIndexOf(Union[QByteArray, bytes, bytearray], from: int = -1) → int: TODO

lastIndexOf(str, from: int = -1) → int: TODO

__le__(str) → bool: TODO

__le__(Union[QByteArray, bytes, bytearray]) → bool: TODO

left(int) → QByteArray: TODO

leftJustified(int, fill: str = ' ', truncate: bool = False) → QByteArray: TODO

__len__() → int: TODO

length() → int: TODO

__lt__(str) → bool: TODO

__lt__(Union[QByteArray, bytes, bytearray]) → bool: TODO

mid(int, length: int = -1) → QByteArray: TODO

__mul__(int) → QByteArray: TODO

__ne__(str) → bool: TODO

__ne__(Union[QByteArray, bytes, bytearray]) → bool: TODO

@staticmethod number(int, base: int = 10) → QByteArray: TODO

@staticmethod number(float, format: str = 'g', precision: int = 6) → QByteArray: TODO

prepend(Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

prepend(int, str) → QByteArray: TODO

push_back(Union[QByteArray, bytes, bytearray]): TODO

push_front(Union[QByteArray, bytes, bytearray]): TODO

remove(int, int) → QByteArray: TODO

repeated(int) → QByteArray: TODO

replace(Union[QByteArray, bytes, bytearray], Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

replace(str, Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

replace(int, int, Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

__repr__() → str: TODO

reserve(int): TODO

resize(int): TODO

right(int) → QByteArray: TODO

rightJustified(int, fill: str = ' ', truncate: bool = False) → QByteArray: TODO

setNum(int, base: int = 10) → QByteArray: TODO

setNum(float, format: str = 'g', precision: int = 6) → QByteArray: TODO

simplified() → QByteArray: TODO

size() → int: TODO

split(str) → List[QByteArray]: TODO

squeeze(): TODO

startsWith(Union[QByteArray, bytes, bytearray]) → bool: TODO

__str__() → str: TODO

swap(QByteArray): TODO

toBase64() → QByteArray: TODO

toBase64(Union[Base64Options, Base64Option]) → QByteArray: TODO

toDouble() → (float, bool): TODO

toFloat() → (float, bool): TODO

toHex() → QByteArray: TODO

toHex(str) → QByteArray: TODO

toInt(base: int = 10) → (int, bool): TODO

toLong(base: int = 10) → (int, bool): TODO

toLongLong(base: int = 10) → (int, bool): TODO

toLower() → QByteArray: TODO

toPercentEncoding(exclude: Union[QByteArray, bytes, bytearray] = QByteArray(), include: Union[QByteArray, bytes, bytearray] = QByteArray(), percent: str = '%') → QByteArray: TODO

toShort(base: int = 10) → (int, bool): TODO

toUInt(base: int = 10) → (int, bool): TODO

toULong(base: int = 10) → (int, bool): TODO

toULongLong(base: int = 10) → (int, bool): TODO

toUpper() → QByteArray: TODO

toUShort(base: int = 10) → (int, bool): TODO

trimmed() → QByteArray: TODO

truncate(int): TODO