ChatGPT解决这个技术问题 Extra ChatGPT

How to set a Django model field's default value to a function call / callable (e.g., a date relative to the time of model object creation)

EDITED:

How can I set a Django field's default to a function that gets evaluated each time a new model object gets created?

I want to do something like the following, except that in this code, the code gets evaluated once and sets the default to the same date for each model object created, rather than evaluating the code each time a model object gets created:

from datetime import datetime, timedelta
class MyModel(models.Model):
  # default to 1 day from now
  my_date = models.DateTimeField(default=datetime.now() + timedelta(days=1))

ORIGINAL:

I want to create a default value for a function parameter such that it is dynamic and gets called and set each time the function is called. How can I do that? e.g.,

from datetime import datetime
def mydate(date=datetime.now()):
  print date

mydate() 
mydate() # prints the same thing as the previous call; but I want it to be a newer value

Specifically, I want to do it in Django, e.g.,

from datetime import datetime, timedelta
class MyModel(models.Model):
  # default to 1 day from now
  my_date = models.DateTimeField(default=datetime.now() + timedelta(days=1))
The question is misworded: it has nothing to do with function parameter defaults. See my answer.
Per @NedBatchelder's comment, I edited my question (indicated as "EDITED:") and left the original (indicated as "ORIGINAL:")

J
JGC

The question is misguided. When creating a model field in Django, you are not defining a function, so function default values are irrelevant:

from datetime import datetime, timedelta
class MyModel(models.Model):
  # default to 1 day from now
  my_date = models.DateTimeField(default=datetime.now() + timedelta(days=1))

This last line is not defining a function; it is invoking a function to create a field in the class.

In this case datetime.now() + timedelta(days=1) will be evaluated once, and stored as the default value.

PRE Django 1.7

Django [lets you pass a callable as the default][1], and it will invoke it each time, just as you want:

from datetime import datetime, timedelta
class MyModel(models.Model):
  # default to 1 day from now
  my_date = models.DateTimeField(default=lambda: datetime.now() + timedelta(days=1))

Django 1.7+

Please note that since Django 1.7, usage of lambda as default value is not recommended (c.f. @stvnw comment). The proper way to do this is to declare a function before the field and use it as a callable in default_value named arg:

from datetime import datetime, timedelta

# default to 1 day from now
def get_default_my_date():
  return datetime.now() + timedelta(days=1)

class MyModel(models.Model):
  my_date = models.DateTimeField(default=get_default_my_date)

More information in the @simanas answer below [1]: https://docs.djangoproject.com/en/dev/ref/models/fields/#default


Thanks @NedBatchelder. This is exactly what I was looking for. I didn't realize that 'default' could take a callable. And now I see how my question was indeed misguided regarding function invocation vs function definition.
Note that for Django>=1.7 the use of lambdas is not recommended for field options because they are incompatible with migrations. Ref: Docs, ticket
Please uncheck this answer, as it is wrong for Djange>=1.7. The answer by @Simanas is absolutely correct and should therefore be accepted.
How does this work with migrations? Do all old objects get a date based on the time of migration? Is it possible to set a different default to be used with migrations?
What if I want to pass some parameter to get_default_my_date?
S
Simanas

Doing this default=datetime.now()+timedelta(days=1) is absolutely wrong!

It gets evaluated when you start your instance of django. If you are under apache it will probably work, because on some configurations apache revokes your django application on every request, but still you can find you self some day looking through out your code and trying to figure out why this get calculated not as you expect.

The right way of doing this is to pass a callable object to default argument. It can be a datetime.today function or your custom function. Then it gets evaluated every time you request a new default value.

def get_deadline():
    return datetime.today() + timedelta(days=20)

class Bill(models.Model):
    name = models.CharField(max_length=50)
    customer = models.ForeignKey(User, related_name='bills')
    date = models.DateField(default=datetime.today)
    deadline = models.DateField(default=get_deadline)

If my default is based on the value of another field in the model, is it possible to pass that field as a parameter as in something like get_deadline(my_parameter)?
@YPCrumble this should be a new question!
Nope. That's not possible. You will have to use some different approach to do it.
How do you remove the deadline field again while also deleting the get_deadline function? I have removed a field with a function for a default value, but now Django crashes on startup after removing the function. I could manually edit the migration, which would be ok in this case, but what if you simply changed the default function, and wanted to remove the old function?
default=datetime.today is not working for DJango version 3.2, My database is MySQL and running your code still setting default value to None.
H
Hendy Irawan

There's an important distinction between the following two DateTimeField constructors:

my_date = models.DateTimeField(auto_now=True)
my_date = models.DateTimeField(auto_now_add=True)

If you use auto_now_add=True in the constructor, the datetime referenced by my_date is "immutable" (only set once when the row is inserted to the table).

With auto_now=True, however, the datetime value will be updated every time the object is saved.

This was definitely a gotcha for me at one point. For reference, the docs are here:

https://docs.djangoproject.com/en/dev/ref/models/fields/#datetimefield


You've got your definitions of auto_now and auto_now_add mixed up, it's the other way round.
@MichaelBates better now?
default=datetime.today is not working for DJango version 3.2, My database is MySQL and running your code still setting default value to None.
G
GalacticRaph

Sometimes you may need to access model data after creating a new user model.

Here is how I generate a token for each new user profile using the first 4 characters of their username:

from django.dispatch import receiver
class Profile(models.Model):
    auth_token = models.CharField(max_length=13, default=None, null=True, blank=True)


@receiver(post_save, sender=User) # this is called after a User model is saved.
def create_user_profile(sender, instance, created, **kwargs):
    if created: # only run the following if the profile is new
        new_profile = Profile.objects.create(user=instance)
        new_profile.create_auth_token()
        new_profile.save()

def create_auth_token(self):
    import random, string
    auth = self.user.username[:4] # get first 4 characters in user name
    self.auth_token =  auth + ''.join(random.SystemRandom().choice(string.ascii_uppercase + string.digits + string.ascii_lowercase) for _ in range(random.randint(3, 5)))

a
abarnert

You can't do that directly; the default value is evaluated when the function definition is evaluated. But there are two ways around it.

First, you can create (and then call) a new function each time.

Or, more simply, just use a special value to mark the default. For example:

from datetime import datetime
def mydate(date=None):
  if date is None:
    date = datetime.now()
  print date

If None is a perfectly reasonable parameter value, and there's no other reasonable value you could use in its place, you can just create a new value that's definitely outside the domain of your function:

from datetime import datetime
class _MyDateDummyDefault(object):
  pass
def mydate(date=_MyDateDummyDefault):
  if date is _MyDateDummyDefault:
    date = datetime.now()
  print date
del _MyDateDummyDefault

In some rare cases, you're writing meta-code that really does need to be able to take absolutely anything, even, say, mydate.func_defaults[0]. In that case, you have to do something like this:

def mydate(*args, **kw):
  if 'date' in kw:
    date = kw['date']
  elif len(args):
    date = args[0]
  else:
    date = datetime.now()
  print date

Note that there's no reason to actually instantiate the dummy value class - just use the class itself as the dummy value.
You CAN do this directly, just pass in the function instead of the result of the function call. See my posted answer.
No you can't. The result of the function isn't the same type of thing as the normal parameters, so it can't reasonably be used as a default value for those normal parameters.
Well yes, if you pass in an object instead of a function it will raise an exception. The same is true if you pass a function into a parameter expecting a string. I don't see how that's relevant.
It's relevant because his myfunc function is made to take (and print) a datetime; you've changed it so it can't be used that way.
佚名

Pass the function in as a parameter instead of passing in the result of the function call.

That is, instead of this:

def myfunc(date=datetime.now()):
    print date

Try this:

def myfunc(date=datetime.now):
    print date()

This doesn't work, because now the user can't actually pass a parameter—you'll try to call it as a function and throw an exception. In which case you might as well just take no params and print datetime.now() unconditionally.
Try it. You're not passing a date, you're passing the datetime.now function.
Yes, the default is passing the datetime.now function. But any user who passes a non-default value will be passing a datetime, not a function. foo = datetime.now(); myfunc(foo) will raise TypeError: 'datetime.datetime' object is not callable. If I actually wanted to use your function, I'd have to do something like myfunc(lambda: foo) instead, which is not a reasonable interface.
Interfaces which accept functions are not unusual. I could start naming examples from the python stdlib, if you like.
Django already accepts a callable exactly as this question suggests.