Skip to content

Commit

Permalink
pythongh-119960: Add information about regex flags in re module funct…
Browse files Browse the repository at this point in the history
…ions (python#119978)
  • Loading branch information
SweetyAngel authored Jun 19, 2024
1 parent b8fb369 commit a86e625
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions Doc/library/re.rst
Original file line number Diff line number Diff line change
Expand Up @@ -911,6 +911,10 @@ Functions
``None`` if no position in the string matches the pattern; note that this is
different from finding a zero-length match at some point in the string.

The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).


.. function:: match(pattern, string, flags=0)

Expand All @@ -925,13 +929,21 @@ Functions
If you want to locate a match anywhere in *string*, use :func:`search`
instead (see also :ref:`search-vs-match`).

The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).


.. function:: fullmatch(pattern, string, flags=0)

If the whole *string* matches the regular expression *pattern*, return a
corresponding :class:`~re.Match`. Return ``None`` if the string does not match
the pattern; note that this is different from a zero-length match.

The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).

.. versionadded:: 3.4


Expand Down Expand Up @@ -974,6 +986,10 @@ Functions
>>> re.split(r'(\W*)', '...words...')
['', '...', '', '', 'w', '', 'o', '', 'r', '', 'd', '', 's', '...', '', '', '']
The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).

.. versionchanged:: 3.1
Added the optional flags argument.

Expand Down Expand Up @@ -1004,6 +1020,10 @@ Functions
>>> re.findall(r'(\w+)=(\d+)', 'set width=20 and height=10')
[('width', '20'), ('height', '10')]

The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).

.. versionchanged:: 3.7
Non-empty matches can now start just after a previous empty match.

Expand All @@ -1015,6 +1035,10 @@ Functions
is scanned left-to-right, and matches are returned in the order found. Empty
matches are included in the result.

The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).

.. versionchanged:: 3.7
Non-empty matches can now start just after a previous empty match.

Expand Down Expand Up @@ -1070,6 +1094,10 @@ Functions
character ``'0'``. The backreference ``\g<0>`` substitutes in the entire
substring matched by the RE.

The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).

.. versionchanged:: 3.1
Added the optional flags argument.

Expand Down Expand Up @@ -1102,6 +1130,10 @@ Functions
Perform the same operation as :func:`sub`, but return a tuple ``(new_string,
number_of_subs_made)``.

The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the `flags`_ variables, combined using bitwise OR
(the ``|`` operator).


.. function:: escape(pattern)

Expand Down

0 comments on commit a86e625

Please sign in to comment.