https://github.com/python/cpython/commit/a86e6255c371e14cab8680dee979a7393b339ce5
commit: a86e6255c371e14cab8680dee979a7393b339ce5
branch: main
author: Awbert <[email protected]>
committer: kumaraditya303 <[email protected]>
date: 2024-06-19T09:42:01Z
summary:
gh-119960: Add information about regex flags in re module functions (#119978)
files:
M Doc/library/re.rst
diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index 39788de76b558b..bce36660afcada 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -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)
@@ -925,6 +929,10 @@ 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)
@@ -932,6 +940,10 @@ Functions
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
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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)
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
