RegexMatch

relationalai.semantics.std.re

RegexMatch(
    regex: StringValue,
    value: StringValue,
    pos: IntegerValue = 0,
    type=RegexMatchType.MATCH,
)

Represents a regex match result with position and grouping support.

Attributes

.regex

RegexMatch.regex: StringValue

The regex pattern used for matching.

.value

RegexMatch.value: StringValue

The string value being matched.

.pos

RegexMatch.pos: IntegerValue

The starting position of the match (0-based).

.match

RegexMatch.match: Variable

A Variable representing the matched string.

Methods

.start()

RegexMatch.start() -> IntegerValue

Get the starting position of the match.

Returns:

• IntegerValue - The 0-based starting position of the match.

.end()

RegexMatch.end() -> IntegerValue

Get the ending position of the match.

Returns:

• IntegerValue - The 0-based ending position of the match.

.span()

RegexMatch.span() -> tuple[IntegerValue, IntegerValue]

Get the start and end positions of the match.

Returns:

• tuple[IntegerValue, IntegerValue] - A tuple of (start, end) positions.

.group()

RegexMatch.group(index: IntegerValue = 0) -> Variable

Get a capture group by index.

.. note:: This method is not yet implemented.

Parameters:

• index

  (IntegerValue, default: 0) - The index of the capture group (0 for the entire match). Default: 0.

Returns:

• Variable - A Variable representing the capture group content.

.group_by_name()

RegexMatch.group_by_name(name: StringValue) -> Variable

Get a named capture group.

.. note:: This method is not yet implemented.

Parameters:

• name

  (StringValue) - The name of the capture group.

Returns:

• Variable - A Variable representing the named capture group content.

Inheritance Hierarchy

Returned By

 semantics > std > re
├──  fullmatch
├──  match
└──  search

Referenced By

RelationalAI Documentation
└──  Build With RelationalAI
    └──  Understand how PyRel works > Use advanced reasoning > Rules-based reasoning
        └──  Match text with patterns
            └──  Understand how std.re matches work