Sitelet https://github.com/python/cpython/issues/93521
Skip to content

Cannot specify weakref_slot=True twice in dataclass MRO #93521

Description

@Bluenix2

Summary

If a child dataclass of a parent dataclass who specified weakref_slot, also decides to set weakref_slot to True, Python will raise a TypeError as seen below:

TypeError: __weakref__ slot disallowed: either we already got one, or __itemsize__ != 0

Description

I am porting dataclasses' slots and weakref slots kwargs into a decorator I can use. While doing so, I decided to change the default of the weakref_slot because I would like all of my classes to be weakref:able. This is when I ran into the issue which can be reproduced by the code below:

from dataclasses import dataclass


@dataclass(slots=True, weakref_slot=True)
class A:
    field: str


@dataclass(slots=True, weakref_slot=True)
class B(A):
    ...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
  File "C:\Users\%username%\Projects\testing\copyclasses.py", line 1207, in wrap
    return _process_class(cls, init, repr, eq, order, unsafe_hash,
  File "C:\Users\%username%\Projects\testing\copyclasses.py", line 1108, in _process_class
    cls = _add_slots(cls, frozen, weakref_slot)
  File "C:\Users\%username%\Projects\testing\copyclasses.py", line 1176, in _add_slots    
    cls = type(cls)(cls.__name__, cls.__bases__, cls_dict)
TypeError: __weakref__ slot disallowed: either we already got one, or __itemsize__ != 0

Environment

This was tested by creating a file named copyclasses.py with the current contents of Lib/dataclasses.py ran using a 3.10 CPython interpreter. Note that I've restored the naming of the module in the codeblock above assuming those who will be running it will have a built 3.11 CPython interpreter.


Footnotes: I will mention @ericvsmith as the code owner of the dataclasses file.

Activity

  1. added
    stdlibStandard Library Python modules in the Lib/ directory
    on Jun 5, 2022
  2. ericvsmith commented on Jun 5, 2022

    @ericvsmith
    Member

    Here's an example of the same thing without dataclasses:

    class A:
        __slots__='__weakref__'
    
    class B(A):
        __slots__='__weakref__'
    Traceback (most recent call last):
      File "gh-93521.py", line 4, in <module>
        class B(A):
    TypeError: __weakref__ slot disallowed: either we already got one, or __itemsize__ != 0
    
  3. ericvsmith commented on Jun 5, 2022

    @ericvsmith
    Member

    I'm not sure this is a bug, just the way things work.

  4. JelleZijlstra commented on Jun 6, 2022

    @JelleZijlstra
    Member

    It would be nice if dataclasses took care of this issue automatically though.

    Example scenario: I have a library in which I expose a dataclass. A user subclasses my class in another dataclass, and wants to use weakrefs, so they use weakref_slots. Then I change my library to allow weakrefs on the base class, but now the user's child class is broken.

  5. Bluenix2 commented on Jun 6, 2022

    @Bluenix2
    ContributorAuthor

    Locally I fixed this already, and I am planning on opening a PR with an added test. Should that PR point to main or the 3.11 branch (seeing as both branches should get the patch)?

  6. ericvsmith commented on Jun 6, 2022

    @ericvsmith
    Member

    main

  7. added a commit that references this issue on Jun 6, 2022
  8. added a commit that references this issue on Jun 8, 2022
  9. added 2 commits that reference this issue on Jun 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

3.11only security fixesstdlibStandard Library Python modules in the Lib/ directorytype-bugAn unexpected behavior, bug, or error

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions