homepage

Currently, mo.groupdict() always inserts a default value for unmatched named groups. This is helpful in some use cases and awkward in others.
I propose adding an option to suppress default entries:
>>> # CURRENT WAY
>>> pattern = r'(?P<TITLE>Mrs |Mr |Dr )?(?P<LASTNAME>\w+)(?P<SUFFIX> Phd| JD)?'
>>> print re.match(pattern, 'Dr Who').groupdict()
{'LASTNAME': 'Who', 'SUFFIX': None, 'TITLE': 'Dr '}
>>> # PROPOSED WAY
>>> print re.match(pattern, 'Dr Who').groupdict(nodefault=True)
{'LASTNAME': 'Who', 'TITLE': 'Dr '}
>>> # UPSTREAM VARIANT
>>> print re.match(pattern, 'Dr Who', re.NODEFAULT).groupdict()
{'LASTNAME': 'Who', 'TITLE': 'Dr '}
There is probably a better name than "nodefault", but I would like to see someway to improve the usability of groupdict().

Just a thought--how about a new constant in the re module:
 SUPPRESSED=object()
and have the interface be
 mo.groupdict(default=re.SUPPRESSED)

@rhettinger: The problem with "nodefault" is that it's negative, so that "nodefault=False" means that you don't not want the default, if you see what I mean. I think that "suppress" would be better:
 mo.groupdict(suppress=True)
@larry: If the parameter was "default", would that mean that you could provide a different default, such as:
 mo.groupdict(default="")

@mrabarnett: That's right--except your tense is wrong. mo.groupdict() has supported the "default" parameter since the function was first added, way back in 1.5.2.

Maybe start emitting FutureWarning when groupdict() is called without an argument? groupdict(None) returns the same result but without a warning. After 1 or 2 releases the behavior can be changed: groupdict() will return only matched groups.

Proposed patch makes groupdict() without argument emitting FutureWarning if the result includes unmatched groups. Maybe warning message and the documentation could be better.
Ned, I ask your permission for including this change in 3.6. Yes, it can break third-party code that ran with -Werror, but I think groupdict() is rarely used in comparison of other match object API. The workaround is simple -- just use groupdict(None). The earlier we add a warning, the earlier we can change the behavior of groupdict(). If we did it in 3.4 (the time Raymond opened this issue), we could get new behavior in 3.7.

How do others feel about Serhiy's proposal for eventually changing the semantics of groupdict() to mean only return matched groups? If that seems reasonable, then there is the separate question of how to make the transition. Adding a somewhat unpredictable FutureWarning, i.e. one that depends on the input, seems somewhat risky and user-unfriendly at this late stage of the release cycle. But I'm open to persuasion.

I'd prefer an explicit suppression to changing a long-standing behaviour.