make flags a keyword parameter

python · vstinner · Oct 7, 2023 · Aug 8, 2023 · Aug 23, 2023 · Aug 23, 2023
commit 5aba21f42906330501abc8a4786388b938a4a319
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
@@ -3781,7 +3781,7 @@ features:
    .. versionadded:: 3.10
 
 
-.. function:: timerfd_create(clockid, /, *, flags)
+.. function:: timerfd_create(clockid, /, *, flags=0)
 
    Create and return a timer file descriptor (*timerfd*).
 
@@ -3924,7 +3924,7 @@ features:
    .. versionadded:: 3.13
 
 
-.. function:: timerfd_settime(fd, flags=0, /, *, initial=0.0, interval=0.0)
+.. function:: timerfd_settime(fd, /, *, flags=flags, initial=0.0, interval=0.0)
 
    Alter a timer file descriptor's internal timer.
    This function operates the same interval timer as :func:`timerfd_settime_ns`.
@@ -3998,7 +3998,7 @@ features:
    .. versionadded:: 3.13
 
 
-.. function:: timerfd_settime_ns(fd, flags=0, /, *, initial=0, interval=0)
+.. function:: timerfd_settime_ns(fd, /, *, flags=0, initial=0, interval=0)
 
    Similar to :func:`timerfd_settime`, but use time as nanoseconds.
    This function operates the same interval timer as :func:`timerfd_settime`.

diff --git a/Lib/test/test_os.py b/Lib/test/test_os.py
@@ -3950,7 +3950,7 @@ def test_timerfd_initval(self):
 
     def test_timerfd_non_blocking(self):
         size = 8  # read 8 bytes
-        fd = os.timerfd_create(time.CLOCK_REALTIME, os.TFD_NONBLOCK)
+        fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
         self.assertNotEqual(fd, -1)
         self.addCleanup(os.close, fd)
 
@@ -3969,13 +3969,13 @@ def test_timerfd_negative(self):
             for flags in (0, os.TFD_TIMER_ABSTIME, os.TFD_TIMER_ABSTIME|os.TFD_TIMER_CANCEL_ON_SET):
                 with self.subTest(flags=flags, initial=initial, interval=interval):
                     with self.assertRaises(OSError) as context:
-                        _, _ = os.timerfd_settime(fd, flags, initial=initial, interval=interval)
+                        _, _ = os.timerfd_settime(fd, flags=flags, initial=initial, interval=interval)
                     self.assertEqual(context.exception.errno, errno.EINVAL)
 
                     with self.assertRaises(OSError) as context:
                         initial_ns = int( (10**9) * initial )
                         interval_ns = int( (10**9) * interval )
-                        _, _ = os.timerfd_settime_ns(fd, flags, initial=initial_ns, interval=interval_ns)
+                        _, _ = os.timerfd_settime_ns(fd, flags=flags, initial=initial_ns, interval=interval_ns)
                     self.assertEqual(context.exception.errno, errno.EINVAL)
 
     def test_timerfd_interval(self):
@@ -4027,7 +4027,7 @@ def test_timerfd_TFD_TIMER_ABSTIME(self):
         # not interval timer
         interval = 0
 
-        _, _ = os.timerfd_settime(fd, os.TFD_TIMER_ABSTIME, initial=initial_expiration, interval=interval)
+        _, _ = os.timerfd_settime(fd, flags=os.TFD_TIMER_ABSTIME, initial=initial_expiration, interval=interval)
 
         # timerfd_gettime
         # Note: timerfd_gettime returns relative values even if TFD_TIMER_ABSTIME is specified.
@@ -4045,7 +4045,7 @@ def test_timerfd_TFD_TIMER_ABSTIME(self):
 
     def test_timerfd_select(self):
         size = 8  # read 8 bytes
-        fd = os.timerfd_create(time.CLOCK_REALTIME, os.TFD_NONBLOCK)
+        fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
         self.assertNotEqual(fd, -1)
         self.addCleanup(os.close, fd)
 
@@ -4074,7 +4074,7 @@ def test_timerfd_select(self):
 
     def test_timerfd_epoll(self):
         size = 8  # read 8 bytes
-        fd = os.timerfd_create(time.CLOCK_REALTIME, os.TFD_NONBLOCK)
+        fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
         self.assertNotEqual(fd, -1)
         self.addCleanup(os.close, fd)
 
@@ -4190,7 +4190,7 @@ def test_timerfd_ns_TFD_TIMER_ABSTIME(self):
         # not interval timer
         interval_ns = 0
 
-        _, _ = os.timerfd_settime_ns(fd, os.TFD_TIMER_ABSTIME, initial=initial_expiration_ns, interval=interval_ns)
+        _, _ = os.timerfd_settime_ns(fd, flags=os.TFD_TIMER_ABSTIME, initial=initial_expiration_ns, interval=interval_ns)
 
         # timerfd_gettime
         # Note: timerfd_gettime returns relative values even if TFD_TIMER_ABSTIME is specified.
@@ -4210,7 +4210,7 @@ def test_timerfd_ns_select(self):
         size = 8  # read 8 bytes
         one_sec_in_nsec = 10**9
 
-        fd = os.timerfd_create(time.CLOCK_REALTIME, os.TFD_NONBLOCK)
+        fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
         self.assertNotEqual(fd, -1)
         self.addCleanup(os.close, fd)
 
@@ -4240,7 +4240,7 @@ def test_timerfd_ns_select(self):
     def test_timerfd_ns_epoll(self):
         size = 8  # read 8 bytes
         one_sec_in_nsec = 10**9
-        fd = os.timerfd_create(time.CLOCK_REALTIME, os.TFD_NONBLOCK)
+        fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
         self.assertNotEqual(fd, -1)
         self.addCleanup(os.close, fd)
 

diff --git a/Modules/clinic/posixmodule.c.h b/Modules/clinic/posixmodule.c.h
diff --git a/Modules/posixmodule.c b/Modules/posixmodule.c
@@ -10136,6 +10136,8 @@ os.timerfd_create
         time.CLOCK_BOOTTIME
            Same as time.CLOCK_MONOTONIC except that it inclues any time that
            the system is suspended.
+    /
+    *
     flags: int = 0
         0 or a bit mask of os.TFD_NONBLOCK or os.TFD_CLOEXEC.
 
@@ -10145,14 +10147,13 @@ os.timerfd_create
 
         os.TFD_CLOEXEC
             If *TFD_CLOEXEC* is set as a flag, enable the close-on-exec flag
-    /
 
 Create and return a timer file descriptor.
 [clinic start generated code]*/
 
 static PyObject *
 os_timerfd_create_impl(PyObject *module, int clockid, int flags)
-/*[clinic end generated code: output=1caae80fb168004a input=0d6b3fdd3ff34dc3]*/
+/*[clinic end generated code: output=1caae80fb168004a input=f23bfa49fc4b6576]*/
 
 {
     int fd;
@@ -10170,10 +10171,10 @@ os.timerfd_settime
 
     fd: fildes
         A timer file descriptor.
-    flags: int = 0
-        0 or a bit mask of TFD_TIMER_ABSTIME or TFD_TIMER_CANCEL_ON_SET.
     /
     *
+    flags: int = 0
+        0 or a bit mask of TFD_TIMER_ABSTIME or TFD_TIMER_CANCEL_ON_SET.
     initial: double = 0.0
         The initial expiration time, in seconds.
 
@@ -10193,7 +10194,7 @@ Alter a timer file descriptor's internal timer in seconds.
 static PyObject *
 os_timerfd_settime_impl(PyObject *module, int fd, int flags, double initial,
                         double interval)
-/*[clinic end generated code: output=0dda31115317adb9 input=af8570ae7e9835d2]*/
+/*[clinic end generated code: output=0dda31115317adb9 input=436a433c2c9664f0]*/
 {
     struct itimerspec new_value;
     struct itimerspec old_value;
@@ -10217,10 +10218,10 @@ os.timerfd_settime_ns
 
     fd: fildes
         A timer file descriptor.
-    flags: int = 0
-        0 or a bit mask of TFD_TIMER_ABSTIME or TFD_TIMER_CANCEL_ON_SET.
     /
     *
+    flags: int = 0
+        0 or a bit mask of TFD_TIMER_ABSTIME or TFD_TIMER_CANCEL_ON_SET.
     initial: long_long = 0
         initial expiration timing in seconds.
 
@@ -10240,7 +10241,7 @@ Alter a timer file descriptor's internal timer in nanoseconds.
 static PyObject *
 os_timerfd_settime_ns_impl(PyObject *module, int fd, int flags,
                            long long initial, long long interval)
-/*[clinic end generated code: output=6273ec7d7b4cc0b3 input=b351df41eb72128e]*/
+/*[clinic end generated code: output=6273ec7d7b4cc0b3 input=81eb655e9802cb05]*/
 {
     struct itimerspec new_value;
     struct itimerspec old_value;