bpo-35702: Add new identifier CLOCK_UPTIME_RAW for Darwin #11503

nanjekyejoannah · 2019-01-10T13:56:29Z

I have added a clock constant, CLOCK_UPTIME_RAW for Darwin.

https://bugs.python.org/issue35702

vstinner

Would you mind to mention the new constant in Doc/whatsnew/3.8.rst? Follow this example:

https://docs.python.org/dev/whatsnew/3.7.html#time

vstinner · 2019-01-10T14:19:26Z

Doc/library/time.rst

+
+   Clock that increments monotonically, tracking the time since an arbitrary 
+   point, unaffected by frequency or time adjustments and not increment while 
+   the system is asleep.


LGTM. FYI http://www.manpagez.com/man/3/clock_gettime/ has a different definition:

CLOCK_UPTIME_RAW clock that increments monotonically, in the same man- ner as CLOCK_MONOTONIC_RAW, but that does not incre- ment while the system is asleep. The returned value is identical to the result of mach_absolute_time() after the appropriate mach_timebase conversion is applied.

hmmm... is the current short version better or we use the description in the man page?

The short version is fine. The longer version doesn't add anything useful and is too low-level.

vstinner · 2019-01-10T14:20:05Z

Doc/library/time.rst

+   point, unaffected by frequency or time adjustments and not increment while 
+   the system is asleep.
+
+   .. availability:: Unix.


Unix is vague. I suggest to be more precise:

Suggested change

.. availability:: Unix.

.. availability:: macOS 10.12 and newer.

vstinner · 2019-01-10T14:20:24Z

Doc/library/time.rst

+
+   .. availability:: Unix.
+
+   .. versionadded:: 3.7


I would prefer to only add the constant to the master branch which is the future Python 3.8.

Suggested change

.. versionadded:: 3.7

.. versionadded:: 3.8

bedevere-bot · 2019-01-10T14:21:49Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

…nah/cpython into add_clock_constants

vstinner

Ah good, your PR now looks better. Can please also mention the change in the What's New in Python 3.8? (see my previous comment)

vstinner · 2019-01-10T15:01:11Z

Misc/NEWS.d/next/Library/2019-01-10-14-03-12.bpo-35702._ct_0H.rst

@@ -0,0 +1 @@
+The CLOCK_UPTIME_RAW constant is now available for Darwin.


Suggested change

The CLOCK_UPTIME_RAW constant is now available for Darwin.

The :data:`time.CLOCK_UPTIME_RAW` constant is now available for macOS 10.12.

vstinner · 2019-01-10T15:13:14Z

Doc/library/time.rst

+.. data:: CLOCK_UPTIME_RAW
+
+   Clock that increments monotonically, tracking the time since an arbitrary 
+   point, unaffected by frequency or time adjustments and not increment while 


(English is not my first language.) English question: is "not increment while..." correct? Or should it be "not incremented" as in "unaffected"?

vstinner · 2019-01-10T15:14:08Z

Doc/whatsnew/3.8.rst

+time
+-------
+
+Added a new clock identifier `~time.CLOCK_UPTIME_RAW` for Darwin that increments


Darwin is correct, but I prefer "macOS" since this name is more commonly used than Darwin (in my experience).

vstinner · 2019-01-10T15:31:39Z

Doc/whatsnew/3.8.rst

+Added new clock :data:`~time.CLOCK_UPTIME_RAW` for macOS 10.12 that 
+increments monotonically, tracking the time since an arbitrary point, 
+unaffected by frequency or time adjustments and not incremented while the 
+system is asleep.


I would prefer just "Added new clock :data:~time.CLOCK_UPTIME_RAW for macOS 10.12." Since the doc generates a link to the doc, there is no need to repeat the constant documentation.

vstinner

Almost good! Just a few final comments.

vstinner · 2019-01-10T15:31:50Z

Doc/whatsnew/3.8.rst

+increments monotonically, tracking the time since an arbitrary point, 
+unaffected by frequency or time adjustments and not incremented while the 
+system is asleep.
+(Contributed by Ricardo Fraile in :issue:`35702`.)


It should be your name here :-)

ohh..I thought the issue author. Noted.

No problem. Sometimes it's the same person :-)

vstinner

LGTM. Thanks ;-)

Note: I'm mentoring @nanjekyejoannah and I'm fine with her doing small commits, since all commits are squashed into a single commit on merge ;-)

vstinner · 2019-01-10T16:56:53Z

Thanks @nanjekyejoannah, I merged your PR.

Add new identifier CLOCK_UPTIME_RAW for Darwin

c4c7bb9

the-knights-who-say-ni added the CLA signed label Jan 10, 2019

bedevere-bot added the awaiting review label Jan 10, 2019

blurb-it bot and others added 3 commits January 10, 2019 14:03

📜🤖 Added by blurb_it.

0da5d85

fix white space in documentation

385ae35

fix white space in documentation

ba7b629

vstinner requested changes Jan 10, 2019

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting review labels Jan 10, 2019

nanjekyejoannah and others added 4 commits January 10, 2019 17:26

Merge branch 'add_clock_constants' of https://github.com/nanjekyejoan…

81dca18

…nah/cpython into add_clock_constants

correct availability and version information in doc

b77bcc4

fix white space error

5b57636

mention the new constant in Doc/whatsnew/3.8.rst

68b08b9

vstinner reviewed Jan 10, 2019

View reviewed changes

nanjekyejoannah added 2 commits January 10, 2019 18:18

grammar edits for docs

4ea49c7

fix white space issues

6d6a15a

vstinner reviewed Jan 10, 2019

View reviewed changes

change contributor

c2f50a6

vstinner approved these changes Jan 10, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Jan 10, 2019

vstinner merged commit 572168a into python:master Jan 10, 2019

bedevere-bot removed the awaiting merge label Jan 10, 2019

nanjekyejoannah deleted the add_clock_constants branch January 11, 2019 09:49

	.. availability:: Unix.
	.. availability:: macOS 10.12 and newer.

		@@ -0,0 +1 @@
		The CLOCK_UPTIME_RAW constant is now available for Darwin.

	The CLOCK_UPTIME_RAW constant is now available for Darwin.
	The :data:`time.CLOCK_UPTIME_RAW` constant is now available for macOS 10.12.

Uh oh!

bpo-35702: Add new identifier CLOCK_UPTIME_RAW for Darwin #11503

bpo-35702: Add new identifier CLOCK_UPTIME_RAW for Darwin #11503

Uh oh!

Conversation

nanjekyejoannah commented Jan 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bedevere-bot commented Jan 10, 2019

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

vstinner commented Jan 10, 2019

Uh oh!

Uh oh!

nanjekyejoannah commented Jan 10, 2019 •

edited

Loading