Fixed #19463 -- Add UUIDField #2923

mjtamlyn · 2014-07-15T10:28:51Z

Added UUIDField. Not particularly complicated this one - no custom lookups or anything. Casts all values to uuid.UUID instances in python.

TODO:

More form field tests
Documentation

Squashed patch should be marked as fixing #19463.

timgraham · 2014-07-15T11:15:56Z

Sign in to view

+import uuid
+
+from django.core.exceptions import ValidationError
+from django import forms


I'd alphabetize this before 'django.core'

timgraham · 2014-07-15T11:19:59Z

Sign in to view

+.. class:: UUIDField(**options)
+
+    A field for storing universally unique identifiiers. Uses PostgreSQL's
+    built in ``uuid`` data type, and python's :class:`UUID <python:uuid.UUID>`


Python's
shorter: ":class:~python:uuid.UUID"

timgraham · 2014-07-15T11:21:34Z

Sign in to view

+class TestSaveLoad(TestCase):
+
+    def test_uuid_instance(self):
+        instance = UUIDModel(field=uuid.uuid4())


.objects.create()?

Not much difference either way I guess. The ArrayField tests were committed with it this way. .create() doesn't really do any magic so I can change them all if you like.

I think create() is cleaner, but I wouldn't change the others as part of this PR.

I'll leave it be for now and then add an extra commit later changing all the tests.

timgraham · 2014-07-15T11:24:29Z

Sign in to view

+
+    def test_invalid_uuid(self):
+        field = UUIDField()
+        with self.assertRaises(exceptions.ValidationError) as cm:


what does cm stand for?

context manager?

oh, I guess I'm more used to seeing as e for "exception". I see both are used in our tests; thanks.

timgraham · 2014-07-15T11:26:18Z

Sign in to view

+
+    def test_uuid_instance_ok(self):
+        field = UUIDField()
+        field.clean(uuid.uuid4(), None)  # no error


doesn't clean() return a valid you could check?

It returns the value, I'm not sure there's any benefit in checking it.

timgraham · 2014-07-15T11:26:40Z

LGTM.

akaariai · 2014-07-16T10:23:29Z

I don't feel that good about adding UUID field for PostgreSQL only - UUID field isn't at all postgresql specific feature. OTOH I do understand why you want to implement it as a PostgreSQL only feature.

Also, UUID field is almost always used as a primary key, so it should be tested as a primary key. The field should get an automatic value when saving a new object into the database (the value can be generated in Python).

I recall a random discussion some time ago on IRC about problems with custom UUID field and admin - if we add UUID field, it should work automatically in admin, too. Unfortunately I don't recall details about this discussion, it was likely about using UUID as a primary key in admin. Maybe we need some simple tests with UUID as primary key in admin?

akaariai · 2014-07-16T10:48:16Z

The simplest solution I can think of for getting automatically a new primary key UUID value when saving a new object is addition of a new method generate_new_pk_value(self, connection) to Field. Then, if it returns something not None, the return value is used as primary key value for the model when inserting a new model. Addition of the generated UUID to the model can be done in Model._save_table(), somewhere around "if not pk_set: fields = [f for f in fields ...].

schmitch · 2014-07-17T20:43:11Z

I wouldn't put that in contrib, too. When you look at the code you would see, that its not "that" hard to add to other databases. We would only changed the field based on the connection. Like postgresql uses the db_type uuid, while sqlite3 uses a char field, while mysql uses uuid, too. wouldn't be too hard since the uuid getting created in python and not in the database.

schinckel · 2014-07-19T12:02:57Z

Sign in to view

+from django.utils.translation import ugettext_lazy as _
+
+
+class UUIDField(six.with_metaclass(SubfieldBase, Field)):


I'd suggest an auto keyword to the __init__ for this field type.

Actually, the more I think about it, perhaps it should be even more aggressive:

def get_default(self): default = super(UUIDField, self).get_default() if not default and not self.null: default = uuid.uuid4() return default

That is, unless we are allowing NULL, always create a value.

Hmm. It occurs to me that if primary_key=True, and we do this, it would look like the object already exists in the database before it actually is saved.

Although, since postgres cannot create UUIDs, that's going to present a problem anyway.

Postges can create uuids, when installing the extension.
Am 19.07.2014 15:20 schrieb "Matthew Schinckel" notifications@github.com:

In django/contrib/postgres/fields/uuid_field.py:

@@ -0,0 +1,43 @@
+import uuid
+
+from django.contrib.postgres import forms
+from django.core.exceptions import ValidationError
+from django.db.models import Field, SubfieldBase
+from django.utils import six
+from django.utils.translation import ugettext_lazy as _
+
+
+class UUIDField(six.with_metaclass(SubfieldBase, Field)):

Hmm. It occurs to me that if primary_key=True, and we do this, it would
look like the object already exists in the database before it actually is
saved.

Although, since postgres cannot create UUIDs, that's going to present a
problem anyway.

—
Reply to this email directly or view it on GitHub
https://github.com/django/django/pull/2923/files#r15143651.

There is no justification to be this aggressive in the field definition. Making an auto-generating uuid is as simple as UUIDField(default=uuid.uuid4). This should probably be a documented pattern.

Yeah, I was wound up on the fact that my similar field was not setting the value correctly on a default, but I was doing something stupid. The default= is a better pattern (and is extensible to dates, etc).

mjtamlyn · 2014-07-24T09:22:23Z

Sign in to view

@@ -2199,3 +2202,48 @@ def to_python(self, value):
        if isinstance(value, six.text_type):
            return six.memoryview(b64decode(force_bytes(value)))
        return value
+
+
+class UUIDField(six.with_metaclass(SubfieldBase, Field)):


I don't honestly understand why this is the only field in here which needs SubfieldBase. I know I'm using to_python but there are other fields here that do so. Perhaps I need to tweak the contribute_to_class? Or is it not an issue?

My understanding of SubFieldBase is that all it does is call to_python whenever any value is assigned to the field.

Personally, I wish it were on DateField and friends: being able to pass ISO8601 formatted strings and have them be date/time objects immediately makes for neater test cases.

schinckel · 2014-07-24T09:39:49Z

django/db/models/fields/__init__.py

+                    code='invalid',
+                    params={'value': value},
+                )
+        return value


Related to comment above: if you passed a non-string value that is not a valid uuid, this would not change the value (or raise an exception), but an invalid string would raise an exception.

I think that's a little inconsistent: but I'm not sure if it's worth worrying about.

Would something like if value and not isinstance(value, uuid.UUID) be better?

mjtamlyn · 2014-07-24T09:52:26Z

I've added some tests and notes in the docs about UUIDField(primary_key=True, default=uuid4). I think this is a good enough pattern (and also allows the user to choose a different uuid function if they wish, or none if their application generates uuids client side always. I don't think any extra machinery other than default should be necessary.

As for the admin, I found a number of closed (fixed) tickets relating to non-integer primary keys. If we find any issues with this in the admin I'll happily resolve them.

mjtamlyn · 2014-07-24T09:57:22Z

@akaariai @timgraham further review would be appreciated.

claudep · 2014-07-24T19:33:11Z

Sign in to view

+        super(UUIDField, self).__init__(**kwargs)
+
+    def get_internal_type(self):
+        return "CharField"


Marc, did you try to store by default in a binary column? AFAIK PostgreSQL is using a binary field internally.

There's a few issues with using BinaryField:

MySQL-Python for python 3 has no support

According to the docs they can't be filtered on, which would be a fairly significant flaw

They data format stored would be different to that likely used in string representations (i.e. in URLs, json etc) which would be the hex format. This means a user (or Django) would have to convert that string into a uuid.UUID object and then get the binary representation. I guess we might be doing this anyway.

Aside from space in the database, I don't see any particular benefit if doing this.

TBH, I haven't tried it out, it may prove to be a good idea, but I'd want some significant motivation for it.

schmitch · 2014-07-24T21:45:40Z

This looks really good. The only things I scared about are Forms with UUIDs, thats somewhat unnormal to enter a UUID as a user. Also the explicit need for default= is somewhat "strange".

And it's too bad that this won't go into 1.7

mjtamlyn · 2014-07-29T10:09:18Z

Sign in to view

+    def get_internal_type(self):
+        return "CharField"
+
+    def db_type(self, connection):


If this is in core, should it be using internal types instead?

timgraham · 2014-08-01T18:44:02Z

Sign in to view

+-------------
+
+.. class:: UUIDField(**kwargs)
+


.. versionadded:: 1.8

timgraham · 2014-08-01T18:44:40Z

Sign in to view

+    This field will accept any string format accepted as the ``hex`` argument
+    to the :class:`~python:uuid.UUID` constructor.
+
+


one space between sections

timgraham · 2014-08-01T18:44:56Z

Sign in to view

+
+.. class:: UUIDField(**options)
+
+A field for storing universally unique identifiiers. Uses Python's


identifiers

timgraham · 2014-08-01T18:45:00Z

Sign in to view

@@ -1008,6 +1008,29 @@ Like all :class:`CharField` subclasses, :class:`URLField` takes the optional
 :attr:`~CharField.max_length` argument. If you don't specify
 :attr:`~CharField.max_length`, a default of 200 is used.

+


one space between sections

timgraham · 2014-08-01T18:45:03Z

Sign in to view

+---------
+
+.. class:: UUIDField(**options)
+


.. versionadded:: 1.8

timgraham · 2014-08-01T18:49:46Z

Sign in to view

+UUIDField
+---------
+
+.. class:: UUIDField(**options)


([max_length=36, **options])

mjtamlyn · 2014-08-05T09:15:17Z

Updated fixing docs issues.

schmitch · 2014-08-06T08:34:13Z

the build is failing hard due to git errors, not sure why only some are failing..
I've run the failing builts on my box and it failed (I didn't rebased)
so for me this looks merge ready..
Maybe you should rebase manually..

kezabelle · 2014-08-06T12:58:13Z

Sign in to view

+    description = 'Universally unique identifier'
+
+    def __init__(self, **kwargs):
+        kwargs['max_length'] = 36


Is there a reason that I'm missing (probably) that the field's length is 36 (and each DB's backend definition is 36, with the exception of postgres, which has the native datatype)?
Removing the dashes (if a string) or calling .hex turns the value into 32 chars, which both uuid.UUID() and postgres' datatype support as a input format, and both use the dash-inclusive output format.

oh that's what i've missed. thats true there is something wrong on that line

Good point, the 36 is with the hyphens. I'll correct that

kezabelle · 2014-08-06T13:53:17Z

tests/model_fields/test_uuid.py

+        field.clean(uuid.uuid4(), None)  # no error
+
+
+class TestAsPrimaryKey(TestCase):


As using UUIDs as primary keys is under test, and thus they may end up used by FKs/M2Ms, it might be prudent to see if ticket 22382 (UUIDs and prefetching) is:

valid [I concede it might not be]

not a problem in this case, either because of the implementation itself or because of changes elsewhere in Django.

I appreciate that's an extra burden to consider, and isn't directly related to this Field implementation, but should it be a problem, it's probably best caught early in the Field's lifecycle.

This is definitely a valid issue, and does apply to this situation. There is a related issue that fields using SubfieldBase do not work as you might expect in values() calls. @akaariai and I have some ideas as to how to solve this and I am planning on working on it. Combining it with this patch though is likely to be confusing.

mjtamlyn · 2014-08-07T09:22:33Z

Same project using UUIDField as a pk/"secondary" key/general field at https://github.com/mjtamlyn/uuid-test

It seems the correct signature for a primary key is:
id = UUIDField(primary_key=True, default=uuid.uuid4, editable=False).

collinanderson · 2014-08-07T15:50:45Z

django/db/models/fields/__init__.py

@@ -6,12 +6,14 @@
 import datetime
 import decimal
 import math
+import uuid


would it make sense to lazy-load uuid as most projects won't need it? It could be done with just one more line of code in this file and in django/forms/fields.py

You could make the same argument for all kinds of modules throughout django - starting with the import of decimal two lines above.

Python's uuid is a single python file. The overhead to import it at server-start time is so negligible it's not worth doing anything.

It's true, but decimal and datetime are much more popular.

mjtamlyn · 2014-08-16T09:48:27Z

Rebased against master.

Should be considered blocked by #3047 so I can remove SubFieldBase

timgraham · 2014-09-04T17:48:00Z

Sign in to view

+        value = super(UUIDField, self).to_python(value)
+        if value in self.empty_values:
+            return None
+        if isinstance(value, six.string_types):


(same pattern as above, if you change it)

timgraham · 2014-09-04T17:49:08Z

Sign in to view

+        id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+        # other fields
+
+Note that the callable is passed to ``default``, not an instance of ``UUID``.


this tripped me up when I first read it. maybe: "Note that a callable (with the parentheses omitted) is passed to default." would be a bit clearer

timgraham · 2014-09-04T17:50:38Z

Please add 1.8 release notes, otherwise LGTM.

timgraham · 2014-09-04T17:52:10Z

model_fields.test_uuid.TestSaveLoad.test_null_handling fails on Oracle.

mjtamlyn · 2014-09-04T17:54:12Z

I thought my last commit should fix that (ed970d4)... I'm not sure if the CI did something weird though because the list of commits on the oracle build is not the same as the list on the main build page...

timgraham · 2014-09-04T17:58:05Z

Hm, I don't have insight. Push some changes and try it again.

mjtamlyn · 2014-09-08T17:55:09Z

Squashed into a single commit with release notes. IMO, this is now RFC.

timgraham · 2014-09-15T12:30:26Z

docs/ref/databases.txt

@@ -92,7 +92,8 @@ below for information on how to set up your database correctly.
 PostgreSQL notes
 ================

-Django supports PostgreSQL 9.0 and higher.
+Django supports PostgreSQL 9.0 and higher. It requires the use of Psycopg2
+2.0.9 or higher.


Please add to release notes as well.

timgraham · 2014-09-15T12:31:32Z

docs/ref/models/fields.txt

+
+.. versionadded:: 1.8
+
+.. class:: UUIDField([**options])


should it be [max_length=32, **options]?

No, the max_length argument is ignored (or forced) to be 32.

timgraham · 2014-09-15T12:32:33Z

Sign in to view

+* Django now has a :class:`~django.db.models.UUIDField` for storing
+  universally unique identifiers. There is a corresponding :class:`form field
+  <django.forms.UUIDField>`. It is stored as the native ``uuid`` data type on
+  PostgreSQL, and as a fixed length character field on other backends.


timgraham · 2014-09-15T12:32:54Z

Ship it!


        Fixed #19463 -- Added UUIDField

Uses native support in postgres, and char(32) on other backends.

mjtamlyn · 2014-09-16T09:08:38Z

Merged in ed78212

timgraham reviewed Jul 15, 2014
View changes

django/contrib/postgres/forms/uuid_field.py Outdated

import uuid

from django.core.exceptions import ValidationError

from django import forms

This comment has been minimized.

Sign in to view

timgraham Jul 15, 2014 Member

I'd alphabetize this before 'django.core'

timgraham reviewed Jul 15, 2014
View changes

schinckel reviewed Jul 19, 2014
View changes

mjtamlyn reviewed Jul 24, 2014
View changes

schinckel reviewed Jul 24, 2014
View changes

mjtamlyn changed the title ~~[contrib.postgres] UUIDField~~ Fixed #19463 -- Add UUIDField Jul 24, 2014

claudep reviewed Jul 24, 2014
View changes

mjtamlyn reviewed Jul 29, 2014
View changes

django/db/models/fields/__init__.py Outdated

def get_internal_type(self):

return "CharField"

def db_type(self, connection):

This comment has been minimized.

Sign in to view

mjtamlyn Jul 29, 2014 Author Member

If this is in core, should it be using internal types instead?