diff options
author | Stanley <46876382+slateny@users.noreply.github.com> | 2022-05-23 01:52:17 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-23 01:52:17 (GMT) |
commit | b7a6610bc88dfecdd943e8d2817f7cd6b85fb740 (patch) | |
tree | 4ed84d7b9d07d252c93d744ddb411d6e53ffe5da /Doc/library | |
parent | ac718d357af6aa42240e88add3ac348e1aebcfc2 (diff) | |
download | cpython-b7a6610bc88dfecdd943e8d2817f7cd6b85fb740.zip cpython-b7a6610bc88dfecdd943e8d2817f7cd6b85fb740.tar.gz cpython-b7a6610bc88dfecdd943e8d2817f7cd6b85fb740.tar.bz2 |
gh-73137: Added sub-subsection headers for flags in re (#93000)
Fixes #73137
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/re.rst | 72 |
1 files changed, 42 insertions, 30 deletions
diff --git a/Doc/library/re.rst b/Doc/library/re.rst index 19b18b9..d099f38 100644 --- a/Doc/library/re.rst +++ b/Doc/library/re.rst @@ -667,40 +667,14 @@ functions are simplified versions of the full featured methods for compiled regular expressions. Most non-trivial applications always use the compiled form. + +Flags +^^^^^ + .. versionchanged:: 3.6 Flag constants are now instances of :class:`RegexFlag`, which is a subclass of :class:`enum.IntFlag`. -.. function:: compile(pattern, flags=0) - - Compile a regular expression pattern into a :ref:`regular expression object - <re-objects>`, which can be used for matching using its - :func:`~Pattern.match`, :func:`~Pattern.search` and other methods, described - below. - - The expression's behaviour can be modified by specifying a *flags* value. - Values can be any of the following variables, combined using bitwise OR (the - ``|`` operator). - - The sequence :: - - prog = re.compile(pattern) - result = prog.match(string) - - is equivalent to :: - - result = re.match(pattern, string) - - but using :func:`re.compile` and saving the resulting regular expression - object for reuse is more efficient when the expression will be used several - times in a single program. - - .. note:: - - The compiled versions of the most recent patterns passed to - :func:`re.compile` and the module-level matching functions are cached, so - programs that use only a few regular expressions at a time needn't worry - about compiling regular expressions. .. class:: RegexFlag @@ -825,6 +799,41 @@ form. Corresponds to the inline flag ``(?x)``. +Functions +^^^^^^^^^ + +.. function:: compile(pattern, flags=0) + + Compile a regular expression pattern into a :ref:`regular expression object + <re-objects>`, which can be used for matching using its + :func:`~Pattern.match`, :func:`~Pattern.search` and other methods, described + below. + + The expression's behaviour can be modified by specifying a *flags* value. + Values can be any of the following variables, combined using bitwise OR (the + ``|`` operator). + + The sequence :: + + prog = re.compile(pattern) + result = prog.match(string) + + is equivalent to :: + + result = re.match(pattern, string) + + but using :func:`re.compile` and saving the resulting regular expression + object for reuse is more efficient when the expression will be used several + times in a single program. + + .. note:: + + The compiled versions of the most recent patterns passed to + :func:`re.compile` and the module-level matching functions are cached, so + programs that use only a few regular expressions at a time needn't worry + about compiling regular expressions. + + .. function:: search(pattern, string, flags=0) Scan through *string* looking for the first location where the regular expression @@ -1061,6 +1070,9 @@ form. Clear the regular expression cache. +Exceptions +^^^^^^^^^^ + .. exception:: error(msg, pattern=None, pos=None) Exception raised when a string passed to one of the functions here is not a |