Add comparison methods to few types. (#70)

Closes #60

Author: karthiknadig

generator/requirements.txt

@@ -18,9 +18,9 @@ importlib-resources==5.9.0 \
     # via
     #   -r ./generator/requirements.in
     #   jsonschema
-jsonschema==4.12.1 \
-    --hash=sha256:05f975aee3f1244a1ea0e018e8ad2672f6ca5fd1a28bc46ffc7d4b3e9896cac4 \
-    --hash=sha256:c7dd96a88c4ea60bdc8478589ee2d4ea5d73ab235e24d17641ad733dde4e3eb1
+jsonschema==4.13.0 \
+    --hash=sha256:3776512df4f53f74e6e28fe35717b5b223c1756875486984a31bc9165e7fc920 \
+    --hash=sha256:870a61bb45050b81103faf6a4be00a0a906e06636ffcf0b84f5a2e51faf901ff
     # via -r ./generator/requirements.in
 pkgutil-resolve-name==1.3.10 \
     --hash=sha256:357d6c9e6a755653cfd78893817c0853af365dd51ec97f3d358a819373bbd174 \

generator/utils.py

@@ -139,6 +139,7 @@ def _reset(self):
         self._types: OrderedDict[str, List[str]] = collections.OrderedDict()
         self._imports: List[str] = [
             "import enum",
+            "import functools",
             "from typing import Any, Dict, List, Optional, Tuple, Union",
             "import attrs",
             "from . import validators",
@@ -292,6 +293,41 @@ def _has_type(self, type_name: str) -> bool:
             type_name = type_name[1:-1]
         return type_name in self._types
 
+    def _get_additional_methods(self, class_name: str) -> List[str]:
+        indent = " " * 4
+        if class_name == "Position":
+            return [
+                "def __eq__(self, o: 'Position') -> Union[bool, 'NotImplemented']:",
+                f"{indent}if not isinstance(o, Position):",
+                f"{indent}{indent}return NotImplemented",
+                f"{indent}return (self.line, self.character) == (o.line, o.character)",
+                "def __gt__(self, o: 'Position') -> Union[bool, 'NotImplemented']:",
+                f"{indent}if not isinstance(o, Position):",
+                f"{indent}{indent}return NotImplemented",
+                f"{indent}return (self.line, self.character) > (o.line, o.character)",
+                "def __repr__(self) -> str:",
+                f"{indent}" + "return f'{self.line}:{self.character}'",
+            ]
+        if class_name == "Range":
+            return [
+                "def __eq__(self, o: 'Range') -> Union[bool, 'NotImplemented']:",
+                f"{indent}if not isinstance(o, Range):",
+                f"{indent}{indent}return NotImplemented",
+                f"{indent}return (self.start == o.start) and (self.end == o.end)",
+                "def __repr__(self) -> str:",
+                f"{indent}" + "return f'{self.start!r}-{self.end!r}'",
+            ]
+        if class_name == "Location":
+            return [
+                "def __eq__(self, o:'Location') -> Union[bool, 'NotImplemented']:",
+                f"{indent}if not isinstance(o, Location):",
+                f"{indent}{indent}return NotImplemented",
+                f"{indent}return (self.uri == o.uri) and (self.range == o.range)",
+                "def __repr__(self) -> str:",
+                f"{indent}" + "return f'{self.uri}:{self.range!r}'",
+            ]
+        return None
+
     def _add_type_code(self, type_name: str, code: List[str]) -> None:
         if not self._has_type(type_name):
             self._types[type_name] = code
@@ -529,6 +565,7 @@ def _add_structure(
 
         class_lines = [
             "" if class_name == "LSPObject" else "@attrs.define",
+            "@functools.total_ordering" if class_name == "Position" else "",
             f"class {class_name}:",
             f'{indent}"""{doc}"""' if struct_def.documentation else "",
             f"{indent}# Since: {_sanitize_comment(struct_def.since)}"
@@ -549,10 +586,15 @@ def _add_structure(
             properties += copy.deepcopy(d.properties)
 
         code_lines += self._generate_properties(class_name, properties, indent)
+        methods = self._get_additional_methods(class_name)
+
         # If the class has no properties then add `pass`
-        if len(properties) == 0:
+        if len(properties) == 0 and not methods:
             code_lines += [f"{indent}pass"]
 
+        if methods:
+            code_lines += [f"{indent}{l}" for l in methods]
+
         # Detect if the class has properties that might be keywords.
         self._add_type_code(class_name, code_lines)
 
@@ -764,9 +806,9 @@ def _add_lsp_method_type(self, lsp_model: model.LSPModel) -> None:
             "@enum.unique",
             "class MessageDirection(enum.Enum):",
         ]
-        code_lines += [
-            f"{indent}{_capitalized_item_name(m)} = '{m}'" for m in directions
-        ]
+        code_lines += sorted(
+            [f"{indent}{_capitalized_item_name(m)} = '{m}'" for m in directions]
+        )
         self._add_type_code("MessageDirection", code_lines)
 
     def _generate_code(self, lsp_model: model.LSPModel) -> None:

lsprotocol/types.py

@@ -8,6 +8,7 @@
 # 3. Run command: `python -m nox --session build_lsp`
 
 import enum
+import functools
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import attrs
@@ -996,6 +997,14 @@ class Location:
 
     range: "Range" = attrs.field()
 
+    def __eq__(self, o: "Location") -> Union[bool, "NotImplemented"]:
+        if not isinstance(o, Location):
+            return NotImplemented
+        return (self.uri == o.uri) and (self.range == o.range)
+
+    def __repr__(self) -> str:
+        return f"{self.uri}:{self.range!r}"
+
 
 @attrs.define
 class TextDocumentRegistrationOptions:
@@ -4772,6 +4781,14 @@ class Range:
     end: "Position" = attrs.field()
     """The range's end position."""
 
+    def __eq__(self, o: "Range") -> Union[bool, "NotImplemented"]:
+        if not isinstance(o, Range):
+            return NotImplemented
+        return (self.start == o.start) and (self.end == o.end)
+
+    def __repr__(self) -> str:
+        return f"{self.start!r}-{self.end!r}"
+
 
 @attrs.define
 class WorkspaceFoldersChangeEvent:
@@ -4826,6 +4843,7 @@ class Color:
 
 
 @attrs.define
+@functools.total_ordering
 class Position:
     """Position in a text document expressed as zero-based line and character
     offset. Prior to 3.17 the offsets were always based on a UTF-16 string
@@ -4876,6 +4894,19 @@ class Position:
     If the character value is greater than the line length it defaults back to the
     line length."""
 
+    def __eq__(self, o: "Position") -> Union[bool, "NotImplemented"]:
+        if not isinstance(o, Position):
+            return NotImplemented
+        return (self.line, self.character) == (o.line, o.character)
+
+    def __gt__(self, o: "Position") -> Union[bool, "NotImplemented"]:
+        if not isinstance(o, Position):
+            return NotImplemented
+        return (self.line, self.character) > (o.line, o.character)
+
+    def __repr__(self) -> str:
+        return f"{self.line}:{self.character}"
+
 
 @attrs.define
 class SemanticTokensEdit:
@@ -10473,9 +10504,9 @@ class ProgressNotification:
 
 @enum.unique
 class MessageDirection(enum.Enum):
-    ServerToClient = "serverToClient"
     Both = "both"
     ClientToServer = "clientToServer"
+    ServerToClient = "serverToClient"
 
 
 CALL_HIERARCHY_INCOMING_CALLS = "callHierarchy/incomingCalls"

noxfile.py

@@ -34,6 +34,10 @@ def _generate_model(session: nox.Session):
     session.run("pip", "list")
 
     session.run("python", "-m", "generator", "--output", "./lsprotocol/types.py")
+    session.run("isort", "--profile", "black", "./lsprotocol/types.py")
+    session.run("black", "./lsprotocol/types.py")
+    session.run("docformatter", "--in-place", "./lsprotocol/types.py")
+
     session.run("isort", "--profile", "black", "./lsprotocol")
     session.run("black", "./lsprotocol")
     session.run("docformatter", "--in-place", "--recursive", "./lsprotocol")

tests/requirements.txt

@@ -42,9 +42,9 @@ iniconfig==1.1.1 \
     --hash=sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3 \
     --hash=sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32
     # via pytest
-jsonschema==4.12.1 \
-    --hash=sha256:05f975aee3f1244a1ea0e018e8ad2672f6ca5fd1a28bc46ffc7d4b3e9896cac4 \
-    --hash=sha256:c7dd96a88c4ea60bdc8478589ee2d4ea5d73ab235e24d17641ad733dde4e3eb1
+jsonschema==4.13.0 \
+    --hash=sha256:3776512df4f53f74e6e28fe35717b5b223c1756875486984a31bc9165e7fc920 \
+    --hash=sha256:870a61bb45050b81103faf6a4be00a0a906e06636ffcf0b84f5a2e51faf901ff
     # via -r ./tests/requirements.in
 packaging==21.3 \
     --hash=sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb \

tests/test_location.py

@@ -0,0 +1,48 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import hamcrest
+import pytest
+
+from lsprotocol import types as lsp
+
+
+@pytest.mark.parametrize(
+    ("a", "b", "expected"),
+    [
+        (
+            lsp.Location(
+                "some_path", lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56))
+            ),
+            lsp.Location(
+                "some_path", lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56))
+            ),
+            True,
+        ),
+        (
+            lsp.Location(
+                "some_path", lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56))
+            ),
+            lsp.Location(
+                "some_path2", lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56))
+            ),
+            False,
+        ),
+        (
+            lsp.Location(
+                "some_path", lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56))
+            ),
+            lsp.Location(
+                "some_path", lsp.Range(lsp.Position(1, 23), lsp.Position(8, 91))
+            ),
+            False,
+        ),
+    ],
+)
+def test_location_equality(a, b, expected):
+    hamcrest.assert_that(a == b, hamcrest.is_(expected))
+
+
+def test_location_repr():
+    a = lsp.Location("some_path", lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56)))
+    hamcrest.assert_that(f"{a!r}", hamcrest.is_("some_path:1:23-4:56"))

tests/test_position.py

@@ -0,0 +1,49 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import hamcrest
+import pytest
+
+from lsprotocol import types as lsp
+
+
+@pytest.mark.parametrize(
+    ("a", "b", "comp", "expected"),
+    [
+        (lsp.Position(1, 10), lsp.Position(1, 10), "==", True),
+        (lsp.Position(1, 10), lsp.Position(1, 11), "==", False),
+        (lsp.Position(1, 10), lsp.Position(1, 11), "!=", True),
+        (lsp.Position(1, 10), lsp.Position(2, 20), "!=", True),
+        (lsp.Position(2, 10), lsp.Position(1, 10), ">", True),
+        (lsp.Position(2, 10), lsp.Position(1, 10), ">=", True),
+        (lsp.Position(1, 11), lsp.Position(1, 10), ">", True),
+        (lsp.Position(1, 11), lsp.Position(1, 10), ">=", True),
+        (lsp.Position(1, 10), lsp.Position(1, 10), ">=", True),
+        (lsp.Position(1, 10), lsp.Position(2, 10), "<", True),
+        (lsp.Position(1, 10), lsp.Position(2, 10), "<=", True),
+        (lsp.Position(1, 10), lsp.Position(1, 10), "<=", True),
+        (lsp.Position(1, 10), lsp.Position(1, 11), "<", True),
+        (lsp.Position(1, 10), lsp.Position(1, 11), "<=", True),
+    ],
+)
+def test_position_comparison(
+    a: lsp.Position, b: lsp.Position, comp: str, expected: bool
+):
+    if comp == "==":
+        result = a == b
+    elif comp == "!=":
+        result = a != b
+    elif comp == "<":
+        result = a < b
+    elif comp == "<=":
+        result = a <= b
+    elif comp == ">":
+        result = a > b
+    elif comp == ">=":
+        result = a >= b
+    hamcrest.assert_that(result, hamcrest.is_(expected))
+
+
+def test_position_repr():
+    p = lsp.Position(1, 23)
+    hamcrest.assert_that(f"{p!r}", hamcrest.is_("1:23"))

tests/test_range.py

@@ -0,0 +1,36 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import hamcrest
+import pytest
+
+from lsprotocol import types as lsp
+
+
+@pytest.mark.parametrize(
+    ("a", "b", "expected"),
+    [
+        (
+            lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56)),
+            lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56)),
+            True,
+        ),
+        (
+            lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56)),
+            lsp.Range(lsp.Position(1, 23), lsp.Position(4, 57)),
+            False,
+        ),
+        (
+            lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56)),
+            lsp.Range(lsp.Position(1, 23), lsp.Position(7, 56)),
+            False,
+        ),
+    ],
+)
+def test_range_equality(a, b, expected):
+    hamcrest.assert_that(a == b, hamcrest.is_(expected))
+
+
+def test_range_repr():
+    a = lsp.Range(lsp.Position(1, 23), lsp.Position(4, 56))
+    hamcrest.assert_that(f"{a!r}", hamcrest.is_("1:23-4:56"))