René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"3.11 creates doctests for Enum subclasses brittle against `globs` and overridden `__repr__`","articleBody":"**Bug report**\r\n\r\nIn 3.11, subclassing `Enum` _without providing a docstring_ causes tests to be added to a module's doctest suite.\r\n\r\n- This lengthens test suites\r\n- This creates failures if `Enum` is not provided in the `globs` argument to `doctest` test runners\r\n- This creates failures if `__repr__` is overridden\r\n\r\n```python\r\nimport re\r\nfrom enum import Enum\r\n\r\nclass MyEnum(Enum):\r\n    def __repr__(self):\r\n        \"\"\"Suppress the trailing colon and integer\"\"\"\r\n        return re.sub(r': \\d+', '', super().__repr__())\r\n\r\n\r\nclass FinalEnum(MyEnum):\r\n    MEMBER = 1\r\n\r\n\r\nif __name__ == \"__main__\":\r\n    import doctest\r\n    doctest.testmod(globs={'MyEnum': MyEnum, 'FinalEnum': FinalEnum})\r\n```\r\n\r\n**3.10**\r\n```shell\r\n$ python3.10 e.py -v\r\n4 items had no tests:\r\n    __main__\r\n    __main__.FinalEnum\r\n    __main__.MyEnum\r\n    __main__.MyEnum.__repr__\r\n0 tests in 4 items.\r\n0 passed and 0 failed.\r\nTest passed.\r\n```\r\n\r\n**3.11**\r\n```shell\r\n$ python3.11 e.py\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line ?, in __main__.FinalEnum\r\nFailed example:\r\n    FinalEnum.MEMBER\r\nExpected:\r\n    \u003cFinalEnum.MEMBER: 1\u003e\r\nGot:\r\n    \u003cFinalEnum.MEMBER\u003e\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line ?, in __main__.FinalEnum\r\nFailed example:\r\n    FinalEnum(1)\r\nExpected:\r\n    \u003cFinalEnum.MEMBER: 1\u003e\r\nGot:\r\n    \u003cFinalEnum.MEMBER\u003e\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line ?, in __main__.FinalEnum\r\nFailed example:\r\n    FinalEnum['MEMBER']\r\nExpected:\r\n    \u003cFinalEnum.MEMBER: 1\u003e\r\nGot:\r\n    \u003cFinalEnum.MEMBER\u003e\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line ?, in __main__.FinalEnum\r\nFailed example:\r\n    list(FinalEnum)\r\nExpected:\r\n    [\u003cFinalEnum.MEMBER: 1\u003e]\r\nGot:\r\n    [\u003cFinalEnum.MEMBER\u003e]\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line 10, in __main__.MyEnum\r\nFailed example:\r\n    class Color(Enum):\r\n        RED = 1\r\n        BLUE = 2\r\n        GREEN = 3\r\nException raised:\r\n    Traceback (most recent call last):\r\n      File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/doctest.py\", line 1350, in __run\r\n        exec(compile(example.source, filename, \"single\",\r\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n      File \"\u003cdoctest __main__.MyEnum[0]\u003e\", line 1, in \u003cmodule\u003e\r\n        class Color(Enum):\r\n                    ^^^^\r\n    NameError: name 'Enum' is not defined\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line 19, in __main__.MyEnum\r\nFailed example:\r\n    Color.RED\r\nException raised:\r\n    Traceback (most recent call last):\r\n      File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/doctest.py\", line 1350, in __run\r\n        exec(compile(example.source, filename, \"single\",\r\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n      File \"\u003cdoctest __main__.MyEnum[1]\u003e\", line 1, in \u003cmodule\u003e\r\n        Color.RED\r\n        ^^^^^\r\n    NameError: name 'Color' is not defined\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line 24, in __main__.MyEnum\r\nFailed example:\r\n    Color(1)\r\nException raised:\r\n    Traceback (most recent call last):\r\n      File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/doctest.py\", line 1350, in __run\r\n        exec(compile(example.source, filename, \"single\",\r\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n      File \"\u003cdoctest __main__.MyEnum[2]\u003e\", line 1, in \u003cmodule\u003e\r\n        Color(1)\r\n        ^^^^^\r\n    NameError: name 'Color' is not defined\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line 29, in __main__.MyEnum\r\nFailed example:\r\n    Color['RED']\r\nException raised:\r\n    Traceback (most recent call last):\r\n      File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/doctest.py\", line 1350, in __run\r\n        exec(compile(example.source, filename, \"single\",\r\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n      File \"\u003cdoctest __main__.MyEnum[3]\u003e\", line 1, in \u003cmodule\u003e\r\n        Color['RED']\r\n        ^^^^^\r\n    NameError: name 'Color' is not defined\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line 34, in __main__.MyEnum\r\nFailed example:\r\n    len(Color)\r\nException raised:\r\n    Traceback (most recent call last):\r\n      File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/doctest.py\", line 1350, in __run\r\n        exec(compile(example.source, filename, \"single\",\r\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n      File \"\u003cdoctest __main__.MyEnum[4]\u003e\", line 1, in \u003cmodule\u003e\r\n        len(Color)\r\n            ^^^^^\r\n    NameError: name 'Color' is not defined\r\n**********************************************************************\r\nFile \"/Users/.../e.py\", line 37, in __main__.MyEnum\r\nFailed example:\r\n    list(Color)\r\nException raised:\r\n    Traceback (most recent call last):\r\n      File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/doctest.py\", line 1350, in __run\r\n        exec(compile(example.source, filename, \"single\",\r\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n      File \"\u003cdoctest __main__.MyEnum[5]\u003e\", line 1, in \u003cmodule\u003e\r\n        list(Color)\r\n             ^^^^^\r\n    NameError: name 'Color' is not defined\r\n**********************************************************************\r\n2 items had failures:\r\n   4 of   5 in __main__.FinalEnum\r\n   6 of   6 in __main__.MyEnum\r\n***Test Failed*** 10 failures.\r\n```\r\n***\r\n**Your environment**\r\n\r\nPython 3.11.0b3\r\n\r\ncc/ @mscuthbert  (FYI: a potential workaround is to add docstrings)","author":{"url":"https://github.com/jacobtylerwalls","@type":"Person","name":"jacobtylerwalls"},"datePublished":"2022-06-18T01:25:42.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/93976/cpython/issues/93976"}