From 6acf0fe5a0f1573962cd14ff88435db94ce4a109 Mon Sep 17 00:00:00 2001 From: James Westman Date: Mon, 9 Dec 2024 18:59:25 -0600 Subject: [PATCH 1/3] tests: Test deprecations separately Libraries can add new deprecations, or the environment you're running the tests in might have old libraries where the things we test aren't deprecated yet. Move the deprecations test into its own module with its own code, so it can check library versions and skip the test if it won't work. --- blueprintcompiler/language/expression.py | 18 ++++ tests/sample_errors/deprecations.blp | 9 -- tests/sample_errors/deprecations.err | 1 - tests/test_deprecations.py | 110 +++++++++++++++++++++++ 4 files changed, 128 insertions(+), 10 deletions(-) delete mode 100644 tests/sample_errors/deprecations.blp delete mode 100644 tests/sample_errors/deprecations.err create mode 100644 tests/test_deprecations.py diff --git a/blueprintcompiler/language/expression.py b/blueprintcompiler/language/expression.py index 558392c..ae9c399 100644 --- a/blueprintcompiler/language/expression.py +++ b/blueprintcompiler/language/expression.py @@ -171,6 +171,24 @@ class LookupOp(InfixExpr): did_you_mean=(self.property_name, self.lhs.type.properties.keys()), ) + @validate("property") + def property_deprecated(self): + if self.lhs.type is None or not ( + isinstance(self.lhs.type, gir.Class) + or isinstance(self.lhs.type, gir.Interface) + ): + return + + if property := self.lhs.type.properties.get(self.property_name): + if property.deprecated: + hints = [] + if property.deprecated_doc: + hints.append(property.deprecated_doc) + raise DeprecatedWarning( + f"{property.signature} is deprecated", + hints=hints, + ) + class CastExpr(InfixExpr): grammar = [ diff --git a/tests/sample_errors/deprecations.blp b/tests/sample_errors/deprecations.blp deleted file mode 100644 index f67f002..0000000 --- a/tests/sample_errors/deprecations.blp +++ /dev/null @@ -1,9 +0,0 @@ -using Gtk 4.0; - -Dialog { - use-header-bar: 1; -} - -Window { - keys-changed => $on_window_keys_changed(); -} diff --git a/tests/sample_errors/deprecations.err b/tests/sample_errors/deprecations.err deleted file mode 100644 index e3abd61..0000000 --- a/tests/sample_errors/deprecations.err +++ /dev/null @@ -1 +0,0 @@ -3,1,6,Gtk.Dialog is deprecated \ No newline at end of file diff --git a/tests/test_deprecations.py b/tests/test_deprecations.py new file mode 100644 index 0000000..0ffe726 --- /dev/null +++ b/tests/test_deprecations.py @@ -0,0 +1,110 @@ +# test_samples.py +# +# Copyright 2024 James Westman +# +# This file is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation; either version 3 of the +# License, or (at your option) any later version. +# +# This file is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this program. If not, see . +# +# SPDX-License-Identifier: LGPL-3.0-or-later + + +import unittest + +import gi + +gi.require_version("Gtk", "4.0") +from gi.repository import Gtk + +from blueprintcompiler import parser, tokenizer +from blueprintcompiler.errors import DeprecatedWarning, PrintableError + +# Testing deprecation warnings requires special handling because libraries can add deprecations with new versions, +# causing tests to break if we're not careful. + + +class TestDeprecations(unittest.TestCase): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.gtkVersion = f"{Gtk.get_major_version()}.{Gtk.get_minor_version()}.{Gtk.get_micro_version()}" + + def assertDeprecation(self, blueprint: str, message: str): + try: + tokens = tokenizer.tokenize(blueprint) + _ast, errors, warnings = parser.parse(tokens) + + self.assertIsNone(errors) + self.assertEqual(len(warnings), 1) + self.assertIsInstance(warnings[0], DeprecatedWarning) + self.assertEqual(warnings[0].message, message) + except PrintableError as e: # pragma: no cover + e.pretty_print("", blueprint) + raise AssertionError() + + def test_class_deprecation(self): + if Gtk.check_version(4, 10, 0) is not None: + self.skipTest(f"Gtk.Dialog is not deprecated in GTK {self.gtkVersion}") + + blueprint = """ + using Gtk 4.0; + + Dialog { + use-header-bar: 1; + } + """ + message = "Gtk.Dialog is deprecated" + + self.assertDeprecation(blueprint, message) + + def test_property_deprecation(self): + self.skipTest( + "gobject-introspection does not currently write property deprecations to the typelib. See ." + ) + + if Gtk.check_version(4, 4, 0) is not None: + self.skipTest( + f"Gtk.DropTarget:drop is not deprecated in GTK {self.gtkVersion}" + ) + + blueprint = """ + using Gtk 4.0; + + $MyObject { + a: bind drop_target.drop; + } + + DropTarget drop_target { + } + """ + + message = "Gtk.DropTarget:drop is deprecated" + + self.assertDeprecation(blueprint, message) + + def test_signal_deprecation(self): + if Gtk.check_version(4, 10, 0) is not None: + self.skipTest( + f"Gtk.Window::keys-changed is not deprecated in GTK {self.gtkVersion}" + ) + + blueprint = """ + using Gtk 4.0; + + Window { + keys-changed => $handler(); + } + """ + + message = "signal Gtk.Window::keys-changed () is deprecated" + + self.assertDeprecation(blueprint, message) From 778a979714f8eecbbe47953be8b23b6f2fe5a752 Mon Sep 17 00:00:00 2001 From: Luoyayu Date: Sat, 7 Dec 2024 07:36:14 +0000 Subject: [PATCH 2/3] lsp: Fix format of JSON-RPC content part ending with \r\n --- blueprintcompiler/lsp.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/blueprintcompiler/lsp.py b/blueprintcompiler/lsp.py index 25b289f..0659154 100644 --- a/blueprintcompiler/lsp.py +++ b/blueprintcompiler/lsp.py @@ -149,7 +149,7 @@ class LanguageServer: def _send(self, data): data["jsonrpc"] = "2.0" - line = json.dumps(data, separators=(",", ":")) + "\r\n" + line = json.dumps(data, separators=(",", ":")) printerr("output: " + line) sys.stdout.write( f"Content-Length: {len(line.encode())}\r\nContent-Type: application/vscode-jsonrpc; charset=utf-8\r\n\r\n{line}" From ac70ea7403abebc895b3b60082842604156babfd Mon Sep 17 00:00:00 2001 From: Jordan Petridis Date: Wed, 13 Nov 2024 00:48:16 +0200 Subject: [PATCH 3/3] Port to libgirepository-2.0 pygobject 3.52 has switched [1] to using libgirepository-2.0 which comes from glib itself now, rather than the 1.0 which came from gobject-introspection. This means that it fails to load the incompatible "GIRepository 2.0" and thus must be ported to 3.0 (which is provided by libgirepository-2.0). Migration guide is here [2] [1]: https://gitlab.gnome.org/GNOME/pygobject/-/merge_requests/320 [2]: https://docs.gtk.org/girepository/migrating-gi.html This commit adds suppport for importing with "gi.require_version("GIRepository", "3.0") and falling back to the existing "GIRepository 2.0" if not found. --- blueprintcompiler/gir.py | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/blueprintcompiler/gir.py b/blueprintcompiler/gir.py index 30a5eaa..e54b849 100644 --- a/blueprintcompiler/gir.py +++ b/blueprintcompiler/gir.py @@ -24,8 +24,20 @@ from functools import cached_property import gi # type: ignore -gi.require_version("GIRepository", "2.0") -from gi.repository import GIRepository # type: ignore +try: + gi.require_version("GIRepository", "3.0") + from gi.repository import GIRepository # type: ignore + + _repo = GIRepository.Repository() +except ValueError: + # We can remove this once we can bump the minimum dependencies + # to glib 2.80 and pygobject 3.52 + # dependency('glib-2.0', version: '>= 2.80.0') + # dependency('girepository-2.0', version: '>= 2.80.0') + gi.require_version("GIRepository", "2.0") + from gi.repository import GIRepository # type: ignore + + _repo = GIRepository.Repository from . import typelib, xml_reader from .errors import CompileError, CompilerBugError @@ -42,7 +54,7 @@ def add_typelib_search_path(path: str): def get_namespace(namespace: str, version: str) -> "Namespace": - search_paths = [*GIRepository.Repository.get_search_path(), *_user_search_paths] + search_paths = [*_repo.get_search_path(), *_user_search_paths] filename = f"{namespace}-{version}.typelib" @@ -74,7 +86,7 @@ def get_available_namespaces() -> T.List[T.Tuple[str, str]]: return _available_namespaces search_paths: list[str] = [ - *GIRepository.Repository.get_search_path(), + *_repo.get_search_path(), *_user_search_paths, ]