Docs for uuid don't mention that uuid1 can repeat in some circumstances

[merelymoray]

BPO	33545
Nosy	@tirkarthi

^{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 = None
created_at = <Date 2018-05-16.17:32:45.837>
labels = ['type-feature', 'docs']
title = "Docs for uuid don't mention that uuid1 can repeat in some circumstances"
updated_at = <Date 2018-09-20.11:37:09.831>
user = 'https://bugs.python.org/merelymoray'

bugs.python.org fields:

activity = <Date 2018-09-20.11:37:09.831>
actor = 'xtreak'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-05-16.17:32:45.837>
creator = 'merelymoray'
dependencies = []
files = []
hgrepos = []
issue_num = 33545
keywords = []
message_count = 1.0
messages = ['316844']
nosy_count = 3.0
nosy_names = ['docs@python', 'merelymoray', 'xtreak']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33545'
versions = ['Python 3.6']

[merelymoray]

https://docs.python.org/3.6/library/uuid.html#uuid.UUID

uuid.uuid1(node=None, clock_seq=None)

Generate a UUID from a host ID, sequence number, and the current time. If node is not given, getnode() is used to obtain the hardware address. If clock_seq is given, it is used as the sequence number; otherwise a random 14-bit sequence number is chosen.

^^

This neglects to mention that if you call uuid1() in quick succession with no parameters, you can get a repeat uuid.

I had a bug because of this.

It would have been nice if the docs mentioned the fact directly.

It's only a sentence to add, and would have saved a lot of time.

[slateny]

There's now a paragraph near the top of the uuid page with some info on this:

Depending on support from the underlying platform, uuid1() may or may not return a “safe” UUID. ...

which was introduced by #138.