Add defaults to enable passing no arguments when creating a pygame.Font() (#1853)

undefined

Author: PurityLake

buildconfig/stubs/pygame/font.pyi

@@ -33,7 +33,7 @@ class Font:
     underline: bool
     strikethrough: bool
     align: int
-    def __init__(self, name: Optional[FileArg], size: int) -> None: ...
+    def __init__(self, filename: Optional[FileArg] = None, size: int = 20) -> None: ...
     def render(
         self,
         text: Union[str, bytes, None],

docs/reST/ref/font.rst

@@ -159,6 +159,7 @@ solves no longer exists, it will likely be removed in the future.
 .. class:: Font
 
    | :sl:`create a new Font object from a file`
+   | :sg:`Font(filename=None, size=20) -> Font`
    | :sg:`Font(filename, size) -> Font`
    | :sg:`Font(pathlib.Path, size) -> Font`
    | :sg:`Font(object, size) -> Font`
@@ -173,6 +174,9 @@ solves no longer exists, it will likely be removed in the future.
    render can emulate bold or italic features, but it is better to load from a
    font with actual italic or bold glyphs.
 
+   .. versionchanged:: 2.1.4 If no arguments are given then the default font will be used and
+      a font size of 20 is used.
+
    .. versionchanged:: 2.1.4 This class is also available through the ``pygame.Font``
       alias.
 

src_c/doc/font_doc.h

@@ -8,7 +8,7 @@
 #define DOC_PYGAMEFONTGETFONTS "get_fonts() -> list of strings\nget all available fonts"
 #define DOC_PYGAMEFONTMATCHFONT "match_font(name, bold=False, italic=False) -> path\nfind a specific font on the system"
 #define DOC_PYGAMEFONTSYSFONT "SysFont(name, size, bold=False, italic=False) -> Font\ncreate a Font object from the system fonts"
-#define DOC_PYGAMEFONTFONT "Font(filename, size) -> Font\nFont(pathlib.Path, size) -> Font\nFont(object, size) -> Font\ncreate a new Font object from a file"
+#define DOC_PYGAMEFONTFONT "Font(filename=None, size=20) -> Font\nFont(filename, size) -> Font\nFont(pathlib.Path, size) -> Font\nFont(object, size) -> Font\ncreate a new Font object from a file"
 #define DOC_FONTBOLD "bold -> bool\nGets or sets whether the font should be rendered in (faked) bold."
 #define DOC_FONTITALIC "italic -> bool\nGets or sets whether the font should be rendered in (faked) italics."
 #define DOC_FONTUNDERLINE "underline -> bool\nGets or sets whether the font should be rendered with an underline."
@@ -73,6 +73,7 @@ pygame.font.SysFont
 create a Font object from the system fonts
 
 pygame.font.Font
+ Font(filename=None, size=20) -> Font
  Font(filename, size) -> Font
  Font(pathlib.Path, size) -> Font
  Font(object, size) -> Font

src_c/font.c

@@ -71,6 +71,7 @@ static const char pkgdatamodule_name[] = "pygame.pkgdata";
 static const char resourcefunc_name[] = "getResource";
 #endif
 static const char font_defaultname[] = "freesansbold.ttf";
+static const int font_defaultsize = 20;
 
 #ifndef SDL_TTF_VERSION_ATLEAST
 /**
@@ -889,13 +890,16 @@ font_dealloc(PyFontObject *self)
 static int
 font_init(PyFontObject *self, PyObject *args, PyObject *kwds)
 {
-    int fontsize;
+    int fontsize = font_defaultsize;
     TTF_Font *font = NULL;
-    PyObject *obj;
+    PyObject *obj = Py_None;
     SDL_RWops *rw;
 
+    static char *kwlist[] = {"filename", "size", NULL};
+
     self->font = NULL;
-    if (!PyArg_ParseTuple(args, "Oi", &obj, &fontsize)) {
+    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi", kwlist, &obj,
+                                     &fontsize)) {
         return -1;
     }
 

src_py/ftfont.py

@@ -34,7 +34,7 @@ class Font(_Font):
     __unull = "\x00"
     __bnull = b"\x00"
 
-    def __init__(self, file, size=-1):
+    def __init__(self, file=None, size=20):
         size = max(size, 1)
         if isinstance(file, str):
             try:

test/font_test.py

@@ -299,6 +299,9 @@ def setUp(self):
     def tearDown(self):
         pygame_font.quit()
 
+    def test_default_parameters(self):
+        f = pygame_font.Font()
+
     def test_font_alias(self):
         """Check if pygame.Font is present and the correct type."""
         self.assertIs(pygame.Font, pygame.font.Font)
@@ -561,12 +564,27 @@ def test_load_from_file(self):
         )
         f = pygame_font.Font(font_path, 20)
 
+    def test_load_from_file_default(self):
+        font_name = pygame_font.get_default_font()
+        font_path = os.path.join(
+            os.path.split(pygame.__file__)[0], pygame_font.get_default_font()
+        )
+        f = pygame_font.Font(font_path)
+
     def test_load_from_pathlib(self):
         font_name = pygame_font.get_default_font()
         font_path = os.path.join(
             os.path.split(pygame.__file__)[0], pygame_font.get_default_font()
         )
         f = pygame_font.Font(pathlib.Path(font_path), 20)
+        f = pygame_font.Font(pathlib.Path(font_path))
+
+    def test_load_from_pathlib_default(self):
+        font_name = pygame_font.get_default_font()
+        font_path = os.path.join(
+            os.path.split(pygame.__file__)[0], pygame_font.get_default_font()
+        )
+        f = pygame_font.Font(pathlib.Path(font_path))
 
     def test_load_from_file_obj(self):
         font_name = pygame_font.get_default_font()
@@ -576,11 +594,24 @@ def test_load_from_file_obj(self):
         with open(font_path, "rb") as f:
             font = pygame_font.Font(f, 20)
 
+    def test_load_from_file_obj_default(self):
+        font_name = pygame_font.get_default_font()
+        font_path = os.path.join(
+            os.path.split(pygame.__file__)[0], pygame_font.get_default_font()
+        )
+        with open(font_path, "rb") as f:
+            font = pygame_font.Font(f)
+
     def test_load_default_font_filename(self):
         # In font_init, a special case is when the filename argument is
         # identical to the default font file name.
         f = pygame_font.Font(pygame_font.get_default_font(), 20)
 
+    def test_load_default_font_filename_default(self):
+        # In font_init, a special case is when the filename argument is
+        # identical to the default font file name.
+        f = pygame_font.Font(pygame_font.get_default_font())
+
     def _load_unicode(self, path):
         import shutil