bpo-31369: include RegexFlag in re.all #30279

akulakov · 2021-12-27T23:34:22Z

https://bugs.python.org/issue31369

Misc/NEWS.d/next/Library/2021-12-27-18-28-44.bpo-31369.b9yM94.rst

Doc/library/re.rst

JelleZijlstra · 2022-01-19T03:39:58Z

Doc/library/re.rst

@@ -710,6 +713,9 @@ form.
   string and immediately before the newline (if any) at the end of the string.
   Corresponds to the inline flag ``(?m)``.

+.. data:: NOFLAG
+
+   Indicates no flag being applied, the value is ``0``.


Similarly, explain when this is useful and add versionadded.

It can be used for example as a default value for a function parameter, and also as a base value that will later conditionally be ORed with other flags. But this explanation would be confusing to many readers without code examples.

An example as follows may be enough:

def myfunc(text, flag=re.NOFLAG): return re.match(text, flag)

What do you think?

Thanks! I think that's a useful example.

When was it added? ~~Edit: found #72269~~ this added the enum, this PR here actually added NOFLAG despite its title

It seems that the discussion in #57594 was ignored, plus the naming is slightly stange (no flags reads better than no flag)

Not ignored, missed. It took place 11 years prior. We can certainly add a NOFLAGS name now, and make NOFLAG be an alias.

JelleZijlstra · 2022-01-19T03:40:32Z

Lib/re.py

@@ -137,14 +137,15 @@
    "findall", "finditer", "compile", "purge", "template", "escape",
    "error", "Pattern", "Match", "A", "I", "L", "M", "S", "X", "U",
    "ASCII", "IGNORECASE", "LOCALE", "MULTILINE", "DOTALL", "VERBOSE",
-    "UNICODE",
+    "UNICODE", "RegexFlag",


Should also add NOFLAG.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

JelleZijlstra · 2022-01-22T16:14:02Z

@ethanfurman would you like to look at this as it's enum-related?

bdice · 2022-02-04T17:47:28Z

Thanks! I was just looking into this and was puzzled why a NOFLAG (or similar) object didn't exist. Happy to see this PR. 😄

On a related note, I noticed that the type of re.compile("").flags is int and not re.RegexFlag as I expected. I might file an issue for this.

ethanfurman · 2022-02-04T18:03:27Z

Doc/library/re.rst

@@ -637,6 +637,11 @@ form.
      programs that use only a few regular expressions at a time needn't worry
      about compiling regular expressions.

+.. class:: RegexFlag
+
+   An :class:`~enum.Enum` class containing the regex options listed below.


What does the tilde in ~enum.Enum mean?

Also, it should be enum.IntFlag.

The tilde creates a link with only the last element visible, i.e. Enum here, but since it should be IntFlag, I also removed the tilde as IntFlag is less known (though reader can still hover over shortened name to see where it links of course).

ethanfurman · 2022-02-04T18:04:22Z

Doc/library/re.rst

+
+   An :class:`~enum.Enum` class containing the regex options listed below.
+
+   .. versionadded:: 3.6 (documented in 3.11)


Perhaps .. versionchanged:: added to all in 3.11

bedevere-bot · 2022-02-04T19:32:03Z

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.

ethanfurman · 2022-02-05T00:01:40Z

Doc/library/re.rst


-   .. versionadded:: 3.6 (documented in 3.11)
+   .. versionadded:: added to ``__all__`` in 3.11)


Missing a parenthesis, so lets change to:

.. versionadded:: 3.11 - added to ``__all__``

clinton21obeng · 2022-02-05T00:44:31Z

Stop

…

On Sat, Feb 5, 2022, 12:03 AM Ethan Furman ***@***.***> wrote: ***@***.**** requested changes on this pull request. ------------------------------ In Doc/library/re.rst <#30279 (comment)>: > - .. versionadded:: 3.6 (documented in 3.11) + .. versionadded:: added to ``__all__`` in 3.11) Missing a parenthesis, so lets change to: .. versionadded:: 3.11 - added to ``__all__`` — Reply to this email directly, view it on GitHub <#30279 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AV5LH7EJ7NIFS3KIFCKMXF3UZRSNDANCNFSM5K3D7JFQ> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

akulakov · 2022-02-05T03:57:36Z

@ethanfurman thanks for reviewing!

akulakov added 3 commits December 27, 2021 18:26

added RegexFlag to re.__all__; added RegexFlag.NOFLAG

e513df4

added news entry

cf6a00e

add a comma

fe74940

the-knights-who-say-ni added the CLA signed label Dec 27, 2021

bedevere-bot added the awaiting review label Dec 27, 2021

JelleZijlstra requested changes Jan 19, 2022

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Jan 19, 2022

akulakov and others added 3 commits January 20, 2022 01:31

added versionadded tags and added NOFLAG to __all__

dbe2094

add example for NOFLAG

de7fc51

Update Misc/NEWS.d/next/Library/2021-12-27-18-28-44.bpo-31369.b9yM94.rst

e410e0d

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

AlexWaygood requested a review from ethanfurman February 4, 2022 17:51

ethanfurman requested changes Feb 4, 2022

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting core review labels Feb 4, 2022

update per comments

b9bd6a5

ethanfurman requested changes Feb 5, 2022

View reviewed changes

update versionadded

e145b52

ethanfurman approved these changes Feb 5, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Feb 5, 2022

ethanfurman merged commit fea7290 into python:main Feb 5, 2022

bedevere-bot removed the awaiting merge label Feb 5, 2022

akulakov deleted the 31369-Add-RegexFlag-to-__all__ branch February 5, 2022 03:57

Stevoisiak mentioned this pull request Feb 10, 2023

Add an explicit re.NOFLAGS flag value to the re module #57594

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-31369: include RegexFlag in re.all #30279

bpo-31369: include RegexFlag in re.all #30279

akulakov commented Dec 27, 2021 •

edited

JelleZijlstra Jan 19, 2022

akulakov Jan 20, 2022 •

edited

JelleZijlstra Jan 20, 2022

merwok Feb 10, 2023 •

edited

ethanfurman Feb 10, 2023

JelleZijlstra Jan 19, 2022

JelleZijlstra commented Jan 22, 2022

bdice commented Feb 4, 2022 •

edited

ethanfurman Feb 4, 2022

akulakov Feb 4, 2022

ethanfurman Feb 4, 2022

bedevere-bot commented Feb 4, 2022

ethanfurman Feb 5, 2022

clinton21obeng commented Feb 5, 2022 via email

akulakov commented Feb 5, 2022


		An :class:`~enum.Enum` class containing the regex options listed below.

		.. versionadded:: 3.6 (documented in 3.11)


		.. versionadded:: 3.6 (documented in 3.11)
		.. versionadded:: added to ``__all__`` in 3.11)

bpo-31369: include RegexFlag in re.__all__ #30279

bpo-31369: include RegexFlag in re.__all__ #30279

Conversation

akulakov commented Dec 27, 2021 • edited

Choose a reason for hiding this comment

akulakov Jan 20, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

merwok Feb 10, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JelleZijlstra commented Jan 22, 2022

bdice commented Feb 4, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bedevere-bot commented Feb 4, 2022

Choose a reason for hiding this comment

clinton21obeng commented Feb 5, 2022 via email

akulakov commented Feb 5, 2022

bpo-31369: include RegexFlag in re.all #30279

bpo-31369: include RegexFlag in re.all #30279

akulakov commented Dec 27, 2021 •

edited

akulakov Jan 20, 2022 •

edited

merwok Feb 10, 2023 •

edited

bdice commented Feb 4, 2022 •

edited