class QRegularExpressionMatch#

The QRegularExpressionMatch class provides the results of a matching a QRegularExpression against a string. More…

Synopsis#

Methods#

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#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

A QRegularExpressionMatch object can be obtained by calling the match() function, or as a single result of a global match from a QRegularExpressionMatchIterator .

The success or the failure of a match attempt can be inspected by calling the hasMatch() function. QRegularExpressionMatch also reports a successful partial match through the hasPartialMatch() function.

In addition, QRegularExpressionMatch returns the substrings captured by the capturing groups in the pattern string. The implicit capturing group with index 0 captures the result of the whole match. The captured() function returns each substring captured, either by the capturing group’s index or by its name:

re = QRegularExpression("(\\d\\d) (?\\w+)")
match = re.match("23 Jordan")
if match.hasMatch():
    number = match.captured(1) # first == "23"
    name = match.captured("name") # name == "Jordan"

For each captured substring it is possible to query its starting and ending offsets in the subject string by calling the capturedStart() and the capturedEnd() function, respectively. The length of each captured substring is available using the capturedLength() function.

The convenience function capturedTexts() will return all the captured substrings at once (including the substring matched by the entire pattern) in the order they have been captured by capturing groups; that is, captured(i) == capturedTexts().at(i).

You can retrieve the QRegularExpression object the subject string was matched against by calling the regularExpression() function; the match type and the match options are available as well by calling the matchType() and the matchOptions() respectively.

Please refer to the QRegularExpression documentation for more information about the Qt regular expression classes.

__init__(match)#
Parameters:

match – QRegularExpressionMatch

Constructs a match result by copying the result of the given match.

See also

operator=()

__init__()

Constructs a valid, empty QRegularExpressionMatch object. The regular expression is set to a default-constructed one; the match type to NoMatch and the match options to NoMatchOption .

The object will report no match through the hasMatch() and the hasPartialMatch() member functions.

captured(name)#
Parameters:

name – str

Return type:

str

Returns the substring captured by the capturing group named name.

If the named capturing group name did not capture a string, or if there is no capturing group named name, returns a null QString .

captured(name)
Parameters:

name – str

Return type:

str

Returns the substring captured by the capturing group named name.

If the named capturing group name did not capture a string, or if there is no capturing group named name, returns a null QString .

captured([nth=0])
Parameters:

nth – int

Return type:

str

Returns the substring captured by the nth capturing group.

If the nth capturing group did not capture a string, or if there is no such capturing group, returns a null QString .

Note

The implicit capturing group number 0 captures the substring matched by the entire pattern.

See also

capturedView() lastCapturedIndex() capturedStart() capturedEnd() capturedLength() isNull()

capturedEnd(name)#
Parameters:

name – str

Return type:

int

Returns the offset inside the subject string immediately after the ending position of the substring captured by the capturing group named name. If the capturing group named name did not capture a string or doesn’t exist, returns -1.

capturedEnd(name)
Parameters:

name – str

Return type:

int

Returns the offset inside the subject string immediately after the ending position of the substring captured by the capturing group named name. If the capturing group named name did not capture a string or doesn’t exist, returns -1.

capturedEnd([nth=0])
Parameters:

nth – int

Return type:

int

Returns the offset inside the subject string immediately after the ending position of the substring captured by the nth capturing group. If the nth capturing group did not capture a string or doesn’t exist, returns -1.

capturedLength(name)#
Parameters:

name – str

Return type:

int

Returns the length of the substring captured by the capturing group named name.

Note

This function returns 0 if the capturing group named name did not capture a string or doesn’t exist.

See also

capturedStart() capturedEnd() captured()

capturedLength(name)
Parameters:

name – str

Return type:

int

Returns the length of the substring captured by the capturing group named name.

Note

This function returns 0 if the capturing group named name did not capture a string or doesn’t exist.

See also

capturedStart() capturedEnd() captured()

capturedLength([nth=0])
Parameters:

nth – int

Return type:

int

Returns the length of the substring captured by the nth capturing group.

Note

This function returns 0 if the nth capturing group did not capture a string or doesn’t exist.

See also

capturedStart() capturedEnd() captured()

capturedStart(name)#
Parameters:

name – str

Return type:

int

Returns the offset inside the subject string corresponding to the starting position of the substring captured by the capturing group named name. If the capturing group named name did not capture a string or doesn’t exist, returns -1.

capturedStart(name)
Parameters:

name – str

Return type:

int

Returns the offset inside the subject string corresponding to the starting position of the substring captured by the capturing group named name. If the capturing group named name did not capture a string or doesn’t exist, returns -1.

capturedStart([nth=0])
Parameters:

nth – int

Return type:

int

Returns the offset inside the subject string corresponding to the starting position of the substring captured by the nth capturing group. If the nth capturing group did not capture a string or doesn’t exist, returns -1.

capturedTexts()#
Return type:

list of strings

Returns a list of all strings captured by capturing groups, in the order the groups themselves appear in the pattern string. The list includes the implicit capturing group number 0, capturing the substring matched by the entire pattern.

capturedView(name)#
Parameters:

name – str

Return type:

str

Returns a view of the string captured by the capturing group named name.

If the named capturing group name did not capture a string, or if there is no capturing group named name, returns a null QStringView .

capturedView([nth=0])
Parameters:

nth – int

Return type:

str

Returns a view of the substring captured by the nth capturing group.

If the nth capturing group did not capture a string, or if there is no such capturing group, returns a null QStringView .

Note

The implicit capturing group number 0 captures the substring matched by the entire pattern.

See also

captured() lastCapturedIndex() capturedStart() capturedEnd() capturedLength() isNull()

hasCaptured(name)#
Parameters:

name – str

Return type:

bool

hasCaptured(name)
Parameters:

name – str

Return type:

bool

hasCaptured(nth)
Parameters:

nth – int

Return type:

bool

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns true if the nth capturing group captured something in the subject string, and false otherwise (or if there is no such capturing group).

Note

The implicit capturing group number 0 captures the substring matched by the entire pattern.

Note

Some capturing groups in a regular expression may not have captured anything even if the regular expression matched. This may happen, for instance, if a conditional operator is used in the pattern:

re = QRegularExpression("([a-z]+)|([A-Z]+)")
m = re.match("UPPERCASE")
if m.hasMatch():
    print(m.hasCaptured(0)) # true
    print(m.hasCaptured(1)) # false
    print(m.hasCaptured(2)) # true

Similarly, a capturing group may capture a substring of length 0; this function will return true for such a capturing group.

hasMatch()#
Return type:

bool

Returns true if the regular expression matched against the subject string, or false otherwise.

hasPartialMatch()#
Return type:

bool

Returns true if the regular expression partially matched against the subject string, or false otherwise.

Note

Only a match that explicitly used the one of the partial match types can yield a partial match. Still, if such a match succeeds totally, this function will return false, while hasMatch() will return true.

See also

match() MatchType hasMatch()

isValid()#
Return type:

bool

Returns true if the match object was obtained as a result from the match() function invoked on a valid QRegularExpression object; returns false if the QRegularExpression was invalid.

See also

match() isValid()

lastCapturedIndex()#
Return type:

int

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the index of the last capturing group that captured something, including the implicit capturing group 0. This can be used to extract all the substrings that were captured:

match = re.match(string)
for i in range(0, match.lastCapturedIndex() + 1):
    captured = match.captured(i)
    # ...

Note that some of the capturing groups with an index less than lastCapturedIndex() could have not matched, and therefore captured nothing.

If the regular expression did not match, this function returns -1.

matchOptions()#
Return type:

Combination of MatchOption

Returns the match options that were used to get this QRegularExpressionMatch object, that is, the match options that were passed to match() or globalMatch() .

matchType()#
Return type:

MatchType

Returns the match type that was used to get this QRegularExpressionMatch object, that is, the match type that was passed to match() or globalMatch() .

regularExpression()#
Return type:

QRegularExpression

Returns the QRegularExpression object whose match() function returned this object.

swap(other)#
Parameters:

other – QRegularExpressionMatch

Swaps the match result other with this match result. This operation is very fast and never fails.