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
|
# encoding: utf-8
"""
Simple type classes, providing validation and format translation for values
stored in XML element attributes. Naming generally corresponds to the simple
type in the associated XML schema.
"""
from __future__ import (
absolute_import, division, print_function, unicode_literals
)
from ..exceptions import InvalidXmlError
from ..shared import Emu, Pt, RGBColor, Twips
class BaseSimpleType(object):
@classmethod
def from_xml(cls, str_value):
return cls.convert_from_xml(str_value)
@classmethod
def to_xml(cls, value):
cls.validate(value)
str_value = cls.convert_to_xml(value)
return str_value
@classmethod
def validate_int(cls, value):
if not isinstance(value, int):
raise TypeError(
"value must be <type 'int'>, got %s" % type(value)
)
@classmethod
def validate_int_in_range(cls, value, min_inclusive, max_inclusive):
cls.validate_int(value)
if value < min_inclusive or value > max_inclusive:
raise ValueError(
"value must be in range %d to %d inclusive, got %d" %
(min_inclusive, max_inclusive, value)
)
@classmethod
def validate_string(cls, value):
if isinstance(value, str):
return value
try:
if isinstance(value, basestring):
return value
except NameError: # means we're on Python 3
pass
raise TypeError(
"value must be a string, got %s" % type(value)
)
class BaseIntType(BaseSimpleType):
@classmethod
def convert_from_xml(cls, str_value):
return int(str_value)
@classmethod
def convert_to_xml(cls, value):
return str(value)
@classmethod
def validate(cls, value):
cls.validate_int(value)
class BaseStringType(BaseSimpleType):
@classmethod
def convert_from_xml(cls, str_value):
return str_value
@classmethod
def convert_to_xml(cls, value):
return value
@classmethod
def validate(cls, value):
cls.validate_string(value)
class BaseStringEnumerationType(BaseStringType):
@classmethod
def validate(cls, value):
cls.validate_string(value)
if value not in cls._members:
raise ValueError(
"must be one of %s, got '%s'" % (cls._members, value)
)
class XsdAnyUri(BaseStringType):
"""
There's a regular expression this is supposed to meet but so far thinking
spending cycles on validating wouldn't be worth it for the number of
programming errors it would catch.
"""
class XsdBoolean(BaseSimpleType):
@classmethod
def convert_from_xml(cls, str_value):
if str_value not in ('1', '0', 'true', 'false'):
raise InvalidXmlError(
"value must be one of '1', '0', 'true' or 'false', got '%s'"
% str_value
)
return str_value in ('1', 'true')
@classmethod
def convert_to_xml(cls, value):
return {True: '1', False: '0'}[value]
@classmethod
def validate(cls, value):
if value not in (True, False):
raise TypeError(
"only True or False (and possibly None) may be assigned, got"
" '%s'" % value
)
class XsdId(BaseStringType):
"""
String that must begin with a letter or underscore and cannot contain any
colons. Not fully validated because not used in external API.
"""
pass
class XsdInt(BaseIntType):
@classmethod
def validate(cls, value):
cls.validate_int_in_range(value, -2147483648, 2147483647)
class XsdLong(BaseIntType):
@classmethod
def validate(cls, value):
cls.validate_int_in_range(
value, -9223372036854775808, 9223372036854775807
)
class XsdString(BaseStringType):
pass
class XsdStringEnumeration(BaseStringEnumerationType):
"""
Set of enumerated xsd:string values.
"""
class XsdToken(BaseStringType):
"""
xsd:string with whitespace collapsing, e.g. multiple spaces reduced to
one, leading and trailing space stripped.
"""
pass
class XsdUnsignedInt(BaseIntType):
@classmethod
def validate(cls, value):
cls.validate_int_in_range(value, 0, 4294967295)
class XsdUnsignedLong(BaseIntType):
@classmethod
def validate(cls, value):
cls.validate_int_in_range(value, 0, 18446744073709551615)
class ST_BrClear(XsdString):
@classmethod
def validate(cls, value):
cls.validate_string(value)
valid_values = ('none', 'left', 'right', 'all')
if value not in valid_values:
raise ValueError(
"must be one of %s, got '%s'" % (valid_values, value)
)
class ST_BrType(XsdString):
@classmethod
def validate(cls, value):
cls.validate_string(value)
valid_values = ('page', 'column', 'textWrapping')
if value not in valid_values:
raise ValueError(
"must be one of %s, got '%s'" % (valid_values, value)
)
class ST_Coordinate(BaseIntType):
@classmethod
def convert_from_xml(cls, str_value):
if 'i' in str_value or 'm' in str_value or 'p' in str_value:
return ST_UniversalMeasure.convert_from_xml(str_value)
return Emu(int(str_value))
@classmethod
def validate(cls, value):
ST_CoordinateUnqualified.validate(value)
class ST_CoordinateUnqualified(XsdLong):
@classmethod
def validate(cls, value):
cls.validate_int_in_range(value, -27273042329600, 27273042316900)
class ST_DecimalNumber(XsdInt):
pass
class ST_DrawingElementId(XsdUnsignedInt):
pass
class ST_HexColor(BaseStringType):
@classmethod
def convert_from_xml(cls, str_value):
if str_value == 'auto':
return ST_HexColorAuto.AUTO
return RGBColor.from_string(str_value)
@classmethod
def convert_to_xml(cls, value):
"""
Keep alpha hex numerals all uppercase just for consistency.
"""
# expecting 3-tuple of ints in range 0-255
return '%02X%02X%02X' % value
@classmethod
def validate(cls, value):
# must be an RGBColor object ---
if not isinstance(value, RGBColor):
raise ValueError(
"rgb color value must be RGBColor object, got %s %s"
% (type(value), value)
)
class ST_HexColorAuto(XsdStringEnumeration):
"""
Value for `w:color/[@val="auto"] attribute setting
"""
AUTO = 'auto'
_members = (AUTO,)
class ST_HpsMeasure(XsdUnsignedLong):
"""
Half-point measure, e.g. 24.0 represents 12.0 points.
"""
@classmethod
def convert_from_xml(cls, str_value):
if 'm' in str_value or 'n' in str_value or 'p' in str_value:
return ST_UniversalMeasure.convert_from_xml(str_value)
return Pt(int(str_value)/2.0)
@classmethod
def convert_to_xml(cls, value):
emu = Emu(value)
half_points = int(emu.pt * 2)
return str(half_points)
class ST_Merge(XsdStringEnumeration):
"""
Valid values for <w:xMerge val=""> attribute
"""
CONTINUE = 'continue'
RESTART = 'restart'
_members = (CONTINUE, RESTART)
class ST_OnOff(XsdBoolean):
@classmethod
def convert_from_xml(cls, str_value):
if str_value not in ('1', '0', 'true', 'false', 'on', 'off'):
raise InvalidXmlError(
"value must be one of '1', '0', 'true', 'false', 'on', or 'o"
"ff', got '%s'" % str_value
)
return str_value in ('1', 'true', 'on')
class ST_PositiveCoordinate(XsdLong):
@classmethod
def convert_from_xml(cls, str_value):
return Emu(int(str_value))
@classmethod
def validate(cls, value):
cls.validate_int_in_range(value, 0, 27273042316900)
class ST_RelationshipId(XsdString):
pass
class ST_SignedTwipsMeasure(XsdInt):
@classmethod
def convert_from_xml(cls, str_value):
if 'i' in str_value or 'm' in str_value or 'p' in str_value:
return ST_UniversalMeasure.convert_from_xml(str_value)
return Twips(int(str_value))
@classmethod
def convert_to_xml(cls, value):
emu = Emu(value)
twips = emu.twips
return str(twips)
class ST_String(XsdString):
pass
class ST_TblLayoutType(XsdString):
@classmethod
def validate(cls, value):
cls.validate_string(value)
valid_values = ('fixed', 'autofit')
if value not in valid_values:
raise ValueError(
"must be one of %s, got '%s'" % (valid_values, value)
)
class ST_TblWidth(XsdString):
@classmethod
def validate(cls, value):
cls.validate_string(value)
valid_values = ('auto', 'dxa', 'nil', 'pct')
if value not in valid_values:
raise ValueError(
"must be one of %s, got '%s'" % (valid_values, value)
)
class ST_TwipsMeasure(XsdUnsignedLong):
@classmethod
def convert_from_xml(cls, str_value):
if 'i' in str_value or 'm' in str_value or 'p' in str_value:
return ST_UniversalMeasure.convert_from_xml(str_value)
return Twips(int(str_value))
@classmethod
def convert_to_xml(cls, value):
emu = Emu(value)
twips = emu.twips
return str(twips)
class ST_UniversalMeasure(BaseSimpleType):
@classmethod
def convert_from_xml(cls, str_value):
float_part, units_part = str_value[:-2], str_value[-2:]
quantity = float(float_part)
multiplier = {
'mm': 36000, 'cm': 360000, 'in': 914400, 'pt': 12700,
'pc': 152400, 'pi': 152400
}[units_part]
emu_value = Emu(int(round(quantity * multiplier)))
return emu_value
class ST_VerticalAlignRun(XsdStringEnumeration):
"""
Valid values for `w:vertAlign/@val`.
"""
BASELINE = 'baseline'
SUPERSCRIPT = 'superscript'
SUBSCRIPT = 'subscript'
_members = (BASELINE, SUPERSCRIPT, SUBSCRIPT)
|