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
|
"""String formatting routines"""
import math
import sys
from rpython.rlib import jit
from rpython.rlib.objectmodel import specialize
from rpython.rlib.rarithmetic import INT_MAX
from rpython.rlib.rfloat import DTSF_ALT, formatd
from rpython.rlib.rstring import StringBuilder, UnicodeBuilder
from rpython.rlib.unroll import unrolling_iterable
from rpython.tool.sourcetools import func_with_new_name
from pypy.interpreter.error import OperationError, oefmt
class BaseStringFormatter(object):
def __init__(self, space, values_w, w_valuedict):
self.space = space
self.fmtpos = 0
self.values_w = values_w
self.values_pos = 0
self.w_valuedict = w_valuedict
def forward(self):
# move current position forward
self.fmtpos += 1
def nextinputvalue(self):
# return the next value in the tuple of input arguments
try:
w_result = self.values_w[self.values_pos]
except IndexError:
raise oefmt(self.space.w_TypeError,
"not enough arguments for format string")
else:
self.values_pos += 1
return w_result
def checkconsumed(self):
if self.values_pos < len(self.values_w) and self.w_valuedict is None:
raise oefmt(self.space.w_TypeError,
"not all arguments converted during string formatting")
def std_wp_int(self, r, prefix=''):
# use self.prec to add some '0' on the left of the number
if self.prec >= 0:
if self.prec > 1000:
raise oefmt(self.space.w_OverflowError,
"formatted integer is too long (precision too "
"large?)")
sign = r[0] == '-'
padding = self.prec - (len(r)-int(sign))
if padding > 0:
if sign:
r = '-' + '0'*padding + r[1:]
else:
r = '0'*padding + r
self.std_wp_number(r, prefix)
def fmt_d(self, w_value):
"int formatting"
r = int_num_helper(self.space, w_value)
self.std_wp_int(r)
def fmt_x(self, w_value):
"hex formatting"
r = hex_num_helper(self.space, w_value)
if self.f_alt:
prefix = '0x'
else:
prefix = ''
self.std_wp_int(r, prefix)
def fmt_X(self, w_value):
"HEX formatting"
r = hex_num_helper(self.space, w_value, fmt_for_error='%X')
if self.f_alt:
prefix = '0X'
else:
prefix = ''
self.std_wp_int(r.upper(), prefix)
def fmt_o(self, w_value):
"oct formatting"
r = oct_num_helper(self.space, w_value)
if self.f_alt:
prefix = '0o'
else:
prefix = ''
self.std_wp_int(r, prefix)
fmt_i = fmt_d
fmt_u = fmt_d
def fmt_e(self, w_value):
self.format_float(w_value, 'e')
def fmt_f(self, w_value):
self.format_float(w_value, 'f')
def fmt_g(self, w_value):
self.format_float(w_value, 'g')
def fmt_E(self, w_value):
self.format_float(w_value, 'E')
def fmt_F(self, w_value):
self.format_float(w_value, 'F')
def fmt_G(self, w_value):
self.format_float(w_value, 'G')
def format_float(self, w_value, char):
space = self.space
x = space.float_w(maybe_float(space, w_value))
if math.isnan(x):
if char in 'EFG':
r = 'NAN'
else:
r = 'nan'
elif math.isinf(x):
if x < 0:
if char in 'EFG':
r = '-INF'
else:
r = '-inf'
else:
if char in 'EFG':
r = 'INF'
else:
r = 'inf'
else:
prec = self.prec
if prec < 0:
prec = 6
if char in 'fF' and x/1e25 > 1e25:
char = chr(ord(char) + 1) # 'f' => 'g'
flags = 0
if self.f_alt:
flags |= DTSF_ALT
r = formatd(x, char, prec, flags)
self.std_wp_number(r)
def std_wp_number(self, r, prefix=''):
raise NotImplementedError
def make_formatter_subclass(do_unicode):
# to build two subclasses of the BaseStringFormatter class,
# each one getting its own subtle differences and RPython types.
if do_unicode:
const = unicode
else:
const = str
class StringFormatter(BaseStringFormatter):
def __init__(self, space, fmt, values_w, w_valuedict):
BaseStringFormatter.__init__(self, space, values_w, w_valuedict)
self.fmt = fmt # either a string or a unicode
def peekchr(self):
# return the 'current' character
try:
return self.fmt[self.fmtpos]
except IndexError:
raise oefmt(self.space.w_ValueError, "incomplete format")
# Only shows up if we've already started inlining format(), so just
# unconditionally unroll this.
@jit.unroll_safe
def getmappingkey(self):
# return the mapping key in a '%(key)s' specifier
fmt = self.fmt
i = self.fmtpos + 1 # first character after '('
i0 = i
pcount = 1
while 1:
try:
c = fmt[i]
except IndexError:
space = self.space
raise oefmt(space.w_ValueError, "incomplete format key")
if c == ')':
pcount -= 1
if pcount == 0:
break
elif c == '(':
pcount += 1
i += 1
self.fmtpos = i + 1 # first character after ')'
return fmt[i0:i]
def getmappingvalue(self, key):
# return the value corresponding to a key in the input dict
space = self.space
if self.w_valuedict is None:
raise oefmt(space.w_TypeError, "format requires a mapping")
if do_unicode:
w_key = space.newunicode(key)
else:
w_key = space.newbytes(key)
return space.getitem(self.w_valuedict, w_key)
def parse_fmt(self):
if self.peekchr() == '(':
w_value = self.getmappingvalue(self.getmappingkey())
else:
w_value = None
self.peel_flags()
self.width = self.peel_num('width', sys.maxint)
if self.width < 0:
# this can happen: '%*s' % (-5, "hi")
self.f_ljust = True
self.width = -self.width
if self.peekchr() == '.':
self.forward()
self.prec = self.peel_num('precision', INT_MAX)
if self.prec < 0:
self.prec = 0 # this can happen: '%.*f' % (-5, 3)
else:
self.prec = -1
c = self.peekchr()
if c == 'h' or c == 'l' or c == 'L':
self.forward()
return w_value
# Same as getmappingkey
@jit.unroll_safe
def peel_flags(self):
self.f_ljust = False
self.f_sign = False
self.f_blank = False
self.f_alt = False
self.f_zero = False
while True:
c = self.peekchr()
if c == '-':
self.f_ljust = True
elif c == '+':
self.f_sign = True
elif c == ' ':
self.f_blank = True
elif c == '#':
self.f_alt = True
elif c == '0':
self.f_zero = True
else:
break
self.forward()
# Same as getmappingkey
@jit.unroll_safe
def peel_num(self, name, maxval):
space = self.space
c = self.peekchr()
if c == '*':
self.forward()
w_value = self.nextinputvalue()
if name == 'width':
return space.int_w(w_value)
elif name == 'precision':
return space.c_int_w(w_value)
else:
assert False
result = 0
while True:
digit = ord(c) - ord('0')
if not (0 <= digit <= 9):
break
if result > (maxval - digit) / 10:
raise oefmt(space.w_ValueError, "%s too big", name)
result = result * 10 + digit
self.forward()
c = self.peekchr()
return result
@jit.look_inside_iff(lambda self: jit.isconstant(self.fmt))
def format(self):
lgt = len(self.fmt) + 4 * len(self.values_w) + 10
if do_unicode:
result = UnicodeBuilder(lgt)
else:
result = StringBuilder(lgt)
self.result = result
while True:
# fast path: consume as many characters as possible
fmt = self.fmt
i = i0 = self.fmtpos
while i < len(fmt):
if fmt[i] == '%':
break
i += 1
else:
result.append_slice(fmt, i0, len(fmt))
break # end of 'fmt' string
result.append_slice(fmt, i0, i)
self.fmtpos = i + 1
# interpret the next formatter
w_value = self.parse_fmt()
c = self.peekchr()
self.forward()
if c == '%':
self.std_wp(const('%'))
continue
if w_value is None:
w_value = self.nextinputvalue()
# dispatch on the formatter
# (this turns into a switch after translation)
for c1 in FORMATTER_CHARS:
if c == c1:
# 'c1' is an annotation constant here,
# so this getattr() is ok
do_fmt = getattr(self, 'fmt_' + c1)
do_fmt(w_value)
break
else:
self.unknown_fmtchar()
self.checkconsumed()
return result.build()
def unknown_fmtchar(self):
space = self.space
c = self.fmt[self.fmtpos - 1]
w_s = space.newunicode(c) if do_unicode else space.newbytes(c)
raise oefmt(space.w_ValueError,
"unsupported format character %R (%s) at index %d",
w_s, hex(ord(c)), self.fmtpos - 1)
@specialize.argtype(1)
def std_wp(self, r):
length = len(r)
if do_unicode and isinstance(r, str):
# convert string to unicode using the default encoding
r = self.space.unicode_w(self.space.newbytes(r))
prec = self.prec
if prec == -1 and self.width == 0:
# fast path
self.result.append(const(r))
return
if prec >= 0 and prec < length:
length = prec # ignore the end of the string if too long
result = self.result
padding = self.width - length
if padding < 0:
padding = 0
assert padding >= 0
if not self.f_ljust and padding > 0:
result.append_multiple_char(const(' '), padding)
# add any padding at the left of 'r'
padding = 0
result.append_slice(r, 0, length) # add 'r' itself
if padding > 0:
result.append_multiple_char(const(' '), padding)
# add any remaining padding at the right
def std_wp_number(self, r, prefix=''):
result = self.result
if len(prefix) == 0 and len(r) >= self.width:
# this is strictly a fast path: no prefix, and no padding
# needed. It is more efficient code both in the non-jit
# case (less testing stuff) and in the jit case (uses only
# result.append(), and no startswith() if not f_sign and
# not f_blank).
if self.f_sign and not r.startswith('-'):
result.append(const('+'))
elif self.f_blank and not r.startswith('-'):
result.append(const(' '))
result.append(const(r))
return
# add a '+' or ' ' sign if necessary
sign = r.startswith('-')
if not sign:
if self.f_sign:
r = '+' + r
sign = True
elif self.f_blank:
r = ' ' + r
sign = True
# do the padding requested by self.width and the flags,
# without building yet another RPython string but directly
# by pushing the pad character into self.result
padding = self.width - len(r) - len(prefix)
if padding <= 0:
padding = 0
if self.f_ljust:
padnumber = '<'
elif self.f_zero:
padnumber = '0'
else:
padnumber = '>'
assert padding >= 0
if padnumber == '>':
result.append_multiple_char(const(' '), padding)
# pad with spaces on the left
if sign:
result.append(const(r[0])) # the sign
result.append(const(prefix)) # the prefix
if padnumber == '0':
result.append_multiple_char(const('0'), padding)
# pad with zeroes
result.append_slice(const(r), int(sign), len(r))
# the rest of the number
if padnumber == '<': # spaces on the right
result.append_multiple_char(const(' '), padding)
def string_formatting(self, w_value):
space = self.space
w_impl = space.lookup(w_value, '__str__')
if w_impl is None:
raise oefmt(space.w_TypeError,
"operand does not support unary str")
w_result = space.get_and_call_function(w_impl, w_value)
if space.isinstance_w(w_result,
space.w_unicode):
raise NeedUnicodeFormattingError
return space.bytes_w(w_result)
def fmt_s(self, w_value):
if not do_unicode:
# on bytes, %s is equivalent to %b
self.fmt_b(w_value)
return
space = self.space
got_unicode = space.isinstance_w(w_value, space.w_unicode)
if not got_unicode:
w_value = space.call_function(space.w_unicode, w_value)
else:
from pypy.objspace.std.unicodeobject import unicode_from_object
w_value = unicode_from_object(space, w_value)
s = space.unicode_w(w_value)
self.std_wp(s)
def fmt_r(self, w_value):
if not do_unicode:
# on bytes, %r is equivalent to %a
self.fmt_a(w_value)
else:
# on unicodes, %r calls repr(), which typically returns
# arbitrary unicode chars if w_value is an arbitrary unicode
# string
w_value = self.space.repr(w_value)
self.std_wp(self.space.unicode_w(w_value))
def fmt_a(self, w_value):
from pypy.objspace.std.unicodeobject import ascii_from_object
w_value = ascii_from_object(self.space, w_value)
# %a calls ascii(), which should return an ascii unicode string
if do_unicode:
value = self.space.unicode_w(w_value)
else:
value = self.space.text_w(w_value)
self.std_wp(value)
def fmt_c(self, w_value):
self.prec = -1 # just because
space = self.space
try:
w_value = space.index(w_value)
except OperationError as e:
if e.async(space):
raise
# otherwise, eats all exceptions, like CPython
else:
n = space.int_w(w_value)
if do_unicode:
try:
c = unichr(n)
except ValueError:
raise oefmt(space.w_OverflowError,
"unicode character code out of range")
self.std_wp(c)
else:
try:
s = chr(n)
except ValueError:
raise oefmt(space.w_OverflowError,
"character code not in range(256)")
self.std_wp(s)
return
if not do_unicode:
if space.isinstance_w(w_value, space.w_bytes):
s = space.bytes_w(w_value)
elif space.isinstance_w(w_value, space.w_bytearray):
s = w_value.buffer_w(space, 0).as_str()
else:
s = ''
if len(s) == 1:
self.std_wp(s)
return
raise oefmt(space.w_TypeError, "%c requires int or single byte")
else:
if space.isinstance_w(w_value, space.w_unicode):
ustr = space.unicode_w(w_value)
if len(ustr) == 1:
self.std_wp(ustr)
return
raise oefmt(space.w_TypeError, "%c requires int or char")
def fmt_b(self, w_value):
if do_unicode:
self.unknown_fmtchar()
space = self.space
# cpython explicitly checks for bytes & bytearray
if space.isinstance_w(w_value, space.w_bytes):
self.std_wp(space.bytes_w(w_value))
return
if space.isinstance_w(w_value, space.w_bytearray):
buf = w_value.buffer_w(space, 0)
# convert the array of the buffer to a py 2 string
self.std_wp(buf.as_str())
return
w_bytes_method = space.lookup(w_value, "__bytes__")
if w_bytes_method is not None:
w_bytes = space.get_and_call_function(w_bytes_method, w_value)
if not space.isinstance_w(w_bytes, space.w_bytes):
raise oefmt(space.w_TypeError,
"__bytes__ returned non-bytes (type '%T')", w_bytes)
self.std_wp(space.bytes_w(w_bytes))
return
raise oefmt(space.w_TypeError,
"requires bytes, or an object that "
"implements __bytes__, not '%T'", w_value)
return StringFormatter
class NeedUnicodeFormattingError(Exception):
pass
StringFormatter = make_formatter_subclass(do_unicode=False)
UnicodeFormatter = make_formatter_subclass(do_unicode=True)
UnicodeFormatter.__name__ = 'UnicodeFormatter'
# an "unrolling" list of all the known format characters,
# collected from which fmt_X() functions are defined in the class
FORMATTER_CHARS = unrolling_iterable(
[_name[-1] for _name in dir(StringFormatter)
if len(_name) == 5 and _name.startswith('fmt_')])
FORMAT_STR = 0
FORMAT_UNICODE = 1
FORMAT_BYTES = 2
FORMAT_BYTEARRAY = 3
def format(space, w_fmt, values_w, w_valuedict, fmt_type):
"Entry point"
if fmt_type != FORMAT_UNICODE:
if fmt_type == FORMAT_BYTEARRAY:
fmt = w_fmt.buffer_w(space, 0).as_str()
else:
fmt = space.bytes_w(w_fmt)
formatter = StringFormatter(space, fmt, values_w, w_valuedict)
try:
result = formatter.format()
except NeedUnicodeFormattingError:
# fall through to the unicode case
pass
else:
if fmt_type == FORMAT_BYTES:
return space.newbytes(result)
elif fmt_type == FORMAT_BYTEARRAY:
return space.newbytearray([c for c in result])
return space.newbytes(result)
fmt = space.unicode_w(w_fmt)
formatter = UnicodeFormatter(space, fmt, values_w, w_valuedict)
result = formatter.format()
return space.newunicode(result)
def mod_format(space, w_format, w_values, fmt_type=FORMAT_STR):
if space.isinstance_w(w_values, space.w_tuple):
values_w = space.fixedview(w_values)
return format(space, w_format, values_w, None, fmt_type)
else:
# we check directly for dict to avoid obscure checking
# in simplest case
if space.isinstance_w(w_values, space.w_dict) or \
_looks_like_a_mapping(space, w_values, fmt_type):
return format(space, w_format, [w_values], w_values, fmt_type)
else:
return format(space, w_format, [w_values], None, fmt_type)
def _looks_like_a_mapping(space, w_x, fmt_type):
if not space.lookup(w_x, '__getitem__'):
return False
if space.isinstance_w(w_x, space.w_unicode):
return False
if fmt_type != FORMAT_UNICODE: # (S6) in http://bugs.python.org/issue28885
if (space.isinstance_w(w_x, space.w_bytes) or
space.isinstance_w(w_x, space.w_bytearray)):
return False
return True
# ____________________________________________________________
# Formatting helpers
def maybe_int(space, w_value):
# make sure that w_value is a wrapped integer
return space.int(w_value)
def maybe_index(space, w_value):
return space.index(w_value)
def maybe_float(space, w_value):
# make sure that w_value is a wrapped float
return space.float(w_value)
def format_num_helper_generator(fmt, digits, decoder=maybe_int,
expect_text="a number"):
def format_num_helper(space, w_value, fmt_for_error=fmt):
if not space.isinstance_w(w_value, space.w_int):
try:
w_value = decoder(space, w_value)
except OperationError:
raise oefmt(space.w_TypeError,
"%s format: %s is required, not %T",
fmt_for_error, expect_text, w_value)
try:
value = space.int_w(w_value)
return fmt % (value,)
except OperationError as operr:
if not operr.match(space, space.w_OverflowError):
raise
num = space.bigint_w(w_value)
return num.format(digits)
return func_with_new_name(format_num_helper,
'base%d_num_helper' % len(digits))
int_num_helper = format_num_helper_generator('%d', '0123456789')
oct_num_helper = format_num_helper_generator('%o', '01234567',
decoder=maybe_index, expect_text="an integer")
hex_num_helper = format_num_helper_generator('%x', '0123456789abcdef',
decoder=maybe_index, expect_text="an integer")
|