os.utime() mishandles some arguments

[Arfrever]

BPO	15382
Nosy	@vstinner, @larryhastings, @serwy, @serhiy-storchaka, @corona10
Files	issue15382.patch issue15382_rev1.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-09-07.09:45:24.708>
created_at = <Date 2012-07-17.21:02:38.246>
labels = ['type-bug', 'library']
title = 'os.utime() mishandles some arguments'
updated_at = <Date 2019-09-09.09:01:47.912>
user = 'https://bugs.python.org/Arfrever'

bugs.python.org fields:

activity = <Date 2019-09-09.09:01:47.912>
actor = 'vstinner'
assignee = 'none'
closed = True
closed_date = <Date 2019-09-07.09:45:24.708>
closer = 'serhiy.storchaka'
components = ['Library (Lib)']
creation = <Date 2012-07-17.21:02:38.246>
creator = 'Arfrever'
dependencies = []
files = ['26421', '26423']
hgrepos = []
issue_num = 15382
keywords = ['patch']
message_count = 8.0
messages = ['165730', '165733', '165734', '165736', '351279', '351298', '351365', '351366']
nosy_count = 6.0
nosy_names = ['vstinner', 'larry', 'roger.serwy', 'Arfrever', 'serhiy.storchaka', 'corona10']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue15382'
versions = ['Python 3.3']

[Arfrever]

Contrarily to documentation:

1. os.utime() accepts a tuple with floats passed by ns argument:
>>> os.utime(file, ns=(0.5, 0.5))
>>>

2. os.utime() does not accept explicit ns=None:
>>> os.utime(file, times=None)
>>> os.utime(file, ns=None)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: utime: 'ns' must be a tuple of two ints
>>>

3. os.utime() does not accept both times and ns when only times is a tuple:
>>> os.utime(file, times=None, ns=(0, 0))
>>> os.utime(file, times=(0, 0), ns=None)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: utime: you may specify either 'times' or 'ns' but not both
>>>

[serwy]

Attached is a preliminary patch to check ns != Py_None.

[vstinner]

@serwy: can you please write a test for your patch?

[serwy]

_rev1 has a basic test. Is it sufficient?

[corona10]

@vstinner
This issue is not solved yet.
Can I finalize this issue?

[serhiy-storchaka]

The documentation issue was fixed in bpo-23738. The documentation no longer claims that ns can be None. If specified it must be a tuple of floats.

[vstinner]

The documentation issue was fixed in bpo-23738. The documentation no longer claims that ns can be None. If specified it must be a tuple of floats.

tuple of integers, not tuple a floats.

Python 3.9 documentation says: "If ns is specified, it must be a 2-tuple of the form (atime_ns, mtime_ns) where each member is an int expressing nanoseconds." which is correct.

Python 3.9 now emits a DeprecationWarning when passing floats:

vstinner@apu$ ./python
Python 3.9.0a0 (heads/pr/15701-dirty:a0f335c74c, Sep  6 2019, 17:38:14) 
>>> import os
>>> os.utime("x", ns=(1, 1))
>>> os.utime("x", ns=(0.1, 1))
<stdin>:1: DeprecationWarning: an integer is required (got type float).  Implicit conversion to integers using __int__ is deprecated, and may be removed in a future version of Python.

[vstinner]

By the way, error messages are now also correct:

>>> os.utime("x", ns=None)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: utime: 'ns' must be a tuple of two ints

>>> os.utime("x", times=(0, 0), ns=None)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: utime: you may specify either 'times' or 'ns' but not both