Skip to content

GH-98906 re module: search() vs. match() section should mention fullmatch() #98916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericvsmith merged 9 commits into from
Nov 30, 2022
+12 −6
Merged

GH-98906 re module: search() vs. match() section should mention fullmatch() #98916

Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7e90e14
for #98906
ramvikrams Oct 31, 2022
9a1bc61
changes
ramvikrams Nov 1, 2022
afab961
update
ramvikrams Nov 1, 2022
f827986
update
ramvikrams Nov 2, 2022
95efa61
Merge branch 'python:main' into t2
ramvikrams Nov 30, 2022
84fc8c8
update the examples
ramvikrams Nov 30, 2022
a650b40
updated the docs
ramvikrams Nov 30, 2022
1ea3105
Update re.rst
ramvikrams Nov 30, 2022
d2a6981
Update re.rst
ramvikrams Nov 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions Doc/library/re.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1565,21 +1565,28 @@ search() vs. match()

.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>

Python offers two different primitive operations based on regular expressions:
:func:`re.match` checks for a match only at the beginning of the string, while
:func:`re.search` checks for a match anywhere in the string (this is what Perl
does by default).
Python offers different primitive operations based on regular expressions:

+ :func:`re.search` checks for a match anywhere in the string,
(this is what Perl does by default)
+ :func:`re.fullmatch` checks for entire string to be a match
+ :func:`re.match` checks for a match only at the beginning of the string
Copy link
Copy Markdown
Member

@ericvsmith ericvsmith Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please leave these in the order of match, then search, then fullmatch. That way the match the examples immediately below.



For example::

>>> re.match("c", "abcdef") # No match
>>> re.search("c", "abcdef") # Match
<re.Match object; span=(2, 3), match='c'>
Comment thread
ericvsmith marked this conversation as resolved.
>>> re.fullmatch("p.*n", "python")
Copy link
Copy Markdown
Member

@ericvsmith ericvsmith Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I missed this: Can you add the "# Match" comment to this line?

<re.Match object; span=(0, 6), match='python'>
Comment thread
ericvsmith marked this conversation as resolved.
>>> re.fullmatch("r.*n", "python") # No match

Regular expressions beginning with ``'^'`` can be used with :func:`search` to
restrict the match at the beginning of the string::

>>> re.match("c", "abcdef") # No match
>>> re.fullmatch("c", "abcdef") # No Match
Copy link
Copy Markdown
Member

@ericvsmith ericvsmith Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not add this. This section is trying to show the differences between search and match. Adding a fullmatch example just confuses things.

Copy link
Copy Markdown
Contributor Author

@ramvikrams ramvikrams Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes sir

Copy link
Copy Markdown
Member

@ericvsmith ericvsmith Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please delete the fullmatch line here.

>>> re.search("^c", "abcdef") # No match
>>> re.search("^a", "abcdef") # Match
<re.Match object; span=(0, 1), match='a'>
Expand All @@ -1588,8 +1595,9 @@ Note however that in :const:`MULTILINE` mode :func:`match` only matches at the
beginning of the string, whereas using :func:`search` with a regular expression
beginning with ``'^'`` will match at the beginning of each line. ::

>>> re.match('X', 'A\nB\nX', re.MULTILINE) # No match
>>> re.search('^X', 'A\nB\nX', re.MULTILINE) # Match
>>> re.match("X", "A\nB\nX", re.MULTILINE) # No match
>>> re.fullmatch("X", "A\nB\nX", re.MULTILINE) # No Match
Copy link
Copy Markdown
Member

@ericvsmith ericvsmith Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And delete thisfullmatch line also. This section doesn't need to mention fullmatch.

>>> re.search("^X", "A\nB\nX", re.MULTILINE) # Match
<re.Match object; span=(4, 5), match='X'>


Expand Down