SourceForge has been redesigned. Learn more.
Close

[9b6048]: / sqlobject / col.py  Maximize  Restore  History

Download this file

1646 lines (1354 with data), 56.2 kB

   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
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
"""
Col -- SQLObject columns
Note that each column object is named BlahBlahCol, and these are used
in class definitions. But there's also a corresponding SOBlahBlahCol
object, which is used in SQLObject *classes*.
An explanation: when a SQLObject subclass is created, the metaclass
looks through your class definition for any subclasses of Col. It
collects them together, and indexes them to do all the database stuff
you like, like the magic attributes and whatnot. It then asks the Col
object to create an SOCol object (usually a subclass, actually). The
SOCol object contains all the interesting logic, as well as a record
of the attribute name you used and the class it is bound to (set by
the metaclass).
So, in summary: Col objects are what you define, but SOCol objects
are what gets used.
"""
from array import array
from itertools import count
import re
import sys
import time
try:
import cPickle as pickle
except ImportError:
import pickle
import weakref
from formencode import compound, validators
from classregistry import findClass
# Sadly the name "constraints" conflicts with many of the function
# arguments in this module, so we rename it:
import constraints as constrs
import sqlbuilder
from styles import capword
NoDefault = sqlbuilder.NoDefault
import datetime
datetime_available = True
try:
from mx import DateTime
except ImportError:
try:
import DateTime # old version of mxDateTime, or Zope's Version if we're running with Zope
except ImportError:
mxdatetime_available = False
else:
mxdatetime_available = True
else:
mxdatetime_available = True
DATETIME_IMPLEMENTATION = "datetime"
MXDATETIME_IMPLEMENTATION = "mxDateTime"
if mxdatetime_available:
if hasattr(DateTime, "Time"):
DateTimeType = type(DateTime.now())
TimeType = type(DateTime.Time())
else: # Zope
DateTimeType = type(DateTime.DateTime())
TimeType = type(DateTime.DateTime.Time(DateTime.DateTime()))
default_datetime_implementation = DATETIME_IMPLEMENTATION
__all__ = ["datetime_available", "mxdatetime_available",
"default_datetime_implementation", "DATETIME_IMPLEMENTATION"]
if mxdatetime_available:
__all__.append("MXDATETIME_IMPLEMENTATION")
creationOrder = count()
########################################
## Columns
########################################
# Col is essentially a column definition, it doesn't have
# much logic to it.
class SOCol(object):
def __init__(self,
name,
soClass,
creationOrder,
dbName=None,
default=NoDefault,
defaultSQL=None,
foreignKey=None,
alternateID=False,
alternateMethodName=None,
constraints=None,
notNull=NoDefault,
notNone=NoDefault,
unique=NoDefault,
sqlType=None,
columnDef=None,
validator=None,
validator2=None,
immutable=False,
cascade=None,
lazy=False,
noCache=False,
forceDBName=False,
title=None,
tags=[],
origName=None,
dbEncoding=None,
extra_vars=None):
super(SOCol, self).__init__()
# This isn't strictly true, since we *could* use backquotes or
# " or something (database-specific) around column names, but
# why would anyone *want* to use a name like that?
# @@: I suppose we could actually add backquotes to the
# dbName if we needed to...
if not forceDBName:
assert sqlbuilder.sqlIdentifier(name), 'Name must be SQL-safe (letters, numbers, underscores): %s (or use forceDBName=True)' \
% repr(name)
assert name != 'id', 'The column name "id" is reserved for SQLObject use (and is implicitly created).'
assert name, "You must provide a name for all columns"
self.columnDef = columnDef
self.creationOrder = creationOrder
self.immutable = immutable
# cascade can be one of:
# None: no constraint is generated
# True: a CASCADE constraint is generated
# False: a RESTRICT constraint is generated
# 'null': a SET NULL trigger is generated
if isinstance(cascade, str):
assert cascade == 'null', (
"The only string value allowed for cascade is 'null' (you gave: %r)" % cascade)
self.cascade = cascade
if not isinstance(constraints, (list, tuple)):
constraints = [constraints]
self.constraints = self.autoConstraints() + constraints
self.notNone = False
if notNull is not NoDefault:
self.notNone = notNull
assert notNone is NoDefault or \
(not notNone) == (not notNull), \
"The notNull and notNone arguments are aliases, and must not conflict. You gave notNull=%r, notNone=%r" % (notNull, notNone)
elif notNone is not NoDefault:
self.notNone = notNone
if self.notNone:
self.constraints = [constrs.notNull] + self.constraints
self.name = name
self.soClass = soClass
self._default = default
self.defaultSQL = defaultSQL
self.customSQLType = sqlType
# deal with foreign keys
self.foreignKey = foreignKey
if self.foreignKey:
if origName is not None:
idname = soClass.sqlmeta.style.instanceAttrToIDAttr(origName)
else:
idname = soClass.sqlmeta.style.instanceAttrToIDAttr(name)
if self.name != idname:
self.foreignName = self.name
self.name = idname
else:
self.foreignName = soClass.sqlmeta.style.instanceIDAttrToAttr(self.name)
else:
self.foreignName = None
# if they don't give us a specific database name for
# the column, we separate the mixedCase into mixed_case
# and assume that.
if dbName is None:
self.dbName = soClass.sqlmeta.style.pythonAttrToDBColumn(self.name)
else:
self.dbName = dbName
# alternateID means that this is a unique column that
# can be used to identify rows
self.alternateID = alternateID
if unique is NoDefault:
self.unique = alternateID
else:
self.unique = unique
if self.unique and alternateMethodName is None:
self.alternateMethodName = 'by' + capword(self.name)
else:
self.alternateMethodName = alternateMethodName
_validators = self.createValidators()
if validator: _validators.append(validator)
if validator2: _validators.insert(0, validator2)
_vlen = len(_validators)
if _vlen:
for _validator in _validators:
_validator.soCol=weakref.proxy(self)
if _vlen == 0:
self.validator = None # Set sef.{from,to}_python
elif _vlen == 1:
self.validator = _validators[0]
elif _vlen > 1:
self.validator = compound.All.join(_validators[0], *_validators[1:])
self.noCache = noCache
self.lazy = lazy
# this is in case of ForeignKey, where we rename the column
# and append an ID
self.origName = origName or name
self.title = title
self.tags = tags
self.dbEncoding = dbEncoding
if extra_vars:
for name, value in extra_vars.items():
setattr(self, name, value)
def _set_validator(self, value):
self._validator = value
if self._validator:
self.to_python = self._validator.to_python
self.from_python = self._validator.from_python
else:
self.to_python = None
self.from_python = None
def _get_validator(self):
return self._validator
validator = property(_get_validator, _set_validator)
def createValidators(self):
"""Create a list of validators for the column."""
return []
def autoConstraints(self):
return []
def _get_default(self):
# A default can be a callback or a plain value,
# here we resolve the callback
if self._default is NoDefault:
return NoDefault
elif hasattr(self._default, '__sqlrepr__'):
return self._default
elif callable(self._default):
return self._default()
else:
return self._default
default = property(_get_default, None, None)
def _get_joinName(self):
return self.soClass.sqlmeta.style.instanceIDAttrToAttr(self.name)
joinName = property(_get_joinName, None, None)
def __repr__(self):
r = '<%s %s' % (self.__class__.__name__, self.name)
if self.default is not NoDefault:
r += ' default=%s' % repr(self.default)
if self.foreignKey:
r += ' connected to %s' % self.foreignKey
if self.alternateID:
r += ' alternate ID'
if self.notNone:
r += ' not null'
return r + '>'
def createSQL(self):
return ' '.join([self._sqlType()] + self._extraSQL())
def _extraSQL(self):
result = []
if self.notNone or self.alternateID:
result.append('NOT NULL')
if self.unique or self.alternateID:
result.append('UNIQUE')
if self.defaultSQL is not None:
result.append("DEFAULT %s" % self.defaultSQL)
return result
def _sqlType(self):
if self.customSQLType is None:
raise ValueError, ("Col %s (%s) cannot be used for automatic "
"schema creation (too abstract)" %
(self.name, self.__class__))
else:
return self.customSQLType
def _mysqlType(self):
return self._sqlType()
def _postgresType(self):
return self._sqlType()
def _sqliteType(self):
# SQLite is naturally typeless, so as a fallback it uses
# no type.
try:
return self._sqlType()
except ValueError:
return ''
def _sybaseType(self):
return self._sqlType()
def _mssqlType(self):
return self._sqlType()
def _firebirdType(self):
return self._sqlType()
def _maxdbType(self):
return self._sqlType()
def mysqlCreateSQL(self):
return ' '.join([self.dbName, self._mysqlType()] + self._extraSQL())
def postgresCreateSQL(self):
return ' '.join([self.dbName, self._postgresType()] + self._extraSQL())
def sqliteCreateSQL(self):
return ' '.join([self.dbName, self._sqliteType()] + self._extraSQL())
def sybaseCreateSQL(self):
return ' '.join([self.dbName, self._sybaseType()] + self._extraSQL())
def mssqlCreateSQL(self, connection=None):
self.connection = connection
return ' '.join([self.dbName, self._mssqlType()] + self._extraSQL())
def firebirdCreateSQL(self):
# Ian Sparks pointed out that fb is picky about the order
# of the NOT NULL clause in a create statement. So, we handle
# them differently for Enum columns.
if not isinstance(self, SOEnumCol):
return ' '.join([self.dbName, self._firebirdType()] + self._extraSQL())
else:
return ' '.join([self.dbName] + [self._firebirdType()[0]] + self._extraSQL() + [self._firebirdType()[1]])
def maxdbCreateSQL(self):
return ' '.join([self.dbName, self._maxdbType()] + self._extraSQL())
def __get__(self, obj, type=None):
if obj is None:
# class attribute, return the descriptor itself
return self
if obj.sqlmeta._obsolete:
raise RuntimeError('The object <%s %s> is obsolete' % (
obj.__class__.__name__, obj.id))
if obj.sqlmeta.cacheColumns:
columns = obj.sqlmeta._columnCache
if columns is None:
obj.sqlmeta.loadValues()
try:
return columns[name]
except KeyError:
return obj.sqlmeta.loadColumn(self)
else:
return obj.sqlmeta.loadColumn(self)
def __set__(self, obj, value):
if self.immutable:
raise AttributeError("The column %s.%s is immutable" %
(obj.__class__.__name__,
self.name))
obj.sqlmeta.setColumn(self, value)
def __delete__(self, obj):
raise AttributeError("I can't be deleted from %r" % obj)
def getDbEncoding(self, state, default='utf-8'):
if self.dbEncoding:
return self.dbEncoding
dbEncoding = state.soObject.sqlmeta.dbEncoding
if dbEncoding:
return dbEncoding
try:
connection = state.connection or state.soObject._connection
except AttributeError:
dbEncoding = None
else:
dbEncoding = getattr(connection, "dbEncoding", None)
if not dbEncoding:
dbEncoding = default
return dbEncoding
class Col(object):
baseClass = SOCol
def __init__(self, name=None, **kw):
super(Col, self).__init__()
self.__dict__['_name'] = name
self.__dict__['_kw'] = kw
self.__dict__['creationOrder'] = creationOrder.next()
self.__dict__['_extra_vars'] = {}
def _set_name(self, value):
assert self._name is None or self._name == value, (
"You cannot change a name after it has already been set "
"(from %s to %s)" % (self.name, value))
self.__dict__['_name'] = value
def _get_name(self):
return self._name
name = property(_get_name, _set_name)
def withClass(self, soClass):
return self.baseClass(soClass=soClass, name=self._name,
creationOrder=self.creationOrder,
columnDef=self,
extra_vars=self._extra_vars,
**self._kw)
def __setattr__(self, var, value):
if var == 'name':
super(Col, self).__setattr__(var, value)
return
self._extra_vars[var] = value
def __repr__(self):
return '<%s %s %s>' % (
self.__class__.__name__, hex(abs(id(self)))[2:],
self._name or '(unnamed)')
class SOValidator(validators.Validator):
def getDbEncoding(self, state, default='utf-8'):
try:
return self.dbEncoding
except AttributeError:
return self.soCol.getDbEncoding(state, default=default)
class SOStringLikeCol(SOCol):
"""A common ancestor for SOStringCol and SOUnicodeCol"""
def __init__(self, **kw):
self.length = kw.pop('length', None)
self.varchar = kw.pop('varchar', 'auto')
self.char_binary = kw.pop('char_binary', None) # A hack for MySQL
if not self.length:
assert self.varchar == 'auto' or not self.varchar, \
"Without a length strings are treated as TEXT, not varchar"
self.varchar = False
elif self.varchar == 'auto':
self.varchar = True
super(SOStringLikeCol, self).__init__(**kw)
def autoConstraints(self):
constraints = [constrs.isString]
if self.length is not None:
constraints += [constrs.MaxLength(self.length)]
return constraints
def _sqlType(self):
if self.customSQLType is not None:
return self.customSQLType
if not self.length:
return 'TEXT'
elif self.varchar:
return 'VARCHAR(%i)' % self.length
else:
return 'CHAR(%i)' % self.length
def _check_case_sensitive(self, db):
if self.char_binary:
raise ValueError, "%s does not support binary character columns" % db
def _mysqlType(self):
type = self._sqlType()
if self.char_binary:
type += " BINARY"
return type
def _postgresType(self):
self._check_case_sensitive("PostgreSQL")
return super(SOStringLikeCol, self)._postgresType()
def _sqliteType(self):
self._check_case_sensitive("SQLite")
return super(SOStringLikeCol, self)._sqliteType()
def _sybaseType(self):
self._check_case_sensitive("SYBASE")
type = self._sqlType()
if not self.notNone and not self.alternateID:
type += ' NULL'
return type
def _mssqlType(self):
if self.customSQLType is not None:
return self.customSQLType
if not self.length:
if self.connection and self.connection.can_use_max_types():
type = 'VARCHAR(MAX)'
else:
type = 'VARCHAR(4000)'
elif self.varchar:
type = 'VARCHAR(%i)' % self.length
else:
type = 'CHAR(%i)' % self.length
if not self.notNone and not self.alternateID:
type += ' NULL'
return type
def _firebirdType(self):
self._check_case_sensitive("FireBird")
if not self.length:
return 'BLOB SUB_TYPE TEXT'
else:
return self._sqlType()
def _maxdbType(self):
self._check_case_sensitive("SAP DB/MaxDB")
if not self.length:
return 'LONG ASCII'
else:
return self._sqlType()
class StringValidator(SOValidator):
def to_python(self, value, state):
if value is None:
return None
try:
connection = state.connection or state.soObject._connection
binaryType = connection._binaryType
except AttributeError:
binaryType = type(None) # Just a simple workaround
dbEncoding = self.getDbEncoding(state, default='ascii')
if isinstance(value, unicode):
return value.encode(dbEncoding)
if self.dataType and isinstance(value, self.dataType):
return value
if isinstance(value, (str, buffer, binaryType, sqlbuilder.SQLExpression)):
return value
if hasattr(value, '__unicode__'):
return unicode(value).encode(dbEncoding)
raise validators.Invalid("expected a str in the StringCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
from_python = to_python
class SOStringCol(SOStringLikeCol):
def createValidators(self, dataType=None):
return [StringValidator(name=self.name, dataType=dataType)] + \
super(SOStringCol, self).createValidators()
class StringCol(Col):
baseClass = SOStringCol
class NQuoted(sqlbuilder.SQLExpression):
def __init__(self, value):
assert isinstance(value, unicode)
self.value = value
def __hash__(self):
return hash(self.value)
def __sqlrepr__(self, db):
assert db == 'mssql'
return "N" + sqlbuilder.sqlrepr(self.value, db)
class UnicodeStringValidator(SOValidator):
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, (unicode, sqlbuilder.SQLExpression)):
return value
if isinstance(value, str):
return unicode(value, self.getDbEncoding(state))
if isinstance(value, array): # MySQL
return unicode(value.tostring(), self.getDbEncoding(state))
if hasattr(value, '__unicode__'):
return unicode(value)
raise validators.Invalid("expected a str or a unicode in the UnicodeCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
def from_python(self, value, state):
if value is None:
return None
if isinstance(value, (str, sqlbuilder.SQLExpression)):
return value
if isinstance(value, unicode):
try:
connection = state.connection or state.soObject._connection
except AttributeError:
pass
else:
if connection.dbName == 'mssql':
return NQuoted(value)
return value.encode(self.getDbEncoding(state))
if hasattr(value, '__unicode__'):
return unicode(value).encode(self.getDbEncoding(state))
raise validators.Invalid("expected a str or a unicode in the UnicodeCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
class SOUnicodeCol(SOStringLikeCol):
def _mssqlType(self):
if self.customSQLType is not None:
return self.customSQLType
return 'N' + super(SOUnicodeCol, self)._mssqlType()
def createValidators(self):
return [UnicodeStringValidator(name=self.name)] + \
super(SOUnicodeCol, self).createValidators()
class UnicodeCol(Col):
baseClass = SOUnicodeCol
class IntValidator(SOValidator):
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, (int, long, sqlbuilder.SQLExpression)):
return value
for converter, attr_name in (int, '__int__'), (long, '__long__'):
if hasattr(value, attr_name):
try:
return converter(value)
except:
break
raise validators.Invalid("expected an int in the IntCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
from_python = to_python
class SOIntCol(SOCol):
# 3-03 @@: support precision, maybe max and min directly
def __init__(self, **kw):
self.length = kw.pop('length', None)
self.unsigned = bool(kw.pop('unsigned', None))
self.zerofill = bool(kw.pop('zerofill', None))
SOCol.__init__(self, **kw)
def autoConstraints(self):
return [constrs.isInt]
def createValidators(self):
return [IntValidator(name=self.name)] + \
super(SOIntCol, self).createValidators()
def addSQLAttrs(self, str):
_ret = str
if str is None or len(str) < 1:
return None
if self.length >= 1:
_ret = "%s(%d)" % (_ret, self.length)
if self.unsigned:
_ret = _ret + " UNSIGNED"
if self.zerofill:
_ret = _ret + " ZEROFILL"
return _ret
def _sqlType(self):
return self.addSQLAttrs("INT")
class IntCol(Col):
baseClass = SOIntCol
class SOTinyIntCol(SOIntCol):
def _sqlType(self):
return self.addSQLAttrs("TINYINT")
class TinyIntCol(Col):
baseClass = SOTinyIntCol
class SOSmallIntCol(SOIntCol):
def _sqlType(self):
return self.addSQLAttrs("SMALLINT")
class SmallIntCol(Col):
baseClass = SOSmallIntCol
class SOMediumIntCol(SOIntCol):
def _sqlType(self):
return self.addSQLAttrs("MEDIUMINT")
class MediumIntCol(Col):
baseClass = SOMediumIntCol
class SOBigIntCol(SOIntCol):
def _sqlType(self):
return self.addSQLAttrs("BIGINT")
class BigIntCol(Col):
baseClass = SOBigIntCol
class BoolValidator(SOValidator):
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, (bool, sqlbuilder.SQLExpression)):
return value
if isinstance(value, (int, long)) or hasattr(value, '__nonzero__'):
return bool(value)
raise validators.Invalid("expected a bool or an int in the BoolCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
from_python = to_python
class SOBoolCol(SOCol):
def autoConstraints(self):
return [constrs.isBool]
def createValidators(self):
return [BoolValidator(name=self.name)] + \
super(SOBoolCol, self).createValidators()
def _postgresType(self):
return 'BOOL'
def _mysqlType(self):
return "BOOL"
def _sybaseType(self):
return "BIT"
def _mssqlType(self):
return "BIT"
def _firebirdType(self):
return 'INT'
def _maxdbType(self):
return "BOOLEAN"
def _sqliteType(self):
return "BOOLEAN"
class BoolCol(Col):
baseClass = SOBoolCol
class FloatValidator(SOValidator):
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, (float, int, long, sqlbuilder.SQLExpression)):
return value
for converter, attr_name in (float, '__float__'), (int, '__int__'), (long, '__long__'):
if hasattr(value, attr_name):
try:
return converter(value)
except:
break
raise validators.Invalid("expected a float in the FloatCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
from_python = to_python
class SOFloatCol(SOCol):
# 3-03 @@: support precision (e.g., DECIMAL)
def autoConstraints(self):
return [constrs.isFloat]
def createValidators(self):
return [FloatValidator(name=self.name)] + \
super(SOFloatCol, self).createValidators()
def _sqlType(self):
return 'FLOAT'
def _mysqlType(self):
return "DOUBLE PRECISION"
class FloatCol(Col):
baseClass = SOFloatCol
class SOKeyCol(SOCol):
key_type = {int: "INT", str: "TEXT"}
# 3-03 @@: this should have a simplified constructor
# Should provide foreign key information for other DBs.
def __init__(self, **kw):
self.refColumn = kw.pop('refColumn', None)
super(SOKeyCol, self).__init__(**kw)
def _sqlType(self):
return self.key_type[self.soClass.sqlmeta.idType]
def _sybaseType(self):
key_type = {int: "NUMERIC(18,0) NULL", str: "TEXT"}
return key_type[self.soClass.sqlmeta.idType]
def _mssqlType(self):
key_type = {int: "INT NULL", str: "TEXT"}
return key_type[self.soClass.sqlmeta.idType]
class KeyCol(Col):
baseClass = SOKeyCol
class SOForeignKey(SOKeyCol):
def __init__(self, **kw):
foreignKey = kw['foreignKey']
style = kw['soClass'].sqlmeta.style
if kw.get('name'):
kw['origName'] = kw['name']
kw['name'] = style.instanceAttrToIDAttr(kw['name'])
else:
kw['name'] = style.instanceAttrToIDAttr(style.pythonClassToAttr(foreignKey))
super(SOForeignKey, self).__init__(**kw)
def sqliteCreateSQL(self):
sql = SOKeyCol.sqliteCreateSQL(self)
other = findClass(self.foreignKey, self.soClass.sqlmeta.registry)
tName = other.sqlmeta.table
idName = self.refColumn or other.sqlmeta.idName
if self.cascade is not None:
if self.cascade == 'null':
action = 'ON DELETE SET NULL'
elif self.cascade:
action = 'ON DELETE CASCADE'
else:
action = 'ON DELETE RESTRICT'
else:
action = ''
constraint = ('CONSTRAINT %(colName)s_exists '
#'FOREIGN KEY(%(colName)s) '
'REFERENCES %(tName)s(%(idName)s) '
'%(action)s' %
{'tName': tName,
'colName': self.dbName,
'idName': idName,
'action': action})
sql = ' '.join([sql, constraint])
return sql
def postgresCreateSQL(self):
sql = SOKeyCol.postgresCreateSQL(self)
return sql
def postgresCreateReferenceConstraint(self):
sTName = self.soClass.sqlmeta.table
other = findClass(self.foreignKey, self.soClass.sqlmeta.registry)
tName = other.sqlmeta.table
idName = self.refColumn or other.sqlmeta.idName
if self.cascade is not None:
if self.cascade == 'null':
action = 'ON DELETE SET NULL'
elif self.cascade:
action = 'ON DELETE CASCADE'
else:
action = 'ON DELETE RESTRICT'
else:
action = ''
constraint = ('ALTER TABLE %(sTName)s ADD CONSTRAINT %(colName)s_exists '
'FOREIGN KEY (%(colName)s) '
'REFERENCES %(tName)s (%(idName)s) '
'%(action)s' %
{'tName': tName,
'colName': self.dbName,
'idName': idName,
'action': action,
'sTName': sTName})
return constraint
def mysqlCreateReferenceConstraint(self):
sTName = self.soClass.sqlmeta.table
sTLocalName = sTName.split('.')[-1]
other = findClass(self.foreignKey, self.soClass.sqlmeta.registry)
tName = other.sqlmeta.table
idName = self.refColumn or other.sqlmeta.idName
if self.cascade is not None:
if self.cascade == 'null':
action = 'ON DELETE SET NULL'
elif self.cascade:
action = 'ON DELETE CASCADE'
else:
action = 'ON DELETE RESTRICT'
else:
action = ''
constraint = ('ALTER TABLE %(sTName)s ADD CONSTRAINT %(sTLocalName)s_%(colName)s_exists '
'FOREIGN KEY (%(colName)s) '
'REFERENCES %(tName)s (%(idName)s) '
'%(action)s' %
{'tName': tName,
'colName': self.dbName,
'idName': idName,
'action': action,
'sTName': sTName,
'sTLocalName': sTLocalName})
return constraint
def mysqlCreateSQL(self):
return SOKeyCol.mysqlCreateSQL(self)
def sybaseCreateSQL(self):
sql = SOKeyCol.sybaseCreateSQL(self)
other = findClass(self.foreignKey, self.soClass.sqlmeta.registry)
tName = other.sqlmeta.table
idName = self.refColumn or other.sqlmeta.idName
reference = ('REFERENCES %(tName)s(%(idName)s) ' %
{'tName':tName,
'idName':idName})
sql = ' '.join([sql, reference])
return sql
def sybaseCreateReferenceConstraint(self):
# @@: Code from above should be moved here
return None
def mssqlCreateSQL(self, connection=None):
sql = SOKeyCol.mssqlCreateSQL(self, connection)
other = findClass(self.foreignKey, self.soClass.sqlmeta.registry)
tName = other.sqlmeta.table
idName = self.refColumn or other.sqlmeta.idName
reference = ('REFERENCES %(tName)s(%(idName)s) ' %
{'tName':tName,
'idName':idName})
sql = ' '.join([sql, reference])
return sql
def mssqlCreateReferenceConstraint(self):
# @@: Code from above should be moved here
return None
def maxdbCreateSQL(self):
other = findClass(self.foreignKey, self.soClass.sqlmeta.registry)
fidName = self.dbName
#I assume that foreign key name is identical to the id of the reference table
sql = ' '.join([fidName, self._maxdbType()])
tName = other.sqlmeta.table
idName = self.refColumn or other.sqlmeta.idName
sql=sql + ',' + '\n'
sql=sql + 'FOREIGN KEY (%s) REFERENCES %s(%s)'%(fidName,tName,idName)
return sql
def maxdbCreateReferenceConstraint(self):
# @@: Code from above should be moved here
return None
class ForeignKey(KeyCol):
baseClass = SOForeignKey
def __init__(self, foreignKey=None, **kw):
super(ForeignKey, self).__init__(foreignKey=foreignKey, **kw)
class EnumValidator(SOValidator):
def to_python(self, value, state):
if value in self.enumValues:
if isinstance(value, unicode):
dbEncoding = self.getDbEncoding(state)
value = value.encode(dbEncoding)
return value
elif not self.notNone and value is None:
return None
raise validators.Invalid("expected a member of %r in the EnumCol '%s', got %r instead" % \
(self.enumValues, self.name, value), value, state)
from_python = to_python
class SOEnumCol(SOCol):
def __init__(self, **kw):
self.enumValues = kw.pop('enumValues', None)
assert self.enumValues is not None, \
'You must provide an enumValues keyword argument'
super(SOEnumCol, self).__init__(**kw)
def autoConstraints(self):
return [constrs.isString, constrs.InList(self.enumValues)]
def createValidators(self):
return [EnumValidator(name=self.name, enumValues=self.enumValues,
notNone=self.notNone)] + \
super(SOEnumCol, self).createValidators()
def _mysqlType(self):
# We need to map None in the enum expression to an appropriate
# condition on NULL
if None in self.enumValues:
return "ENUM(%s)" % ', '.join([sqlbuilder.sqlrepr(v, 'mysql') for v in self.enumValues if v is not None])
else:
return "ENUM(%s) NOT NULL" % ', '.join([sqlbuilder.sqlrepr(v, 'mysql') for v in self.enumValues])
def _postgresType(self):
length = max(map(self._getlength, self.enumValues))
enumValues = ', '.join([sqlbuilder.sqlrepr(v, 'postgres') for v in self.enumValues])
checkConstraint = "CHECK (%s in (%s))" % (self.dbName, enumValues)
return "VARCHAR(%i) %s" % (length, checkConstraint)
_sqliteType = _postgresType
def _sybaseType(self):
return self._postgresType()
def _mssqlType(self):
return self._postgresType()
def _firebirdType(self):
length = max(map(self._getlength, self.enumValues))
enumValues = ', '.join([sqlbuilder.sqlrepr(v, 'firebird') for v in self.enumValues])
checkConstraint = "CHECK (%s in (%s))" % (self.dbName, enumValues)
#NB. Return a tuple, not a string here
return "VARCHAR(%i)" % (length), checkConstraint
def _maxdbType(self):
raise TypeError("Enum type is not supported on MAX DB")
def _getlength(self, obj):
"""
None counts as 0; everything else uses len()
"""
if obj is None:
return 0
else:
return len(obj)
class EnumCol(Col):
baseClass = SOEnumCol
class SetValidator(SOValidator):
"""
Translates Python tuples into SQL comma-delimited SET strings.
"""
def to_python(self, value, state):
if isinstance(value, str):
return tuple(value.split(","))
raise validators.Invalid("expected a string in the SetCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
def from_python(self, value, state):
if isinstance(value, basestring):
value = (value,)
try:
return ",".join(value)
except:
raise validators.Invalid("expected a string or a sequence of stringsin the SetCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
class SOSetCol(SOCol):
def __init__(self, **kw):
self.setValues = kw.pop('setValues', None)
assert self.setValues is not None, \
'You must provide a setValues keyword argument'
super(SOSetCol, self).__init__(**kw)
def autoConstraints(self):
return [constrs.isString, constrs.InList(self.setValues)]
def createValidators(self):
return [SetValidator(name=self.name, setValues=self.setValues)] + \
super(SOSetCol, self).createValidators()
def _mysqlType(self):
return "SET(%s)" % ', '.join([sqlbuilder.sqlrepr(v, 'mysql') for v in self.setValues])
class SetCol(Col):
baseClass = SOSetCol
class DateTimeValidator(validators.DateValidator):
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, (datetime.datetime, datetime.date, datetime.time, sqlbuilder.SQLExpression)):
return value
if mxdatetime_available:
if isinstance(value, DateTimeType):
# convert mxDateTime instance to datetime
if (self.format.find("%H") >= 0) or (self.format.find("%T")) >= 0:
return datetime.datetime(value.year, value.month, value.day,
value.hour, value.minute, int(value.second))
else:
return datetime.date(value.year, value.month, value.day)
elif isinstance(value, TimeType):
# convert mxTime instance to time
if self.format.find("%d") >= 0:
return datetime.timedelta(seconds=value.seconds)
else:
return datetime.time(value.hour, value.minute, int(value.second))
try:
if self.format.find(".%f") >= 0:
if '.' in value:
_value = value.split('.')
microseconds = _value[-1]
_l = len(microseconds)
if _l < 6:
_value[-1] = '%06d' % int(microseconds)
elif _l > 6:
_value[-1] = microseconds[:6]
if _l != 6:
value = '.'.join(_value)
else:
value += '.0'
return datetime.datetime.strptime(value, self.format)
except:
raise validators.Invalid("expected a date/time string of the '%s' format in the DateTimeCol '%s', got %s %r instead" % \
(self.format, self.name, type(value), value), value, state)
def from_python(self, value, state):
if value is None:
return None
if isinstance(value, (datetime.datetime, datetime.date, datetime.time, sqlbuilder.SQLExpression)):
return value
if hasattr(value, "strftime"):
return value.strftime(self.format)
raise validators.Invalid("expected a datetime in the DateTimeCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
if mxdatetime_available:
class MXDateTimeValidator(validators.DateValidator):
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, (DateTimeType, TimeType, sqlbuilder.SQLExpression)):
return value
if isinstance(value, datetime.datetime):
return DateTime.DateTime(value.year, value.month, value.day,
value.hour, value.minute, value.second)
elif isinstance(value, datetime.date):
return DateTime.Date(value.year, value.month, value.day)
elif isinstance(value, datetime.time):
return DateTime.Time(value.hour, value.minute, value.second)
try:
if self.format.find(".%f") >= 0:
if '.' in value:
_value = value.split('.')
microseconds = _value[-1]
_l = len(microseconds)
if _l < 6:
_value[-1] = '%06d' % int(microseconds)
elif _l > 6:
_value[-1] = microseconds[:6]
if _l != 6:
value = '.'.join(_value)
else:
value += '.0'
value = datetime.datetime.strptime(value, self.format)
return DateTime.DateTime(value.year, value.month, value.day,
value.hour, value.minute, value.second)
except:
raise validators.Invalid("expected a date/time string of the '%s' format in the DateTimeCol '%s', got %s %r instead" % \
(self.format, self.name, type(value), value), value, state)
def from_python(self, value, state):
if value is None:
return None
if isinstance(value, (DateTimeType, TimeType, sqlbuilder.SQLExpression)):
return value
if hasattr(value, "strftime"):
return value.strftime(self.format)
raise validators.Invalid("expected a mxDateTime in the DateTimeCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
class SODateTimeCol(SOCol):
datetimeFormat = '%Y-%m-%d %H:%M:%S.%f'
def __init__(self, **kw):
datetimeFormat = kw.pop('datetimeFormat', None)
if datetimeFormat:
self.datetimeFormat = datetimeFormat
super(SODateTimeCol, self).__init__(**kw)
def createValidators(self):
_validators = super(SODateTimeCol, self).createValidators()
if default_datetime_implementation == DATETIME_IMPLEMENTATION:
validatorClass = DateTimeValidator
elif default_datetime_implementation == MXDATETIME_IMPLEMENTATION:
validatorClass = MXDateTimeValidator
if default_datetime_implementation:
_validators.insert(0, validatorClass(name=self.name, format=self.datetimeFormat))
return _validators
def _mysqlType(self):
return 'DATETIME'
def _postgresType(self):
return 'TIMESTAMP'
def _sybaseType(self):
return 'DATETIME'
def _mssqlType(self):
return 'DATETIME'
def _sqliteType(self):
return 'TIMESTAMP'
def _firebirdType(self):
return 'TIMESTAMP'
def _maxdbType(self):
return 'TIMESTAMP'
class DateTimeCol(Col):
baseClass = SODateTimeCol
@staticmethod
def now():
if default_datetime_implementation == DATETIME_IMPLEMENTATION:
return datetime.datetime.now()
elif default_datetime_implementation == MXDATETIME_IMPLEMENTATION:
return DateTime.now()
else:
assert 0, ("No datetime implementation available "
"(DATETIME_IMPLEMENTATION=%r)"
% DATETIME_IMPLEMENTATION)
class DateValidator(DateTimeValidator):
def to_python(self, value, state):
if isinstance(value, datetime.datetime):
value = value.date()
if isinstance(value, (datetime.date, sqlbuilder.SQLExpression)):
return value
value = super(DateValidator, self).to_python(value, state)
if isinstance(value, datetime.datetime):
value = value.date()
return value
from_python = to_python
class SODateCol(SOCol):
dateFormat = '%Y-%m-%d'
def __init__(self, **kw):
dateFormat = kw.pop('dateFormat', None)
if dateFormat: self.dateFormat = dateFormat
super(SODateCol, self).__init__(**kw)
def createValidators(self):
"""Create a validator for the column. Can be overriden in descendants."""
_validators = super(SODateCol, self).createValidators()
if default_datetime_implementation == DATETIME_IMPLEMENTATION:
validatorClass = DateValidator
elif default_datetime_implementation == MXDATETIME_IMPLEMENTATION:
validatorClass = MXDateTimeValidator
if default_datetime_implementation:
_validators.insert(0, validatorClass(name=self.name, format=self.dateFormat))
return _validators
def _mysqlType(self):
return 'DATE'
def _postgresType(self):
return 'DATE'
def _sybaseType(self):
return self._postgresType()
def _mssqlType(self):
"""
SQL Server doesn't have a DATE data type, to emulate we use a vc(10)
"""
return 'VARCHAR(10)'
def _firebirdType(self):
return 'DATE'
def _maxdbType(self):
return 'DATE'
def _sqliteType(self):
return 'DATE'
class DateCol(Col):
baseClass = SODateCol
class TimeValidator(DateTimeValidator):
def to_python(self, value, state):
if isinstance(value, (datetime.time, sqlbuilder.SQLExpression)):
return value
if isinstance(value, datetime.timedelta):
if value.days:
raise validators.Invalid(
"the value for the TimeCol '%s' must has days=0, it has days=%d" %
(self.name, value.days), value, state)
return datetime.time(*time.gmtime(value.seconds)[3:6])
value = super(TimeValidator, self).to_python(value, state)
if isinstance(value, datetime.datetime):
value = value.time()
return value
from_python = to_python
class SOTimeCol(SOCol):
timeFormat = '%H:%M:%S.%f'
def __init__(self, **kw):
timeFormat = kw.pop('timeFormat', None)
if timeFormat:
self.timeFormat = timeFormat
super(SOTimeCol, self).__init__(**kw)
def createValidators(self):
_validators = super(SOTimeCol, self).createValidators()
if default_datetime_implementation == DATETIME_IMPLEMENTATION:
validatorClass = TimeValidator
elif default_datetime_implementation == MXDATETIME_IMPLEMENTATION:
validatorClass = MXDateTimeValidator
if default_datetime_implementation:
_validators.insert(0, validatorClass(name=self.name, format=self.timeFormat))
return _validators
def _mysqlType(self):
return 'TIME'
def _postgresType(self):
return 'TIME'
def _sybaseType(self):
return 'TIME'
def _sqliteType(self):
return 'TIME'
def _firebirdType(self):
return 'TIME'
def _maxdbType(self):
return 'TIME'
class TimeCol(Col):
baseClass = SOTimeCol
class SOTimestampCol(SODateTimeCol):
"""
Necessary to support MySQL's use of TIMESTAMP versus DATETIME types
"""
def __init__(self, **kw):
if 'default' not in kw:
kw['default'] = None
SOCol.__init__(self, **kw)
def _mysqlType(self):
return 'TIMESTAMP'
class TimestampCol(Col):
baseClass = SOTimestampCol
class TimedeltaValidator(SOValidator):
def to_python(self, value, state):
return value
from_python = to_python
class SOTimedeltaCol(SOCol):
def _postgresType(self):
return 'INTERVAL'
def createValidators(self):
return [TimedeltaValidator(name=self.name)] + \
super(SOTimedeltaCol, self).createValidators()
class TimedeltaCol(Col):
baseClass = SOTimedeltaCol
from decimal import Decimal
class DecimalValidator(SOValidator):
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, (int, long, Decimal, sqlbuilder.SQLExpression)):
return value
if isinstance(value, float):
value = str(value)
try:
connection = state.connection or state.soObject._connection
except AttributeError:
pass
else:
if hasattr(connection, "decimalSeparator"):
value = value.replace(connection.decimalSeparator, ".")
try:
return Decimal(value)
except:
raise validators.Invalid("expected a Decimal in the DecimalCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
def from_python(self, value, state):
if value is None:
return None
if isinstance(value, float):
value = str(value)
if isinstance(value, basestring):
try:
connection = state.connection or state.soObject._connection
except AttributeError:
pass
else:
if hasattr(connection, "decimalSeparator"):
value = value.replace(connection.decimalSeparator, ".")
try:
return Decimal(value)
except:
raise validators.Invalid("can not parse Decimal value '%s' in the DecimalCol from '%s'" %
(value, getattr(state, 'soObject', '(unknown)')), value, state)
if isinstance(value, (int, long, Decimal, sqlbuilder.SQLExpression)):
return value
raise validators.Invalid("expected a Decimal in the DecimalCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
class SODecimalCol(SOCol):
def __init__(self, **kw):
self.size = kw.pop('size', NoDefault)
assert self.size is not NoDefault, \
"You must give a size argument"
self.precision = kw.pop('precision', NoDefault)
assert self.precision is not NoDefault, \
"You must give a precision argument"
super(SODecimalCol, self).__init__(**kw)
def _sqlType(self):
return 'DECIMAL(%i, %i)' % (self.size, self.precision)
def createValidators(self):
return [DecimalValidator(name=self.name)] + \
super(SODecimalCol, self).createValidators()
class DecimalCol(Col):
baseClass = SODecimalCol
class SOCurrencyCol(SODecimalCol):
def __init__(self, **kw):
pushKey(kw, 'size', 10)
pushKey(kw, 'precision', 2)
super(SOCurrencyCol, self).__init__(**kw)
class CurrencyCol(DecimalCol):
baseClass = SOCurrencyCol
class DecimalStringValidator(DecimalValidator):
def to_python(self, value, state):
value = super(DecimalStringValidator, self).to_python(value, state)
if self.precision and isinstance(value, Decimal):
assert value < self.max, \
"Value must be less than %s" % int(self.max)
value = value.quantize(self.precision)
return value
def from_python(self, value, state):
value = super(DecimalStringValidator, self).from_python(value, state)
if isinstance(value, Decimal):
if self.precision:
assert value < self.max, \
"Value must be less than %s" % int(self.max)
value = value.quantize(self.precision)
value = value.to_eng_string()
elif isinstance(value, (int, long)):
value = str(value)
return value
class SODecimalStringCol(SOStringCol):
def __init__(self, **kw):
self.size = kw.pop('size', NoDefault)
assert (self.size is not NoDefault) and (self.size >= 0), \
"You must give a size argument as a positive integer"
self.precision = kw.pop('precision', NoDefault)
assert (self.precision is not NoDefault) and (self.precision >= 0), \
"You must give a precision argument as a positive integer"
kw['length'] = int(self.size) + int(self.precision)
self.quantize = kw.pop('quantize', False)
assert isinstance(self.quantize, bool), \
"quantize argument must be Boolean True/False"
super(SODecimalStringCol, self).__init__(**kw)
def createValidators(self):
if self.quantize:
v = DecimalStringValidator(name=self.name,
precision=Decimal(10) ** (-1 * int(self.precision)),
max=Decimal(10) ** (int(self.size) - int(self.precision)))
else:
v = DecimalStringValidator(name=self.name, precision=0)
return [v] + \
super(SODecimalStringCol, self).createValidators(dataType=Decimal)
class DecimalStringCol(StringCol):
baseClass = SODecimalStringCol
class BinaryValidator(SOValidator):
"""
Validator for binary types.
We're assuming that the per-database modules provide some form
of wrapper type for binary conversion.
"""
_cachedValue = None
def to_python(self, value, state):
if value is None:
return None
try:
connection = state.connection or state.soObject._connection
except AttributeError:
dbName = None
binaryType = type(None) # Just a simple workaround
else:
dbName = connection.dbName
binaryType = connection._binaryType
if isinstance(value, str):
if dbName == "sqlite":
value = connection.module.decode(value)
return value
if isinstance(value, (buffer, binaryType)):
cachedValue = self._cachedValue
if cachedValue and cachedValue[1] == value:
return cachedValue[0]
if isinstance(value, array): # MySQL
return value.tostring()
return str(value) # buffer => string
raise validators.Invalid("expected a string in the BLOBCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
def from_python(self, value, state):
if value is None:
return None
connection = state.connection or state.soObject._connection
binary = connection.createBinary(value)
self._cachedValue = (value, binary)
return binary
class SOBLOBCol(SOStringCol):
def __init__(self, **kw):
# Change the default from 'auto' to False - this is a (mostly) binary column
if 'varchar' not in kw: kw['varchar'] = False
super(SOBLOBCol, self).__init__(**kw)
def createValidators(self):
return [BinaryValidator(name=self.name)] + \
super(SOBLOBCol, self).createValidators()
def _mysqlType(self):
length = self.length
varchar = self.varchar
if length >= 2**24:
return varchar and "LONGTEXT" or "LONGBLOB"
if length >= 2**16:
return varchar and "MEDIUMTEXT" or "MEDIUMBLOB"
if length >= 2**8:
return varchar and "TEXT" or "BLOB"
return varchar and "TINYTEXT" or "TINYBLOB"
def _postgresType(self):
return 'BYTEA'
def _mssqlType(self):
if self.connection and self.connection.can_use_max_types():
return 'VARBINARY(MAX)'
else:
return "IMAGE"
class BLOBCol(StringCol):
baseClass = SOBLOBCol
class PickleValidator(BinaryValidator):
"""
Validator for pickle types. A pickle type is simply a binary type
with hidden pickling, so that we can simply store any kind of
stuff in a particular column.
The support for this relies directly on the support for binary for
your database.
"""
def to_python(self, value, state):
if value is None:
return None
if isinstance(value, unicode):
dbEncoding = self.getDbEncoding(state, default='ascii')
value = value.encode(dbEncoding)
if isinstance(value, str):
return pickle.loads(value)
raise validators.Invalid("expected a pickle string in the PickleCol '%s', got %s %r instead" % \
(self.name, type(value), value), value, state)
def from_python(self, value, state):
if value is None:
return None
return pickle.dumps(value, self.pickleProtocol)
class SOPickleCol(SOBLOBCol):
def __init__(self, **kw):
self.pickleProtocol = kw.pop('pickleProtocol', pickle.HIGHEST_PROTOCOL)
super(SOPickleCol, self).__init__(**kw)
def createValidators(self):
return [PickleValidator(name=self.name,
pickleProtocol=self.pickleProtocol)] + \
super(SOPickleCol, self).createValidators()
def _mysqlType(self):
length = self.length
if length >= 2**24:
return "LONGBLOB"
if length >= 2**16:
return "MEDIUMBLOB"
return "BLOB"
class PickleCol(BLOBCol):
baseClass = SOPickleCol
def pushKey(kw, name, value):
if not name in kw:
kw[name] = value
all = []
for key, value in globals().items():
if isinstance(value, type) and (issubclass(value, (Col, SOCol))):
all.append(key)
__all__.extend(all)
del all