Compare commits

...

5 commits

Author SHA1 Message Date
kotontrion
e07da3c339 flags: use nick instead of name 2024-12-18 17:46:26 +00:00
kotontrion
2ae41020ab Fix flag return value type 2024-12-18 17:46:26 +00:00
kotontrion
f48b840cfa compile: fix flag values
gtk builder does not support combining interger values with | in flags
properties, so the short names are used instead.
2024-12-18 17:46:26 +00:00
Luoyayu
778a979714 lsp: Fix format of JSON-RPC content part ending with \r\n 2024-12-10 01:27:28 +00:00
James Westman
6acf0fe5a0
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.
2024-12-09 19:06:10 -06:00
7 changed files with 132 additions and 14 deletions

View file

@ -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 = [

View file

@ -211,12 +211,12 @@ class Flag(AstNode):
return self.tokens["value"]
@property
def value(self) -> T.Optional[int]:
def value(self) -> T.Optional[str]:
type = self.context[ValueTypeCtx].value_type
if not isinstance(type, Enumeration):
return None
elif member := type.members.get(self.name):
return member.value
return member.nick
else:
return None

View file

@ -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}"

View file

@ -1,9 +0,0 @@
using Gtk 4.0;
Dialog {
use-header-bar: 1;
}
Window {
keys-changed => $on_window_keys_changed();
}

View file

@ -1 +0,0 @@
3,1,6,Gtk.Dialog is deprecated

View file

@ -7,7 +7,7 @@ corresponding .blp file and regenerate this file with blueprint-compiler.
<interface>
<requires lib="gtk" version="4.0"/>
<object class="GApplication">
<property name="flags">1|4</property>
<property name="flags">is-service|handles-open</property>
</object>
<object class="GtkEventControllerScroll">
<property name="flags">1</property>

110
tests/test_deprecations.py Normal file
View file

@ -0,0 +1,110 @@
# test_samples.py
#
# Copyright 2024 James Westman <james@jwestman.net>
#
# 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 <http://www.gnu.org/licenses/>.
#
# 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("<deprecations test>", 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 <https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/410>."
)
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)