Rename s/get_screensaver_enabled to s/get_allow_screensaver

buildconfig/pygame-stubs/display.pyi

@@ -77,5 +77,5 @@ def get_caption() -> Tuple[str, str]: ...
 def set_palette(palette: Sequence[_ColorValue]) -> None: ...
 def get_num_displays() -> int: ...
 def get_window_size() -> Tuple[int, int]: ...
-def get_screensaver_enabled() -> bool: ...
-def set_screensaver_enabled(value: bool) -> None: ...
+def get_allow_screensaver() -> bool: ...
+def set_allow_screensaver(value: bool) -> None: ...

docs/reST/ref/display.rst

@@ -571,35 +571,35 @@ required).
 
    .. ## pygame.display.get_window_size ##
 
-.. function:: get_screensaver_enabled
+.. function:: get_allow_screensaver
 
-   | :sl:`Return whether pygame is hinted to enable or disable the screensaver.`
-   | :sg:`get_screensaver_enabled() -> bool`
+   | :sl:`Return whether the screensaver is allowed to run.`
+   | :sg:`get_allow_screensaver() -> bool`
 
    Return whether screensaver is allowed to run whilst the app is running.
    Default is False.
    By default pygame does not allow the screensaver during game play.
 
    .. note:: Some platforms do not have a screensaver or support
              disabling the screensaver.  Please see
-             :func:`pygame.display.set_screensaver_enabled()` for
+             :func:`pygame.display.set_allow_screensaver()` for
              caveats with screensaver support.
 
    .. versionadded:: 2.0
 
-   .. ## pygame.display.get_screensaver_enabled ##
+   .. ## pygame.display.get_allow_screensaver ##
 
-.. function:: set_screensaver_enabled
+.. function:: set_allow_screensaver
 
-   | :sl:`Change request state for whether screensaver may run`
-   | :sg:`set_screensaver_enabled(bool) -> None`
+   | :sl:`Set whether the screensaver may run`
+   | :sg:`set_allow_screensaver(bool) -> None`
 
    Change whether screensavers should be allowed whilst the app is running.
    The default is False.
    By default pygame does not allow the screensaver during game play.
 
-   If the screensaver has been disabled due to this function, it will automatically
-   be re-enabled when :func:``pygame.quit()` is called.
+   If the screensaver has been disallowed due to this function, it will automatically
+   be allowed to run when :func:`pygame.quit()` is called.
 
    It is possible to influence the default value via the environment variable
    ``SDL_HINT_VIDEO_ALLOW_SCREENSAVER``, which can be set to either ``0`` (disable)
@@ -617,6 +617,6 @@ required).
    .. versionadded:: 2.0
 
 
-   .. ## pygame.display.set_screensaver_enabled ##
+   .. ## pygame.display.set_allow_screensaver ##
 
 .. ## pygame.display ##

src_c/display.c

@@ -2860,12 +2860,12 @@ pg_toggle_fullscreen(PyObject *self, PyObject *args)
 
 
 static PyObject *
-pg_get_screensaver_enabled(PyObject *self) {
+pg_get_allow_screensaver(PyObject *self) {
     /* SDL_IsScreenSaverEnabled() unconditionally returns SDL_True if
      * the video system is not initialized.  Therefore we insist on
      * the video being initialized before calling it.
      */
-    VIDEO_INIT_CHECK();
+   VIDEO_INIT_CHECK();
 #if IS_SDLv2
     return PyBool_FromLong(SDL_IsScreenSaverEnabled() == SDL_TRUE);
 #else /* IS_SDLv1*/
@@ -2874,11 +2874,11 @@ pg_get_screensaver_enabled(PyObject *self) {
 }
 
 static PyObject *
-pg_set_screensaver_enabled(PyObject *self, PyObject *arg, PyObject *kwds) {
-    int val = 0;
+pg_set_allow_screensaver(PyObject *self, PyObject *arg, PyObject *kwargs) {
+    int val = 1;
     static char *keywords[] = {"value", NULL};
 
-    if (!PyArg_ParseTupleAndKeywords(arg, kwds, "i", keywords, val)) {
+    if (!PyArg_ParseTupleAndKeywords(arg, kwargs, "|i", keywords, &val)) {
         return NULL;
     }
 
@@ -2957,12 +2957,10 @@ static PyMethodDef _pg_display_methods[] = {
     {"gl_get_attribute", pg_gl_get_attribute, METH_VARARGS,
      DOC_PYGAMEDISPLAYGLGETATTRIBUTE},
 
-    {"get_screensaver_enabled", (PyCFunction)pg_get_screensaver_enabled,
-     METH_NOARGS,
-     DOC_PYGAMEDISPLAYGETSCREENSAVERENABLED},
-    {"set_screensaver_enabled", (PyCFunction)pg_set_screensaver_enabled,
-     METH_VARARGS | METH_KEYWORDS,
-     DOC_PYGAMEDISPLAYSETSCREENSAVERENABLED},
+    {"get_allow_screensaver", (PyCFunction)pg_get_allow_screensaver, METH_NOARGS,
+     DOC_PYGAMEDISPLAYGETALLOWSCREENSAVER},
+    {"set_allow_screensaver", (PyCFunction)pg_set_allow_screensaver, METH_VARARGS | METH_KEYWORDS,
+     DOC_PYGAMEDISPLAYSETALLOWSCREENSAVER},
 
     {NULL, NULL, 0, NULL}};
 

src_c/doc/display_doc.h

@@ -25,8 +25,8 @@
 #define DOC_PYGAMEDISPLAYSETPALETTE "set_palette(palette=None) -> None\nSet the display color palette for indexed displays"
 #define DOC_PYGAMEDISPLAYGETNUMDISPLAYS "get_num_displays() -> int\nReturn the number of displays"
 #define DOC_PYGAMEDISPLAYGETWINDOWSIZE "get_window_size() -> tuple\nReturn the size of the window or screen"
-#define DOC_PYGAMEDISPLAYGETSCREENSAVERENABLED "get_screensaver_enabled() -> bool\nReturn whether pygame is hinted to enable or disable the screensaver."
-#define DOC_PYGAMEDISPLAYSETSCREENSAVERENABLED "set_screensaver_enabled(bool) -> None\nChange request state for whether screensaver may run"
+#define DOC_PYGAMEDISPLAYGETALLOWSCREENSAVER "get_allow_screensaver() -> bool\nReturn whether the screensaver is allowed to run."
+#define DOC_PYGAMEDISPLAYSETALLOWSCREENSAVER "set_allow_screensaver(bool) -> None\nSet whether the screensaver may run"
 
 
 /* Docs in a comment... slightly easier to read. */
@@ -137,12 +137,12 @@ pygame.display.get_window_size
  get_window_size() -> tuple
 Return the size of the window or screen
 
-pygame.display.get_screensaver_enabled
- get_screensaver_enabled() -> bool
-Return whether pygame is hinted to enable or disable the screensaver.
+pygame.display.get_allow_screensaver
+ get_allow_screensaver() -> bool
+Return whether the screensaver is allowed to run.
 
-pygame.display.set_screensaver_enabled
- set_screensaver_enabled(bool) -> None
-Change request state for whether screensaver may run
+pygame.display.set_allow_screensaver
+ set_allow_screensaver(bool) -> None
+Set whether the screensaver may run
 
 */

test/display_test.py

@@ -374,10 +374,13 @@ def test_set_mode_scaled(self):
         )
 
     def test_screensaver_support(self):
-        pygame.display.set_screensaver_enabled(True)
-        self.assertTrue(pygame.display.get_screensaver_enabled())
-        pygame.display.set_screensaver_enabled(False)
-        self.assertFalse(pygame.display.get_screensaver_enabled())
+        pygame.display.set_allow_screensaver(True)
+        self.assertTrue(pygame.display.get_allow_screensaver())
+        pygame.display.set_allow_screensaver(False)
+        self.assertFalse(pygame.display.get_allow_screensaver())
+        pygame.display.set_allow_screensaver()
+        self.assertTrue(pygame.display.get_allow_screensaver())
+
 
     def todo_test_set_palette(self):