Removed Font outline getters/setters.

Preferring properties for new values.

Author: cherez

buildconfig/stubs/pygame/font.pyi

@@ -89,8 +89,6 @@ class Font:
     def set_direction(self, direction: int) -> None: ...
     def get_point_size(self) -> int: ...
     def set_point_size(self, val: int, /) -> None: ...
-    def get_outline(self) -> int: ...
-    def set_outline(self, val: int, /) -> None: ...
 
 @deprecated("Use `Font` instead (FontType is an old alias)")
 class FontType(Font): ...

docs/reST/ref/font.rst

@@ -579,32 +579,6 @@ solves no longer exists, it will likely be removed in the future.
 
       .. ## Font.get_point_size ##
 
-   .. method:: set_outline
-
-      | :sl:`set the outline value of the font`
-      | :sg:`set_outline(size, /) -> None`
-
-      Sets the outline value of the font.
-
-      .. note:: This is the same as the :attr:`outline` attribute.
-
-      .. versionadded:: 2.5.6
-
-      .. ## Font.set_outline ##
-
-   .. method:: get_outline
-
-      | :sl:`get the outline value of the font`
-      | :sg:`get_outline() -> int`
-
-      Returns the outline value of the font.
-
-      .. note:: This is the same as the :attr:`outline` attribute.
-
-      .. versionadded:: 2.5.6
-
-      .. ## Font.get_outline ##
-
    .. method:: get_ascent
 
       | :sl:`get the ascent of the font`

src_c/doc/font_doc.h

@@ -34,8 +34,6 @@
 #define DOC_FONT_FONT_GETHEIGHT "get_height() -> int\nget the height of the font"
 #define DOC_FONT_FONT_SETPOINTSIZE "set_point_size(size, /) -> None\nset the point size of the font"
 #define DOC_FONT_FONT_GETPOINTSIZE "get_point_size() -> int\nget the point size of the font"
-#define DOC_FONT_FONT_SETOUTLINE "set_outline(size, /) -> None\nset the outline value of the font"
-#define DOC_FONT_FONT_GETOUTLINE "get_outline() -> int\nget the outline value of the font"
 #define DOC_FONT_FONT_GETASCENT "get_ascent() -> int\nget the ascent of the font"
 #define DOC_FONT_FONT_GETDESCENT "get_descent() -> int\nget the descent of the font"
 #define DOC_FONT_FONT_SETSCRIPT "set_script(str, /) -> None\nset the script code for text shaping"

src_c/font.c

@@ -952,25 +952,6 @@ font_setter_outline(PyObject *self, PyObject *value, void *closure)
 #endif
 }
 
-static PyObject *
-font_get_outline(PyObject *self, PyObject *_null)
-{
-    /* logic is identical to the getter, aside from the closure in the
-     * signature */
-    return font_getter_outline(self, NULL);
-}
-
-static PyObject *
-font_set_outline(PyObject *self, PyObject *arg)
-{
-    /* logic is identical to the setter, but we need to massage the return type
-        from int to PyObject*) */
-    if (font_setter_outline(self, arg, NULL) < 0) {
-        return NULL;
-    }
-    Py_RETURN_NONE;
-}
-
 static PyObject *
 font_getter_name(PyObject *self, void *closure)
 {
@@ -1264,8 +1245,6 @@ static PyMethodDef font_methods[] = {
      DOC_FONT_FONT_GETSTRIKETHROUGH},
     {"set_strikethrough", font_set_strikethrough, METH_O,
      DOC_FONT_FONT_SETSTRIKETHROUGH},
-    {"get_outline", font_get_outline, METH_NOARGS, DOC_FONT_FONT_GETOUTLINE},
-    {"set_outline", font_set_outline, METH_O, DOC_FONT_FONT_SETOUTLINE},
     {"get_point_size", font_get_ptsize, METH_NOARGS,
      DOC_FONT_FONT_GETPOINTSIZE},
     {"set_point_size", font_set_ptsize, METH_O, DOC_FONT_FONT_SETPOINTSIZE},

test/font_test.py

@@ -742,45 +742,6 @@ def test_outline_property_stub(self):
         with self.assertRaises(pygame.error):
             _ = f.outline
 
-    @unittest.skipIf(
-        pygame.font.get_sdl_ttf_version() < (2, 0, 12),
-        "outlines were added in SDL_TTF 2.0.12",
-    )
-    def test_outline_method(self):
-        if pygame_font.__name__ == "pygame.ftfont":
-            return  # not a pygame.ftfont feature
-
-        pygame_font.init()
-        font_path = os.path.join(
-            os.path.split(pygame.__file__)[0], pygame_font.get_default_font()
-        )
-        f = pygame_font.Font(pathlib.Path(font_path), 25)
-
-        val0 = f.get_outline()
-        self.assertIsInstance(val0, int)
-        self.assertGreaterEqual(val0, 0)
-
-        f.set_outline(5)
-        self.assertEqual(5, f.get_outline())
-        self.assertRaises(ValueError, f.set_outline, -1)
-        self.assertRaises(TypeError, f.set_outline, "2")
-
-    @unittest.skipIf(
-        pygame.font.get_sdl_ttf_version() >= (2, 0, 12),
-        "outlines were added in SDL_TTF 2.0.12",
-    )
-    def test_outline_method_stub(self):
-        if pygame_font.__name__ == "pygame.ftfont":
-            return  # not a pygame.ftfont feature
-
-        pygame_font.init()
-        font_path = os.path.join(
-            os.path.split(pygame.__file__)[0], pygame_font.get_default_font()
-        )
-        f = pygame_font.Font(pathlib.Path(font_path), 25)
-
-        self.assertRaises(pygame.error, f.get_outline)
-        self.assertRaises(pygame.error, f.set_outline, 1)
 
     def test_font_name(self):
         f = pygame_font.Font(None, 20)
@@ -1031,13 +992,6 @@ def test_font_method_should_raise_exception_after_quit(self):
             skip_methods = set()
             version = pygame.font.get_sdl_ttf_version()
 
-            if version >= (2, 0, 12):
-                methods.append(("get_outline", ()))
-                methods.append(("set_outline", (2,)))
-            else:
-                skip_methods.add("get_outline")
-                skip_methods.add("set_outline")
-
             if version >= (2, 0, 18):
                 methods.append(("get_point_size", ()))
                 methods.append(("set_point_size", (34,)))
@@ -1239,7 +1193,7 @@ def query(
         f.set_underline(underline)
         f.set_strikethrough(strikethrough)
         if pygame.font.get_sdl_ttf_version() >= (2, 0, 12):
-            f.set_outline(outline)
+            f.outline = outline
         s = f.render(text, antialiase, (0, 0, 0))
         screen.blit(s, (offset, y))
         y += s.get_size()[1] + spacing
@@ -1248,7 +1202,7 @@ def query(
         f.set_underline(False)
         f.set_strikethrough(False)
         if pygame.font.get_sdl_ttf_version() >= (2, 0, 12):
-            f.set_outline(0)
+            f.outline = 0
         s = f.render("(some comparison text)", False, (0, 0, 0))
         screen.blit(s, (offset, y))
         pygame.display.flip()