/usr/lib/python3/dist-packages/djorm_pgarray/fields.py is in python3-djorm-ext-pgarray 1.2-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 | from __future__ import unicode_literals
from collections import Iterable
import json
import django
from django import forms
from django.core.exceptions import ValidationError
from django.core.serializers.json import DjangoJSONEncoder
from django.core import validators
from django.db import models
from django.utils import six
from django.utils.encoding import force_text
from django.utils.translation import ugettext_lazy as _
TYPES = {
"int": int,
"smallint": int,
"bigint": int,
"text": force_text,
"double precision": float,
"varchar": force_text,
}
def _cast_to_unicode(data):
if isinstance(data, (list, tuple)):
return [_cast_to_unicode(x) for x in data]
elif isinstance(data, str):
return force_text(data)
return data
def _cast_to_type(data, type_cast):
if isinstance(data, (list, tuple)):
return [_cast_to_type(x, type_cast) for x in data]
if type_cast == str:
return force_text(data)
return type_cast(data)
def _unserialize(value):
if not isinstance(value, six.string_types):
return _cast_to_unicode(value)
try:
return _cast_to_unicode(json.loads(value))
except ValueError:
return _cast_to_unicode(value)
class ArrayField(six.with_metaclass(models.SubfieldBase, models.Field)):
empty_strings_allowed = False
def __init__(self, dbtype="int", type_cast=None, dimension=1, *args, **kwargs):
self._array_type = dbtype
type_key = self._array_type.split("(")[0]
self._explicit_type_cast = False
if type_cast is not None:
self._type_cast = type_cast
self._explicit_type_cast = True
elif type_key in TYPES:
self._type_cast = TYPES[type_key]
else:
self._type_cast = lambda x: x
self._dimension = dimension
kwargs.setdefault("blank", True)
kwargs.setdefault("null", True)
kwargs.setdefault("default", None)
super(ArrayField, self).__init__(*args, **kwargs)
def get_db_prep_lookup(self, lookup_type, value, connection, prepared=False):
if lookup_type == "contains":
return [self.get_prep_value(value)]
return super(ArrayField, self).get_db_prep_lookup(lookup_type, value, connection, prepared)
def formfield(self, **params):
params.setdefault("form_class", ArrayFormField)
# Django 1.5 does not support "choices_form_class" parameter
if django.VERSION[:2] >= (1, 6):
params.setdefault("choices_form_class", forms.TypedMultipleChoiceField)
if self.choices:
params.setdefault("choices", self.get_choices(include_blank=False))
params.setdefault("coerce", self._type_cast)
return super(ArrayField, self).formfield(**params)
def get_db_prep_value(self, value, connection, prepared=False):
value = value if prepared else self.get_prep_value(value)
if not value or isinstance(value, six.string_types):
return value
return _cast_to_type(value, self._type_cast)
def get_prep_value(self, value):
return value if isinstance(value, (six.string_types, list,)) or not isinstance(value, Iterable) else list(value)
def to_python(self, value):
return _unserialize(value)
def value_to_string(self, obj):
value = self._get_val_from_obj(obj)
return json.dumps(self.get_prep_value(value),
cls=DjangoJSONEncoder)
def validate(self, value, model_instance):
if value is None and not self.null:
raise ValidationError(self.error_messages['null'])
if not self.blank and value in validators.EMPTY_VALUES:
raise ValidationError(self.error_messages['blank'])
for val in value:
super(ArrayField, self).validate(val, model_instance)
def deconstruct(self):
name, path, args, kwargs = super(ArrayField, self).deconstruct()
if self._array_type != "int":
kwargs["dbtype"] = self._array_type
if self._dimension != 1:
kwargs["dimension"] = self._dimension
if self._explicit_type_cast:
kwargs["type_cast"] = self._type_cast
if self.blank:
kwargs.pop("blank", None)
else:
kwargs["blank"] = self.blank
if self.null:
kwargs.pop("null", None)
else:
kwargs["null"] = self.null
if self.default is None:
kwargs.pop("default", None)
else:
kwargs["default"] = self.default
return name, path, args, kwargs
def db_type(self, connection):
return "{0}{1}".format(self._array_type, "[]" * self._dimension)
def get_transform(self, name):
transform = super(ArrayField, self).get_transform(name)
if transform:
return transform
try:
index = int(name)
except ValueError:
pass
else:
index += 1 # postgres uses 1-indexing
return IndexTransformFactory(index, self)
try:
start, end = name.split("_")
start = int(start) + 1
end = int(end) # don't add one here because postgres slices are weird
except ValueError:
pass
else:
return SliceTransformFactory(start, end)
class IntegerArrayField(ArrayField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("dbtype", "int")
super(IntegerArrayField, self).__init__(*args, **kwargs)
class SmallIntegerArrayField(ArrayField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("dbtype", "smallint")
super(SmallIntegerArrayField, self).__init__(*args, **kwargs)
class BigIntegerArrayField(ArrayField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("dbtype", "bigint")
super(BigIntegerArrayField, self).__init__(*args, **kwargs)
class TextArrayField(ArrayField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("dbtype", "text")
super(TextArrayField, self).__init__(*args, **kwargs)
class FloatArrayField(ArrayField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("dbtype", "double precision")
super(FloatArrayField, self).__init__(*args, **kwargs)
class DateArrayField(ArrayField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("dbtype", "date")
super(DateArrayField, self).__init__(*args, **kwargs)
class DateTimeArrayField(ArrayField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("dbtype", "timestamp with time zone")
super(DateTimeArrayField, self).__init__(*args, **kwargs)
class ArrayFormField(forms.Field):
default_error_messages = {
"invalid": _("Enter a list of values, joined by commas. E.g. \"a,b,c\"."),
}
def __init__(self, max_length=None, min_length=None, delim=None,
strip=True, *args, **kwargs):
if delim is not None:
self.delim = delim
else:
self.delim = u","
self.strip = strip
super(ArrayFormField, self).__init__(*args, **kwargs)
def clean(self, value):
if not value:
return []
# If Django already parsed value to list
if isinstance(value, list):
return value
try:
value = value.split(self.delim)
if self.strip:
value = [x.strip() for x in value]
except Exception:
raise ValidationError(self.error_messages["invalid"])
return value
def prepare_value(self, value):
if isinstance(value, (list, tuple)): # if blank list/tuple return ''
return self.delim.join(force_text(v) for v in value)
return super(ArrayFormField, self).prepare_value(value)
def to_python(self, value):
if value is None or value == u"":
return []
return value.split(self.delim)
if django.VERSION[:2] >= (1, 7):
from django.db.models import Lookup, Transform
class ContainsLookup(Lookup):
lookup_name = "contains"
def as_sql(self, qn, connection):
lhs, lhs_params = self.process_lhs(qn, connection)
rhs, rhs_params = self.process_rhs(qn, connection)
params = lhs_params + rhs_params
var = "%s @> %s" % (lhs, rhs), params
return var
class ContainedByLookup(Lookup):
lookup_name = "contained_by"
def as_sql(self, qn, connection):
lhs, lhs_params = self.process_lhs(qn, connection)
rhs, rhs_params = self.process_rhs(qn, connection)
params = lhs_params + rhs_params
return "%s <@ %s" % (lhs, rhs), params
class OverlapLookup(Lookup):
lookup_name = "overlap"
def as_sql(self, qn, connection):
lhs, lhs_params = self.process_lhs(qn, connection)
rhs, rhs_params = self.process_rhs(qn, connection)
params = lhs_params + rhs_params
return "%s && %s" % (lhs, rhs), params
class ArrayLenTransform(Transform):
lookup_name = "len"
@property
def output_type(self):
return models.IntegerField()
def as_sql(self, qn, connection):
lhs, params = qn.compile(self.lhs)
return "array_length(%s, 1)" % lhs, params
class AnyBaseLookup(Lookup):
comparator = "="
"""self.comparator holds the comparison operator to be applied to the condition"""
def as_sql(self, qn, connection):
"""
Basically, the array gets split up into rows (unnested) such that we can apply string comparators on the
array's contents. Once these operations have been applied, the resulting set of PKs is used to identify,
for what rows the given condition is true.
:param qn: The SQLCompiler object used for compiling this query
:param connection: A DatabaseWrapper object
:return: a tuple (condition_string, parameter)
"""
lhs, lhs_params = self.process_lhs(qn, connection)
rhs, rhs_params = self.process_rhs(qn, connection)
params = lhs_params + rhs_params
table = self.lhs.alias
pk_name = qn.query.model._meta.pk.name
table_dot_pk_name = "%s.%s" % (table, pk_name)
return "{table_dot_pk_name} IN (" \
"SELECT DISTINCT tmp_table.{pk_name} " \
"FROM {table} AS tmp_table " \
"JOIN ( " \
"SELECT tmp_table2.{pk_name} AS id, unnest({arrayfield_name}::text[]) AS unnest " \
"FROM {table} AS tmp_table2) AS embedded_table ON embedded_table.{pk_name}=tmp_table.{pk_name} " \
"WHERE embedded_table.unnest {comparator} %s)".format(table_dot_pk_name=table_dot_pk_name,
pk_name=pk_name, table=table,
arrayfield_name=lhs,
comparator=self.comparator) % (
rhs, ), params
class AnyStartswithLookup(AnyBaseLookup):
lookup_name = "any_startswith"
comparator = "LIKE"
def process_rhs(self, qn, connection):
wildcarded_rhs_params = []
rhs, rhs_params = super(AnyStartswithLookup, self).process_rhs(qn, connection)
for param in rhs_params:
param = "%s%%" % param
wildcarded_rhs_params.append(param)
return rhs, wildcarded_rhs_params
class AnyIStartswithLookup(AnyStartswithLookup):
lookup_name = "any_istartswith"
comparator = "ILIKE"
class AnyEndswithLookup(AnyBaseLookup):
lookup_name = "any_endswith"
comparator = "LIKE"
def process_rhs(self, qn, connection):
wildcarded_rhs_params = []
rhs, rhs_params = super(AnyEndswithLookup, self).process_rhs(qn, connection)
for param in rhs_params:
param = "%%%s" % param
wildcarded_rhs_params.append(param)
return rhs, wildcarded_rhs_params
class AnyIEndswithLookup(AnyEndswithLookup):
lookup_name = "any_iendswith"
comparator = "ILIKE"
class AnyContainsLookup(AnyBaseLookup):
lookup_name = "any_contains"
comparator = "LIKE"
def process_rhs(self, qn, connection):
wildcarded_rhs_params = []
rhs, rhs_params = super(AnyContainsLookup, self).process_rhs(qn, connection)
for param in rhs_params:
param = "%%%s%%" % param
wildcarded_rhs_params.append(param)
return rhs, wildcarded_rhs_params
class AnyIContainsLookup(AnyContainsLookup):
lookup_name = "any_icontains"
comparator = "ILIKE"
ArrayField.register_lookup(ContainedByLookup)
ArrayField.register_lookup(ContainsLookup)
ArrayField.register_lookup(OverlapLookup)
ArrayField.register_lookup(ArrayLenTransform)
ArrayField.register_lookup(AnyStartswithLookup)
ArrayField.register_lookup(AnyIStartswithLookup)
ArrayField.register_lookup(AnyEndswithLookup)
ArrayField.register_lookup(AnyIEndswithLookup)
ArrayField.register_lookup(AnyContainsLookup)
ArrayField.register_lookup(AnyIContainsLookup)
class IndexTransform(Transform):
def __init__(self, index, field, *args, **kwargs):
super(IndexTransform, self).__init__(*args, **kwargs)
self.index = index
self.field = field
def as_sql(self, qn, connection):
lhs, params = qn.compile(self.lhs)
return "%s[%s]" % (lhs, self.index), params
# TODO: Temporary not supported nested index lookup
# @property
# def output_type(self):
# output_type = self.field.__class__(dimension=self.field._dimension-1)
# output_type._array_type = self.field._array_type
# output_type._explicit_type_cast = self.field._explicit_type_cast
# output_type._type_cast = self.field._type_cast
# output_type.set_attributes_from_name(self.field.name)
# return output_type
class SliceTransform(Transform):
def __init__(self, start, end, *args, **kwargs):
super(SliceTransform, self).__init__(*args, **kwargs)
self.start = start
self.end = end
def as_sql(self, qn, connection):
lhs, params = qn.compile(self.lhs)
return "%s[%s:%s]" % (lhs, self.start, self.end), params
class IndexTransformFactory(object):
def __init__(self, index, field):
self.index = index
self.field = field
def __call__(self, *args, **kwargs):
return IndexTransform(self.index, self.field, *args, **kwargs)
class SliceTransformFactory(object):
def __init__(self, start, end):
self.start = start
self.end = end
def __call__(self, *args, **kwargs):
return SliceTransform(self.start, self.end, *args, **kwargs)
# South support
try:
from south.modelsinspector import add_introspection_rules
add_introspection_rules([
(
[ArrayField], # class
[], # positional params
{
"dbtype": ["_array_type", {"default": "int"}],
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.ArrayField"])
add_introspection_rules([
(
[TextArrayField], # class
[], # positional params
{
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.TextArrayField"])
add_introspection_rules([
(
[FloatArrayField], # class
[], # positional params
{
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.FloatArrayField"])
add_introspection_rules([
(
[IntegerArrayField], # class
[], # positional params
{
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.IntegerArrayField"])
add_introspection_rules([
(
[BigIntegerArrayField], # class
[], # positional params
{
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.BigIntegerArrayField"])
add_introspection_rules([
(
[SmallIntegerArrayField], # class
[], # positional params
{
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.SmallIntegerArrayField"])
add_introspection_rules([
(
[DateTimeArrayField], # class
[], # positional params
{
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.DateTimeArrayField"])
add_introspection_rules([
(
[DateArrayField], # class
[], # positional params
{
"dimension": ["_dimension", {"default": 1}],
"null": ["null", {"default": True}],
}
)
], ["^djorm_pgarray\.fields\.DateArrayField"])
except ImportError:
pass
|