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

ramvikrams · 2022-10-31T17:59:30Z

Added the re.fullmatch() with it's examples

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

adding re.fullmatch with it's examples

slateny · 2022-11-01T02:12:25Z

Doc/library/re.rst

@@ -1565,18 +1565,22 @@ search() vs. match()
 Python offers two different primitive operations based on regular expressions:


Maybe continue the style of this paragraph, so instead something like 'Python offers a few primitive ...' then '... re.fullmatch checks that the whole string is a match ...' (can change this wording up a bit too). I also think the None case can omitted since it wasn't mentioned in the previous two cases either.

slateny · 2022-11-01T02:12:25Z

Doc/library/re.rst

@@ -1586,6 +1590,7 @@ 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


For consistency, other examples seem to use double quotes so this and re.search can be swapped over, or re.fullmatch can be changed to single quote (but optional).

Done the changes

slateny · 2022-11-01T06:23:20Z

Doc/library/re.rst

+:func:`re.fullmatch` checks for entire string to be a match. :func:`re.search`
+checks for a match anywhere in the string (this is what Perl does by default).


For better flow

Suggested change

:func:`re.fullmatch` checks for entire string to be a match. :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, and

:func:`re.search` checks for a match anywhere in the string

(this is what Perl does by default).

or perhaps even

Suggested change

:func:`re.fullmatch` checks for entire string to be a match. :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, and

:func:`re.search` checks for a match anywhere in the string.

but I'll let Eric decide whether the Perl mention is necessary.

My recommendation would be to use bullet points (and to reorder so that plain re.match is last, honestly it's a little bit of a footgun)

* :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

hauntsaninja · 2022-11-01T23:42:10Z

Doc/library/re.rst

+:func:`re.fullmatch` checks for entire string to be a match. :func:`re.search`
+checks for a match anywhere in the string (this is what Perl does by default).


My recommendation would be to use bullet points (and to reorder so that plain re.match is last, honestly it's a little bit of a footgun)

* :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

Doc/library/re.rst

update the examples where `re.match` and `re.search` shows a match but not `re.fullmatch`

Doc/library/re.rst

ericvsmith · 2022-11-30T21:40:42Z

Doc/library/re.rst

+   <re.Match object; span=(0, 1), match='c'>
+   >>> re.search("c", "cdef")   # Match
+   <re.Match object; span=(0, 1), match='c'>
+   >>> re.fullmatch("c", "cdef")  # No Match


Sorry I wasn't clear. I think you need two examples for fullmatch:

re.fullmatch("p.*n", "python") # Match re.fullmatch("r.*n", "python") # No match

ericvsmith · 2022-11-30T21:40:42Z

Doc/library/re.rst

+   >>> re.match("c", "cdef")    # match
+   <re.Match object; span=(0, 1), match='c'>
+   >>> re.search("c", "cdef")   # Match
+   <re.Match object; span=(0, 1), match='c'>


And I would not add these 2 examples. The existing examples are fine. The goal is to show that search() can match something that match() does not, with the same parameters to both.

ericvsmith · 2022-11-30T21:40:42Z

Doc/library/re.rst


 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


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

Please delete the fullmatch line here.

bedevere-bot · 2022-11-30T21:40:46Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

ramvikrams · 2022-11-30T21:57:06Z

I have made the requested changes; please review again

bedevere-bot · 2022-11-30T21:57:10Z

Thanks for making the requested changes!

@ericvsmith: please review the changes made to this pull request.

ericvsmith · 2022-11-30T22:14:21Z

Doc/library/re.rst


 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


Please delete the fullmatch line here.

ericvsmith · 2022-11-30T22:14:21Z

Doc/library/re.rst

-   >>> 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


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

ericvsmith · 2022-11-30T22:14:21Z

Doc/library/re.rst

+ :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


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

bedevere-bot · 2022-11-30T22:30:34Z

Thanks for making the requested changes!

@ericvsmith: please review the changes made to this pull request.

ericvsmith

Sorry for one additional small change. I'll commit it after this change.

ericvsmith · 2022-11-30T22:43:46Z

Doc/library/re.rst


 For example::

   >>> re.match("c", "abcdef")    # No match
   >>> re.search("c", "abcdef")   # Match
   <re.Match object; span=(2, 3), match='c'>
+   >>> re.fullmatch("p.*n", "python")


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

bedevere-bot · 2022-11-30T22:43:50Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

ramvikrams · 2022-11-30T22:47:06Z

I have made the requested changes; please review again

bedevere-bot · 2022-11-30T22:47:10Z

Thanks for making the requested changes!

@ericvsmith: please review the changes made to this pull request.

miss-islington · 2022-11-30T22:52:24Z

Thanks @ramvikrams for the PR, and @ericvsmith for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

bedevere-bot · 2022-11-30T22:52:33Z

GH-99912 is a backport of this pull request to the 3.11 branch.

…ould mention ```fullmatch()``` (pythonGH-98916) Mention fullmatch along with search and match. (cherry picked from commit e0f91de) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>

bedevere-bot · 2022-11-30T22:52:39Z

GH-99913 is a backport of this pull request to the 3.10 branch.

ramvikrams · 2022-11-30T22:53:35Z

thanks sir for your help

…hould mention ```fullmatch()``` (GH-98916) (GH-99912) GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916) Mention fullmatch along with search and match. (cherry picked from commit e0f91de) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>

…hould mention ```fullmatch()``` (GH-98916) (GH-99913) GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916) Mention fullmatch along with search and match. (cherry picked from commit e0f91de) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>

for python#98906

7e90e14

adding re.fullmatch with it's examples

bedevere-bot mentioned this pull request Oct 31, 2022

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

Closed

bedevere-bot added docs Documentation in the Doc dir skip news awaiting review labels Oct 31, 2022

slateny reviewed Nov 1, 2022

View changes

ramvikrams added 2 commits Nov 1, 2022

changes

9a1bc61

update

afab961

slateny reviewed Nov 1, 2022

View changes

slateny requested a review from ericvsmith Nov 1, 2022

hauntsaninja reviewed Nov 1, 2022

View changes

update

f827986

ramvikrams closed this Nov 30, 2022

ramvikrams deleted the t2 branch Nov 30, 2022

ramvikrams restored the t2 branch Nov 30, 2022

Merge branch 'python:main' into t2

95efa61

ramvikrams reopened this Nov 30, 2022

update the examples

84fc8c8

update the examples where `re.match` and `re.search` shows a match but not `re.fullmatch`

ericvsmith requested changes Nov 30, 2022

View changes

bedevere-bot added awaiting changes and removed awaiting review labels Nov 30, 2022

updated the docs

a650b40

bedevere-bot added awaiting change review and removed awaiting changes labels Nov 30, 2022

bedevere-bot requested a review from ericvsmith Nov 30, 2022

ericvsmith requested changes Nov 30, 2022

View changes

bedevere-bot removed the awaiting change review label Nov 30, 2022

bedevere-bot added the awaiting change review label Nov 30, 2022

bedevere-bot requested a review from ericvsmith Nov 30, 2022

ericvsmith requested changes Nov 30, 2022

View changes

bedevere-bot added awaiting changes and removed awaiting change review labels Nov 30, 2022

Update re.rst

d2a6981

ericvsmith self-assigned this Nov 30, 2022

bedevere-bot added awaiting change review and removed awaiting changes labels Nov 30, 2022

ericvsmith added awaiting changes needs backport to 3.10 needs backport to 3.11 and removed awaiting change review labels Nov 30, 2022

bedevere-bot requested a review from ericvsmith Nov 30, 2022

ericvsmith merged commit e0f91de into python:main Nov 30, 2022
14 checks passed

bedevere-bot removed the awaiting changes label Nov 30, 2022

bedevere-bot removed the needs backport to 3.11 label Nov 30, 2022

bedevere-bot removed the needs backport to 3.10 label Nov 30, 2022

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

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

ramvikrams commented Oct 31, 2022

slateny Nov 1, 2022

ramvikrams Nov 1, 2022

slateny Nov 1, 2022

ramvikrams Nov 1, 2022

slateny Nov 1, 2022 •

edited

ramvikrams Nov 1, 2022

hauntsaninja Nov 1, 2022

hauntsaninja Nov 1, 2022

ericvsmith Nov 30, 2022

ramvikrams Nov 30, 2022

ramvikrams Nov 30, 2022

ericvsmith Nov 30, 2022

ramvikrams Nov 30, 2022

ericvsmith Nov 30, 2022

ramvikrams Nov 30, 2022

ericvsmith Nov 30, 2022

bedevere-bot commented Nov 30, 2022

ramvikrams commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

ericvsmith Nov 30, 2022

ericvsmith Nov 30, 2022

ericvsmith Nov 30, 2022

bedevere-bot commented Nov 30, 2022

ericvsmith left a comment

ericvsmith Nov 30, 2022

bedevere-bot commented Nov 30, 2022

ramvikrams commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

miss-islington commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

ramvikrams commented Nov 30, 2022

		@@ -1565,18 +1565,22 @@ search() vs. match()
		Python offers two different primitive operations based on regular expressions:

		@@ -1586,6 +1590,7 @@ 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

		:func:`re.fullmatch` checks for entire string to be a match. :func:`re.search`
		checks for a match anywhere in the string (this is what Perl does by default).

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

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

Conversation

ramvikrams commented Oct 31, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

slateny Nov 1, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bedevere-bot commented Nov 30, 2022

ramvikrams commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bedevere-bot commented Nov 30, 2022

ericvsmith left a comment

Choose a reason for hiding this comment

bedevere-bot commented Nov 30, 2022

ramvikrams commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

miss-islington commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

bedevere-bot commented Nov 30, 2022

ramvikrams commented Nov 30, 2022

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

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

slateny Nov 1, 2022 •

edited