AttributeError changed to AssertionError for invalid identifiers

Since #449 trying to use missing extras raises AssertionErrors. I believe that invalid inputs should never raise AssertionErrors (neither should asserts be used to validate user input).

Observe on Python 3.12 (before this change):

>>> ep = importlib.metadata.EntryPoint(name='foo', value='invalid-identifier:foo', group='foo')
>>> ep.extras
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/lib64/python3.12/importlib/metadata/__init__.py", line 222, in extras
    return re.findall(r'\w+', match.group('extras') or '')
                              ^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'group'

Now this exception message is bogus but at least this is an AttributeError (hence code reading this might assume the .extras attribute is missing).

However, on Python 3.13:

>>> ep = importlib.metadata.EntryPoint(name='foo', value='invalid-identifier:foo', group='foo')
>>> ep.extras
Traceback (most recent call last):
  File "<python-input-2>", line 1, in <module>
    ep.extras
  File "/usr/lib64/python3.13/importlib/metadata/__init__.py", line 198, in extras
    assert match is not None
           ^^^^^^^^^^^^^^^^^
AssertionError

Existing code (e.g. setuptools) assumes AttributeError in this case:

See https://github.com/pypa/setuptools/blob/544b332bd78d8d274597923e89b9bd7839f8a0f4/setuptools/_entry_points.py#L18-L25

I believe both behaviors are wrong, but the new one is "more wrong".

May I suggest that either .extras or .__init__ raises a specific exception when this happens?

Make the validation test for entry-points work with Python 3.13+

Thanks for the report. Without looking at the code, I agree the API should provide a documented expectation for erroneous inputs, especially if callers are relying on that interface to perform validation (as seems to be the case).

I suspect what was going on here is the code is basically expecting valid input and providing some best-effort checks to validate the input, but not expecting the exceptional case to be encountered except under broken callers.

Looking at this again, I see notice that the assert match is not None was probably put there to satisfy linters (and also to assert a match is always expected).

May I suggest that either .extras or .__init__ raises a specific exception when this happens?

I've also observed that the issue affects .module and .attr and .load. I'm trying to decide what's the best behavior here. I think it should fail early, at construction time, but right now, the interface is open to mutation of the entry point properties. Probably those should be made final. I'll save that change for another time.

So I'll probably refactor it so that a ValueError is raised on construction and any time the value is parsed. I'm slightly concerned that checking the value on construction could have performance implications.

Raise a ValueError if no match.

Navigation Menu

Repository navigation

AttributeError changed to AssertionError for invalid identifiers #488

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

AttributeError changed to AssertionError for invalid identifiers #488

Description

Activity

jaraco commented on Jun 24, 2024

jaraco commented on Apr 27, 2025

jaraco commented on Apr 27, 2025

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions