Use ABC rather than Protocol

`Protocol` is meant to be used for structural typing, whereas `ABC` is meant to be used for nominal typing. As our models are based on the Java models, `ABC` thus makes more sense.

Author: knutwannheden

rewrite/rewrite/execution.py

@@ -1,23 +1,25 @@
 from __future__ import annotations
 
-from abc import ABC
+from abc import ABC, abstractmethod
 from collections.abc import Callable
 from dataclasses import dataclass
-from typing import Protocol, Any, ClassVar, TYPE_CHECKING, List, Optional
+from typing import Any, ClassVar, TYPE_CHECKING, List, Optional
 
 from .tree import SourceFile
 
 if TYPE_CHECKING:
     from .visitor import TreeVisitor, Cursor
 
 
-class ExecutionContext(Protocol):
+class ExecutionContext(ABC):
     REQUIRE_PRINT_EQUALS_INPUT: ClassVar[str] = "org.openrewrite.requirePrintEqualsInput"
     CHARSET: ClassVar[str] = "org.openrewrite.parser.charset"
 
+    @abstractmethod
     def get_message(self, key: str, default_value=None) -> Any:
         ...
 
+    @abstractmethod
     def put_message(self, key: str, value: Any):
         ...
 

rewrite/rewrite/java/support_types.py

@@ -1,28 +1,28 @@
 from __future__ import annotations
 
 import weakref
+from abc import abstractmethod, ABC
 from dataclasses import dataclass, replace
 from enum import Enum, auto
-from functools import cached_property
-from typing import List, Optional, Protocol, TypeVar, Generic, ClassVar, Dict, runtime_checkable, Any, cast, \
-    TYPE_CHECKING, Iterable
+from typing import List, Optional, TypeVar, Generic, ClassVar, Dict, Any, TYPE_CHECKING, Iterable
 from uuid import UUID
 
-from rewrite import Tree, SourceFile, TreeVisitor
 from rewrite import Markers
+from rewrite import Tree, SourceFile, TreeVisitor
 
 if TYPE_CHECKING:
     from .visitor import JavaVisitor
 
 P = TypeVar('P')
 
 
-@runtime_checkable
-class J(Tree, Protocol):
+class J(Tree):
     @property
+    @abstractmethod
     def prefix(self) -> Space:
         ...
 
+    @abstractmethod
     def with_prefix(self, prefix: Space) -> 'J':
         ...
 
@@ -39,8 +39,9 @@ def accept_java(self, v: 'JavaVisitor[P]', p: P) -> Optional['J']:
 
 
 @dataclass(frozen=True)
-class Comment(Protocol):
+class Comment(ABC):
     @property
+    @abstractmethod
     def multiline(self) -> bool:
         ...
 
@@ -288,47 +289,39 @@ class Location(Enum):
 Space.SINGLE_SPACE = Space([], ' ')
 
 
-@runtime_checkable
-class JavaSourceFile(SourceFile, Protocol):
+class JavaSourceFile(SourceFile):
     pass
 
 
-@runtime_checkable
-class Expression(J, Protocol):
+class Expression(J):
     pass
 
 
-@runtime_checkable
-class Statement(J, Protocol):
+class Statement(J):
     pass
 
 
-@runtime_checkable
-class TypedTree(J, Protocol):
+class TypedTree(J):
     pass
 
 
-@runtime_checkable
-class NameTree(TypedTree, Protocol):
+class NameTree(TypedTree):
     pass
 
 
-@runtime_checkable
-class TypeTree(NameTree, Protocol):
+class TypeTree(NameTree):
     pass
 
 
-@runtime_checkable
-class Loop(Statement, Protocol):
+class Loop(Statement):
     pass
 
 
-@runtime_checkable
-class MethodCall(Expression, Protocol):
+class MethodCall(Expression):
     pass
 
 
-class JavaType(Protocol):
+class JavaType(ABC):
     class FullyQualified:
         pass
 

rewrite/rewrite/java/tree.py

@@ -3,7 +3,7 @@
 import weakref
 from dataclasses import dataclass, replace
 from pathlib import Path
-from typing import List, Optional, Protocol, runtime_checkable, TYPE_CHECKING
+from typing import List, Optional, TYPE_CHECKING
 from uuid import UUID
 from enum import Enum
 

rewrite/rewrite/markers.py

@@ -1,21 +1,23 @@
 from __future__ import annotations
-import traceback
 
+import traceback
+from abc import ABC, abstractmethod
 from dataclasses import dataclass, replace
-from typing import List, Protocol, ClassVar, cast, runtime_checkable, TYPE_CHECKING
+from typing import List, ClassVar, cast, TYPE_CHECKING
 from uuid import UUID
 
 if TYPE_CHECKING:
     from .parser import Parser
 from .utils import random_id
 
 
-@runtime_checkable
-class Marker(Protocol):
+class Marker(ABC):
     @property
+    @abstractmethod
     def id(self) -> UUID:
         ...
 
+    @abstractmethod
     def with_id(self, id: UUID) -> Marker:
         ...
 

rewrite/rewrite/python/_parser_visitor.py

@@ -505,7 +505,7 @@ def visit_withitem(self, node):
         else:
             var = expr
 
-        if not is_of_type(var, TypedTree):
+        if not isinstance(var, TypedTree):
             var = py.ExpressionTypeTree(
                 random_id(),
                 Space.EMPTY,
@@ -1860,7 +1860,7 @@ def visit_UnaryOp(self, node):
     def __convert_type(self, node) -> Optional[TypeTree]:
         prefix = self.__whitespace()
         converted_type = self.__convert_internal(node, self.__convert_type, self.__convert_type_mapper)
-        if is_of_type(converted_type, TypeTree):
+        if isinstance(converted_type, TypeTree):
             return converted_type.with_prefix(prefix)
         else:
             return py.ExpressionTypeTree(
@@ -1940,7 +1940,7 @@ def __convert(self, node) -> Optional[J]:
 
     def __convert_statement(self, node) -> Optional[J]:
         converted = self.__convert_internal(node, self.__convert_statement)
-        if is_of_type(converted, Statement):
+        if isinstance(converted, Statement):
             return converted
         return py.ExpressionStatement(
             random_id(),
@@ -2390,7 +2390,3 @@ def __map_fstring(self, node: ast.JoinedStr, prefix: Space, tok: TokenInfo, toke
     def __cursor_at(self, s: str):
         return self._cursor < len(self._source) and (
                 len(s) == 1 and self._source[self._cursor] == s or self._source.startswith(s, self._cursor))
-
-
-def is_of_type(obj, type):
-    return type in obj.__class__.__mro__

rewrite/rewrite/python/style.py

@@ -1,12 +1,12 @@
 from __future__ import annotations
 
+from abc import ABC
 from dataclasses import dataclass, replace
-from typing import Protocol
 
 from ..style import Style, NamedStyles
 
 
-class PythonStyle(Style, Protocol):
+class PythonStyle(Style):
     pass
 
 

rewrite/rewrite/python/support_types.py

@@ -2,7 +2,7 @@
 
 from dataclasses import replace, dataclass
 from enum import Enum, auto
-from typing import Protocol, TypeVar, runtime_checkable, Any, Optional, TYPE_CHECKING
+from typing import TypeVar, Any, Optional, TYPE_CHECKING
 
 from rewrite import TreeVisitor, Markers
 from rewrite.java.tree import J
@@ -14,8 +14,7 @@
 P = TypeVar('P')
 
 
-@runtime_checkable
-class Py(J, Protocol):
+class Py(J):
     def accept(self, v: TreeVisitor[Any, P], p: P) -> Optional[Any]:
         from .visitor import PythonVisitor
         return self.accept_python(v.adapt(Py, PythonVisitor), p)

rewrite/rewrite/python/tree.py

@@ -3,7 +3,7 @@
 import weakref
 from dataclasses import dataclass, replace
 from pathlib import Path
-from typing import List, Optional, Protocol, runtime_checkable, TYPE_CHECKING
+from typing import List, Optional, TYPE_CHECKING
 from uuid import UUID
 from enum import Enum
 
@@ -726,6 +726,13 @@ def prefix(self) -> Space:
     def with_prefix(self, prefix: Space) -> ExpressionStatement:
         return self.with_expression(self._expression.with_prefix(prefix))
 
+    @property
+    def markers(self) -> Markers:
+        return self._expression.markers
+
+    def with_markers(self, markers: Markers) -> ExpressionStatement:
+        return self.with_expression(self._expression.with_markers(markers))
+
     _expression: Expression
 
     @property
@@ -799,6 +806,13 @@ def prefix(self) -> Space:
     def with_prefix(self, prefix: Space) -> StatementExpression:
         return self.with_statement(self._statement.with_prefix(prefix))
 
+    @property
+    def markers(self) -> Markers:
+        return self._statement.markers
+
+    def with_markers(self, markers: Markers) -> StatementExpression:
+        return self.with_statement(self._statement.with_markers(markers))
+
     _statement: Statement
 
     @property

rewrite/rewrite/style.py

@@ -1,15 +1,15 @@
 from __future__ import annotations
 
+from abc import ABC
 from dataclasses import dataclass, replace
-from typing import Protocol, TypeVar, Type, Iterable, Optional, Set, runtime_checkable
+from typing import TypeVar, Type, Iterable, Optional, Set
 from uuid import UUID
 
 from .markers import Marker
 from .utils import random_id
 
 
-@runtime_checkable
-class Style(Protocol):
+class Style(ABC):
     def merge(self, lower_precedence: Style) -> Style:
         return self
 

rewrite/rewrite/tree.py

@@ -2,11 +2,11 @@
 
 import os
 import threading
+from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from datetime import datetime
 from pathlib import Path
-from typing import Protocol, Optional, Any, TypeVar, runtime_checkable, cast, TYPE_CHECKING, Generic, ClassVar, \
-    Callable, Type
+from typing import Optional, Any, TypeVar, cast, TYPE_CHECKING, Generic, ClassVar, Callable, Type
 from uuid import UUID
 
 from .markers import Markers
@@ -19,22 +19,26 @@
 P = TypeVar('P')
 
 
-@runtime_checkable
-class Tree(Protocol):
+class Tree(ABC):
     @property
+    @abstractmethod
     def id(self) -> UUID:
         ...
 
+    @abstractmethod
     def with_id(self, id: UUID) -> Tree:
         ...
 
     @property
+    @abstractmethod
     def markers(self) -> Markers:
         ...
 
+    @abstractmethod
     def with_markers(self, markers: Markers) -> Tree:
         ...
 
+    @abstractmethod
     def is_acceptable(self, v: TreeVisitor[Any, P], p: P) -> bool:
         ...
 
@@ -57,7 +61,7 @@ def __hash__(self) -> int:
         return hash(self.id)
 
 
-class PrinterFactory(Protocol):
+class PrinterFactory(ABC):
     _thread_local = threading.local()
 
     @classmethod
@@ -70,29 +74,34 @@ def current(cls) -> PrinterFactory:
     def set_current(self):
         PrinterFactory._thread_local.context = self
 
+    @abstractmethod
     def create_printer(self, cursor: Cursor) -> TreeVisitor[Any, PrintOutputCapture[P]]:
         ...
 
 
 S = TypeVar('S', bound=Style)
 
-@runtime_checkable
-class SourceFile(Tree, Protocol):
+class SourceFile(Tree):
     @property
+    @abstractmethod
     def charset_name(self) -> Optional[str]:
         ...
 
     @property
+    @abstractmethod
     def source_path(self) -> Path:
         ...
 
+    @abstractmethod
     def with_source_path(self, source_path: Path) -> SourceFile:
         ...
 
     @property
+    @abstractmethod
     def file_attributes(self) -> Optional[FileAttributes]:
         ...
 
+    @abstractmethod
     def with_file_attributes(self, file_attributes: Optional[FileAttributes]) -> SourceFile:
         ...
 
@@ -148,7 +157,7 @@ class Checksum:
 
 class PrintOutputCapture(Generic[P]):
     @dataclass
-    class MarkerPrinter(Protocol):
+    class MarkerPrinter(ABC):
         DEFAULT: ClassVar['PrintOutputCapture.MarkerPrinter'] = None
 
         def before_syntax(self, marker: 'Marker', cursor: 'Cursor', comment_wrapper: Callable[[str], str]) -> str: