Mercurial > public > mercurial-scm > hg
view mercurial/interfaces/status.py @ 52506:199b0e62b403
interfaces: make the `peer` mixin not a Protocol to fix Python 3.10 failures
I can't find any documentation on this, but it appears that Protocol class
attributes don't get inherited in subclasses that explicitly subclass a Protocol
until Python 3.11, which caused a ton of failures in CI on macOS and Windows
(which both test using Python 3.9). The problem started with 1df97507c6b8, and
typically manifested as most tests failing to access `ui` on various `peer`
classes.
Here's a short proof of concept:
from __future__ import annotations
from typing import (
Protocol,
)
class peer(Protocol):
limitedarguments: bool = False
def __init__(self, arg1, arg2, remotehidden: bool = False) -> None:
self.arg1 = arg1
self.arg2 = arg2
class subclass(peer):
def __init__(self, arg1, arg2):
super(subclass, self).__init__(arg1, arg2, False)
sub = subclass(1, 2)
print("sub.arg1 is %r" % sub.arg1)
When run with Python 3.8.10, 3.9.13, and 3.10.11, the result is:
$ py -3.8 prot-test.py
Traceback (most recent call last):
File "prot-test.py", line 20, in <module>
print("sub.arg1 is %r" % sub.arg1)
AttributeError: 'subclass' object has no attribute 'arg1'
On Python 3.11.9, 3.12.7, and 3.13.0, the result is:
$ py -3.11 ../prot-test.py
sub.arg1 is 1
Explicitly adding annotations to `peer` like `limitedarguments` didn't help.
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Sun, 15 Dec 2024 18:52:05 -0500 |
parents | f5d134e57f51 |
children |
line wrap: on
line source
# status.py - Type annotations for status related objects # # Copyright Matt Harbison <mharbison72@gmail.com> # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. from __future__ import annotations import abc from typing import ( Iterator, Protocol, ) class Status(Protocol): """Struct with a list of files per status. The 'deleted', 'unknown' and 'ignored' properties are only relevant to the working copy. """ modified: list[bytes] """The list of files with modifications.""" added: list[bytes] """The list of files that started being tracked.""" removed: list[bytes] """The list of files that stopped being tracked.""" deleted: list[bytes] """The list of files in the working directory that are deleted from the file system (but not in the removed state).""" unknown: list[bytes] """The list of files in the working directory that are not tracked.""" ignored: list[bytes] """The list of files in the working directory that are ignored.""" clean: list[bytes] """The list of files that are not in any other state.""" @abc.abstractmethod def __iter__(self) -> Iterator[list[bytes]]: """Iterates over each of the categories of file lists.""" @abc.abstractmethod def __repr__(self) -> str: """Creates a string representation of the file lists."""