django_fields.py 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. # -*- coding: utf-8 -*-
  2. # Copyright (c) The python-semanticversion project
  3. # This code is distributed under the two-clause BSD License.
  4. import warnings
  5. from django.db import models
  6. from django.utils.translation import ugettext_lazy as _
  7. from . import base
  8. class SemVerField(models.CharField):
  9. def __init__(self, *args, **kwargs):
  10. kwargs.setdefault('max_length', 200)
  11. super(SemVerField, self).__init__(*args, **kwargs)
  12. def from_db_value(self, value, expression, connection, *args):
  13. """Convert from the database format.
  14. This should be the inverse of self.get_prep_value()
  15. """
  16. return self.to_python(value)
  17. def get_prep_value(self, obj):
  18. return None if obj is None else str(obj)
  19. def get_db_prep_value(self, value, connection, prepared=False):
  20. if not prepared:
  21. value = self.get_prep_value(value)
  22. return value
  23. def value_to_string(self, obj):
  24. value = self.to_python(self.value_from_object(obj))
  25. return str(value)
  26. def run_validators(self, value):
  27. return super(SemVerField, self).run_validators(str(value))
  28. class VersionField(SemVerField):
  29. default_error_messages = {
  30. 'invalid': _("Enter a valid version number in X.Y.Z format."),
  31. }
  32. description = _("Version")
  33. def __init__(self, *args, **kwargs):
  34. self.partial = kwargs.pop('partial', False)
  35. if self.partial:
  36. warnings.warn(
  37. "Use of `partial=True` will be removed in 3.0.",
  38. DeprecationWarning,
  39. stacklevel=2,
  40. )
  41. self.coerce = kwargs.pop('coerce', False)
  42. super(VersionField, self).__init__(*args, **kwargs)
  43. def deconstruct(self):
  44. """Handle django.db.migrations."""
  45. name, path, args, kwargs = super(VersionField, self).deconstruct()
  46. kwargs['partial'] = self.partial
  47. kwargs['coerce'] = self.coerce
  48. return name, path, args, kwargs
  49. def to_python(self, value):
  50. """Converts any value to a base.Version field."""
  51. if value is None or value == '':
  52. return value
  53. if isinstance(value, base.Version):
  54. return value
  55. if self.coerce:
  56. return base.Version.coerce(value, partial=self.partial)
  57. else:
  58. return base.Version(value, partial=self.partial)
  59. class SpecField(SemVerField):
  60. default_error_messages = {
  61. 'invalid': _("Enter a valid version number spec list in ==X.Y.Z,>=A.B.C format."),
  62. }
  63. description = _("Version specification list")
  64. def __init__(self, *args, **kwargs):
  65. self.syntax = kwargs.pop('syntax', base.DEFAULT_SYNTAX)
  66. super(SpecField, self).__init__(*args, **kwargs)
  67. def deconstruct(self):
  68. """Handle django.db.migrations."""
  69. name, path, args, kwargs = super(SpecField, self).deconstruct()
  70. if self.syntax != base.DEFAULT_SYNTAX:
  71. kwargs['syntax'] = self.syntax
  72. return name, path, args, kwargs
  73. def to_python(self, value):
  74. """Converts any value to a base.Spec field."""
  75. if value is None or value == '':
  76. return value
  77. if isinstance(value, base.BaseSpec):
  78. return value
  79. return base.BaseSpec.parse(value, syntax=self.syntax)