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 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
|
// Copyright 2017 The Bazel Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package starlark
import (
"fmt"
"io"
"log"
"math/big"
"math/bits"
"sort"
"strings"
"sync/atomic"
"time"
"unicode"
"unicode/utf8"
"unsafe"
"go.starlark.net/internal/compile"
"go.starlark.net/internal/spell"
"go.starlark.net/resolve"
"go.starlark.net/syntax"
)
// A Thread contains the state of a Starlark thread,
// such as its call stack and thread-local storage.
// The Thread is threaded throughout the evaluator.
type Thread struct {
// Name is an optional name that describes the thread, for debugging.
Name string
// stack is the stack of (internal) call frames.
stack []*frame
// Print is the client-supplied implementation of the Starlark
// 'print' function. If nil, fmt.Fprintln(os.Stderr, msg) is
// used instead.
Print func(thread *Thread, msg string)
// Load is the client-supplied implementation of module loading.
// Repeated calls with the same module name must return the same
// module environment or error.
// The error message need not include the module name.
//
// See example_test.go for some example implementations of Load.
Load func(thread *Thread, module string) (StringDict, error)
// OnMaxSteps is called when the thread reaches the limit set by SetMaxExecutionSteps.
// The default behavior is to call thread.Cancel("too many steps").
OnMaxSteps func(thread *Thread)
// Steps a count of abstract computation steps executed
// by this thread. It is incremented by the interpreter. It may be used
// as a measure of the approximate cost of Starlark execution, by
// computing the difference in its value before and after a computation.
//
// The precise meaning of "step" is not specified and may change.
Steps, maxSteps uint64
// cancelReason records the reason from the first call to Cancel.
cancelReason *string
// locals holds arbitrary "thread-local" Go values belonging to the client.
// They are accessible to the client but not to any Starlark program.
locals map[string]interface{}
// proftime holds the accumulated execution time since the last profile event.
proftime time.Duration
}
// ExecutionSteps returns the current value of Steps.
func (thread *Thread) ExecutionSteps() uint64 {
return thread.Steps
}
// SetMaxExecutionSteps sets a limit on the number of Starlark
// computation steps that may be executed by this thread. If the
// thread's step counter exceeds this limit, the interpreter calls
// the optional OnMaxSteps function or the default behavior
// of calling thread.Cancel("too many steps").
func (thread *Thread) SetMaxExecutionSteps(max uint64) {
thread.maxSteps = max
}
// Uncancel resets the cancellation state.
//
// Unlike most methods of Thread, it is safe to call Uncancel from any
// goroutine, even if the thread is actively executing.
func (thread *Thread) Uncancel() {
atomic.StorePointer((*unsafe.Pointer)(unsafe.Pointer(&thread.cancelReason)), nil)
}
// Cancel causes execution of Starlark code in the specified thread to
// promptly fail with an EvalError that includes the specified reason.
// There may be a delay before the interpreter observes the cancellation
// if the thread is currently in a call to a built-in function.
//
// Call [Uncancel] to reset the cancellation state.
//
// Unlike most methods of Thread, it is safe to call Cancel from any
// goroutine, even if the thread is actively executing.
func (thread *Thread) Cancel(reason string) {
// Atomically set cancelReason, preserving earlier reason if any.
atomic.CompareAndSwapPointer((*unsafe.Pointer)(unsafe.Pointer(&thread.cancelReason)), nil, unsafe.Pointer(&reason))
}
// SetLocal sets the thread-local value associated with the specified key.
// It must not be called after execution begins.
func (thread *Thread) SetLocal(key string, value interface{}) {
if thread.locals == nil {
thread.locals = make(map[string]interface{})
}
thread.locals[key] = value
}
// Local returns the thread-local value associated with the specified key.
func (thread *Thread) Local(key string) interface{} {
return thread.locals[key]
}
// CallFrame returns a copy of the specified frame of the callstack.
// It should only be used in built-ins called from Starlark code.
// Depth 0 means the frame of the built-in itself, 1 is its caller, and so on.
//
// It is equivalent to CallStack().At(depth), but more efficient.
func (thread *Thread) CallFrame(depth int) CallFrame {
return thread.frameAt(depth).asCallFrame()
}
func (thread *Thread) frameAt(depth int) *frame {
return thread.stack[len(thread.stack)-1-depth]
}
// CallStack returns a new slice containing the thread's stack of call frames.
func (thread *Thread) CallStack() CallStack {
frames := make([]CallFrame, len(thread.stack))
for i, fr := range thread.stack {
frames[i] = fr.asCallFrame()
}
return frames
}
// CallStackDepth returns the number of frames in the current call stack.
func (thread *Thread) CallStackDepth() int { return len(thread.stack) }
// A StringDict is a mapping from names to values, and represents
// an environment such as the global variables of a module.
// It is not a true starlark.Value.
type StringDict map[string]Value
// Keys returns a new sorted slice of d's keys.
func (d StringDict) Keys() []string {
names := make([]string, 0, len(d))
for name := range d {
names = append(names, name)
}
sort.Strings(names)
return names
}
func (d StringDict) String() string {
buf := new(strings.Builder)
buf.WriteByte('{')
sep := ""
for _, name := range d.Keys() {
buf.WriteString(sep)
buf.WriteString(name)
buf.WriteString(": ")
writeValue(buf, d[name], nil)
sep = ", "
}
buf.WriteByte('}')
return buf.String()
}
func (d StringDict) Freeze() {
for _, v := range d {
v.Freeze()
}
}
// Has reports whether the dictionary contains the specified key.
func (d StringDict) Has(key string) bool { _, ok := d[key]; return ok }
// A frame records a call to a Starlark function (including module toplevel)
// or a built-in function or method.
type frame struct {
callable Callable // current function (or toplevel) or built-in
pc uint32 // program counter (Starlark frames only)
locals []Value // local variables (Starlark frames only)
spanStart int64 // start time of current profiler span
}
// Position returns the source position of the current point of execution in this frame.
func (fr *frame) Position() syntax.Position {
switch c := fr.callable.(type) {
case *Function:
// Starlark function
return c.funcode.Position(fr.pc)
case callableWithPosition:
// If a built-in Callable defines
// a Position method, use it.
return c.Position()
}
return syntax.MakePosition(&builtinFilename, 0, 0)
}
var builtinFilename = "<builtin>"
// Function returns the frame's function or built-in.
func (fr *frame) Callable() Callable { return fr.callable }
// A CallStack is a stack of call frames, outermost first.
type CallStack []CallFrame
// At returns a copy of the frame at depth i.
// At(0) returns the topmost frame.
func (stack CallStack) At(i int) CallFrame { return stack[len(stack)-1-i] }
// Pop removes and returns the topmost frame.
func (stack *CallStack) Pop() CallFrame {
last := len(*stack) - 1
top := (*stack)[last]
*stack = (*stack)[:last]
return top
}
// String returns a user-friendly description of the stack.
func (stack CallStack) String() string {
out := new(strings.Builder)
if len(stack) > 0 {
fmt.Fprintf(out, "Traceback (most recent call last):\n")
}
for _, fr := range stack {
fmt.Fprintf(out, " %s: in %s\n", fr.Pos, fr.Name)
}
return out.String()
}
// An EvalError is a Starlark evaluation error and
// a copy of the thread's stack at the moment of the error.
type EvalError struct {
Msg string
CallStack CallStack
cause error
}
// A CallFrame represents the function name and current
// position of execution of an enclosing call frame.
type CallFrame struct {
Name string
Pos syntax.Position
}
func (fr *frame) asCallFrame() CallFrame {
return CallFrame{
Name: fr.Callable().Name(),
Pos: fr.Position(),
}
}
func (thread *Thread) evalError(err error) *EvalError {
return &EvalError{
Msg: err.Error(),
CallStack: thread.CallStack(),
cause: err,
}
}
func (e *EvalError) Error() string { return e.Msg }
// Backtrace returns a user-friendly error message describing the stack
// of calls that led to this error.
func (e *EvalError) Backtrace() string {
// If the topmost stack frame is a built-in function,
// remove it from the stack and add print "Error in fn:".
stack := e.CallStack
suffix := ""
if last := len(stack) - 1; last >= 0 && stack[last].Pos.Filename() == builtinFilename {
suffix = " in " + stack[last].Name
stack = stack[:last]
}
return fmt.Sprintf("%sError%s: %s", stack, suffix, e.Msg)
}
func (e *EvalError) Unwrap() error { return e.cause }
// A Program is a compiled Starlark program.
//
// Programs are immutable, and contain no Values.
// A Program may be created by parsing a source file (see SourceProgram)
// or by loading a previously saved compiled program (see CompiledProgram).
type Program struct {
compiled *compile.Program
}
// CompilerVersion is the version number of the protocol for compiled
// files. Applications must not run programs compiled by one version
// with an interpreter at another version, and should thus incorporate
// the compiler version into the cache key when reusing compiled code.
const CompilerVersion = compile.Version
// Filename returns the name of the file from which this program was loaded.
func (prog *Program) Filename() string { return prog.compiled.Toplevel.Pos.Filename() }
func (prog *Program) String() string { return prog.Filename() }
// NumLoads returns the number of load statements in the compiled program.
func (prog *Program) NumLoads() int { return len(prog.compiled.Loads) }
// Load(i) returns the name and position of the i'th module directly
// loaded by this one, where 0 <= i < NumLoads().
// The name is unresolved---exactly as it appears in the source.
func (prog *Program) Load(i int) (string, syntax.Position) {
id := prog.compiled.Loads[i]
return id.Name, id.Pos
}
// WriteTo writes the compiled module to the specified output stream.
func (prog *Program) Write(out io.Writer) error {
data := prog.compiled.Encode()
_, err := out.Write(data)
return err
}
// ExecFile calls [ExecFileOptions] using [syntax.LegacyFileOptions].
//
// Deprecated: use [ExecFileOptions] with [syntax.FileOptions] instead,
// because this function relies on legacy global variables.
func ExecFile(thread *Thread, filename string, src interface{}, predeclared StringDict) (StringDict, error) {
return ExecFileOptions(syntax.LegacyFileOptions(), thread, filename, src, predeclared)
}
// ExecFileOptions parses, resolves, and executes a Starlark file in the
// specified global environment, which may be modified during execution.
//
// Thread is the state associated with the Starlark thread.
//
// The filename and src parameters are as for syntax.Parse:
// filename is the name of the file to execute,
// and the name that appears in error messages;
// src is an optional source of bytes to use
// instead of filename.
//
// predeclared defines the predeclared names specific to this module.
// Execution does not modify this dictionary, though it may mutate
// its values.
//
// If ExecFileOptions fails during evaluation, it returns an *EvalError
// containing a backtrace.
func ExecFileOptions(opts *syntax.FileOptions, thread *Thread, filename string, src interface{}, predeclared StringDict) (StringDict, error) {
// Parse, resolve, and compile a Starlark source file.
_, mod, err := SourceProgramOptions(opts, filename, src, predeclared.Has)
if err != nil {
return nil, err
}
g, err := mod.Init(thread, predeclared)
g.Freeze()
return g, err
}
// SourceProgram calls [SourceProgramOptions] using [syntax.LegacyFileOptions].
//
// Deprecated: use [SourceProgramOptions] with [syntax.FileOptions] instead,
// because this function relies on legacy global variables.
func SourceProgram(filename string, src interface{}, isPredeclared func(string) bool) (*syntax.File, *Program, error) {
return SourceProgramOptions(syntax.LegacyFileOptions(), filename, src, isPredeclared)
}
// SourceProgramOptions produces a new program by parsing, resolving,
// and compiling a Starlark source file.
// On success, it returns the parsed file and the compiled program.
// The filename and src parameters are as for syntax.Parse.
//
// The isPredeclared predicate reports whether a name is
// a pre-declared identifier of the current module.
// Its typical value is predeclared.Has,
// where predeclared is a StringDict of pre-declared values.
func SourceProgramOptions(opts *syntax.FileOptions, filename string, src interface{}, isPredeclared func(string) bool) (*syntax.File, *Program, error) {
f, err := opts.Parse(filename, src, 0)
if err != nil {
return nil, nil, err
}
prog, err := FileProgram(f, isPredeclared)
return f, prog, err
}
// FileProgram produces a new program by resolving,
// and compiling the Starlark source file syntax tree.
// On success, it returns the compiled program.
//
// Resolving a syntax tree mutates it.
// Do not call FileProgram more than once on the same file.
//
// The isPredeclared predicate reports whether a name is
// a pre-declared identifier of the current module.
// Its typical value is predeclared.Has,
// where predeclared is a StringDict of pre-declared values.
func FileProgram(f *syntax.File, isPredeclared func(string) bool) (*Program, error) {
if err := resolve.File(f, isPredeclared, Universe.Has); err != nil {
return nil, err
}
var pos syntax.Position
if len(f.Stmts) > 0 {
pos = syntax.Start(f.Stmts[0])
} else {
pos = syntax.MakePosition(&f.Path, 1, 1)
}
module := f.Module.(*resolve.Module)
compiled := compile.File(f.Options, f.Stmts, pos, "<toplevel>", module.Locals, module.Globals)
return &Program{compiled}, nil
}
// CompiledProgram produces a new program from the representation
// of a compiled program previously saved by Program.Write.
func CompiledProgram(in io.Reader) (*Program, error) {
data, err := io.ReadAll(in)
if err != nil {
return nil, err
}
compiled, err := compile.DecodeProgram(data)
if err != nil {
return nil, err
}
return &Program{compiled}, nil
}
// Init creates a set of global variables for the program,
// executes the toplevel code of the specified program,
// and returns a new, unfrozen dictionary of the globals.
func (prog *Program) Init(thread *Thread, predeclared StringDict) (StringDict, error) {
toplevel := makeToplevelFunction(prog.compiled, predeclared)
_, err := Call(thread, toplevel, nil, nil)
// Convert the global environment to a map.
// We return a (partial) map even in case of error.
return toplevel.Globals(), err
}
// ExecREPLChunk compiles and executes file f in the specified thread
// and global environment. This is a variant of ExecFile specialized to
// the needs of a REPL, in which a sequence of input chunks, each
// syntactically a File, manipulates the same set of module globals,
// which are not frozen after execution.
//
// This function is intended to support only go.starlark.net/repl.
// Its API stability is not guaranteed.
func ExecREPLChunk(f *syntax.File, thread *Thread, globals StringDict) error {
var predeclared StringDict
// -- variant of FileProgram --
if err := resolve.REPLChunk(f, globals.Has, predeclared.Has, Universe.Has); err != nil {
return err
}
var pos syntax.Position
if len(f.Stmts) > 0 {
pos = syntax.Start(f.Stmts[0])
} else {
pos = syntax.MakePosition(&f.Path, 1, 1)
}
module := f.Module.(*resolve.Module)
compiled := compile.File(f.Options, f.Stmts, pos, "<toplevel>", module.Locals, module.Globals)
prog := &Program{compiled}
// -- variant of Program.Init --
toplevel := makeToplevelFunction(prog.compiled, predeclared)
// Initialize module globals from parameter.
for i, id := range prog.compiled.Globals {
if v := globals[id.Name]; v != nil {
toplevel.module.globals[i] = v
}
}
_, err := Call(thread, toplevel, nil, nil)
// Reflect changes to globals back to parameter, even after an error.
for i, id := range prog.compiled.Globals {
if v := toplevel.module.globals[i]; v != nil {
globals[id.Name] = v
}
}
return err
}
func makeToplevelFunction(prog *compile.Program, predeclared StringDict) *Function {
// Create the Starlark value denoted by each program constant c.
constants := make([]Value, len(prog.Constants))
for i, c := range prog.Constants {
var v Value
switch c := c.(type) {
case int64:
v = MakeInt64(c)
case *big.Int:
v = MakeBigInt(c)
case string:
v = String(c)
case compile.Bytes:
v = Bytes(c)
case float64:
v = Float(c)
default:
log.Panicf("unexpected constant %T: %v", c, c)
}
constants[i] = v
}
return &Function{
funcode: prog.Toplevel,
module: &module{
program: prog,
predeclared: predeclared,
globals: make([]Value, len(prog.Globals)),
constants: constants,
},
}
}
// Eval calls [EvalOptions] using [syntax.LegacyFileOptions].
//
// Deprecated: use [EvalOptions] with [syntax.FileOptions] instead,
// because this function relies on legacy global variables.
func Eval(thread *Thread, filename string, src interface{}, env StringDict) (Value, error) {
return EvalOptions(syntax.LegacyFileOptions(), thread, filename, src, env)
}
// EvalOptions parses, resolves, and evaluates an expression within the
// specified (predeclared) environment.
//
// Evaluation cannot mutate the environment dictionary itself,
// though it may modify variables reachable from the dictionary.
//
// The filename and src parameters are as for syntax.Parse.
//
// If EvalOptions fails during evaluation, it returns an *EvalError
// containing a backtrace.
func EvalOptions(opts *syntax.FileOptions, thread *Thread, filename string, src interface{}, env StringDict) (Value, error) {
expr, err := opts.ParseExpr(filename, src, 0)
if err != nil {
return nil, err
}
f, err := makeExprFunc(opts, expr, env)
if err != nil {
return nil, err
}
return Call(thread, f, nil, nil)
}
// EvalExpr calls [EvalExprOptions] using [syntax.LegacyFileOptions].
//
// Deprecated: use [EvalExprOptions] with [syntax.FileOptions] instead,
// because this function relies on legacy global variables.
func EvalExpr(thread *Thread, expr syntax.Expr, env StringDict) (Value, error) {
return EvalExprOptions(syntax.LegacyFileOptions(), thread, expr, env)
}
// EvalExprOptions resolves and evaluates an expression within the
// specified (predeclared) environment.
// Evaluating a comma-separated list of expressions yields a tuple value.
//
// Resolving an expression mutates it.
// Do not call EvalExprOptions more than once for the same expression.
//
// Evaluation cannot mutate the environment dictionary itself,
// though it may modify variables reachable from the dictionary.
//
// If EvalExprOptions fails during evaluation, it returns an *EvalError
// containing a backtrace.
func EvalExprOptions(opts *syntax.FileOptions, thread *Thread, expr syntax.Expr, env StringDict) (Value, error) {
fn, err := makeExprFunc(opts, expr, env)
if err != nil {
return nil, err
}
return Call(thread, fn, nil, nil)
}
// ExprFunc calls [ExprFuncOptions] using [syntax.LegacyFileOptions].
//
// Deprecated: use [ExprFuncOptions] with [syntax.FileOptions] instead,
// because this function relies on legacy global variables.
func ExprFunc(filename string, src interface{}, env StringDict) (*Function, error) {
return ExprFuncOptions(syntax.LegacyFileOptions(), filename, src, env)
}
// ExprFunc returns a no-argument function
// that evaluates the expression whose source is src.
func ExprFuncOptions(options *syntax.FileOptions, filename string, src interface{}, env StringDict) (*Function, error) {
expr, err := options.ParseExpr(filename, src, 0)
if err != nil {
return nil, err
}
return makeExprFunc(options, expr, env)
}
// makeExprFunc returns a no-argument function whose body is expr.
// The options must be consistent with those used when parsing expr.
func makeExprFunc(opts *syntax.FileOptions, expr syntax.Expr, env StringDict) (*Function, error) {
locals, err := resolve.ExprOptions(opts, expr, env.Has, Universe.Has)
if err != nil {
return nil, err
}
return makeToplevelFunction(compile.Expr(opts, expr, "<expr>", locals), env), nil
}
// The following functions are primitive operations of the byte code interpreter.
// list += iterable
func listExtend(x *List, y Iterable) {
if ylist, ok := y.(*List); ok {
// fast path: list += list
x.elems = append(x.elems, ylist.elems...)
} else {
iter := y.Iterate()
defer iter.Done()
var z Value
for iter.Next(&z) {
x.elems = append(x.elems, z)
}
}
}
// getAttr implements x.dot.
func getAttr(x Value, name string) (Value, error) {
hasAttr, ok := x.(HasAttrs)
if !ok {
return nil, fmt.Errorf("%s has no .%s field or method", x.Type(), name)
}
var errmsg string
v, err := hasAttr.Attr(name)
if err == nil {
if v != nil {
return v, nil // success
}
// (nil, nil) => generic error
errmsg = fmt.Sprintf("%s has no .%s field or method", x.Type(), name)
} else if nsa, ok := err.(NoSuchAttrError); ok {
errmsg = string(nsa)
} else {
return nil, err // return error as is
}
// add spelling hint
if n := spell.Nearest(name, hasAttr.AttrNames()); n != "" {
errmsg = fmt.Sprintf("%s (did you mean .%s?)", errmsg, n)
}
return nil, fmt.Errorf("%s", errmsg)
}
// setField implements x.name = y.
func setField(x Value, name string, y Value) error {
if x, ok := x.(HasSetField); ok {
err := x.SetField(name, y)
if _, ok := err.(NoSuchAttrError); ok {
// No such field: check spelling.
if n := spell.Nearest(name, x.AttrNames()); n != "" {
err = fmt.Errorf("%s (did you mean .%s?)", err, n)
}
}
return err
}
return fmt.Errorf("can't assign to .%s field of %s", name, x.Type())
}
// getIndex implements x[y].
func getIndex(x, y Value) (Value, error) {
switch x := x.(type) {
case Mapping: // dict
z, found, err := x.Get(y)
if err != nil {
return nil, err
}
if !found {
return nil, fmt.Errorf("key %v not in %s", y, x.Type())
}
return z, nil
case Indexable: // string, list, tuple
n := x.Len()
i, err := AsInt32(y)
if err != nil {
return nil, fmt.Errorf("%s index: %s", x.Type(), err)
}
origI := i
if i < 0 {
i += n
}
if i < 0 || i >= n {
return nil, outOfRange(origI, n, x)
}
return x.Index(i), nil
}
return nil, fmt.Errorf("unhandled index operation %s[%s]", x.Type(), y.Type())
}
func outOfRange(i, n int, x Value) error {
if n == 0 {
return fmt.Errorf("index %d out of range: empty %s", i, x.Type())
} else {
return fmt.Errorf("%s index %d out of range [%d:%d]", x.Type(), i, -n, n-1)
}
}
// setIndex implements x[y] = z.
func setIndex(x, y, z Value) error {
switch x := x.(type) {
case HasSetKey:
if err := x.SetKey(y, z); err != nil {
return err
}
case HasSetIndex:
n := x.Len()
i, err := AsInt32(y)
if err != nil {
return err
}
origI := i
if i < 0 {
i += n
}
if i < 0 || i >= n {
return outOfRange(origI, n, x)
}
return x.SetIndex(i, z)
default:
return fmt.Errorf("%s value does not support item assignment", x.Type())
}
return nil
}
// Unary applies a unary operator (+, -, ~, not) to its operand.
func Unary(op syntax.Token, x Value) (Value, error) {
// The NOT operator is not customizable.
if op == syntax.NOT {
return !x.Truth(), nil
}
// Int, Float, and user-defined types
if x, ok := x.(HasUnary); ok {
// (nil, nil) => unhandled
y, err := x.Unary(op)
if y != nil || err != nil {
return y, err
}
}
return nil, fmt.Errorf("unknown unary op: %s %s", op, x.Type())
}
// Binary applies a strict binary operator (not AND or OR) to its operands.
// For equality tests or ordered comparisons, use Compare instead.
func Binary(op syntax.Token, x, y Value) (Value, error) {
switch op {
case syntax.PLUS:
switch x := x.(type) {
case String:
if y, ok := y.(String); ok {
return x + y, nil
}
case Int:
switch y := y.(type) {
case Int:
return x.Add(y), nil
case Float:
xf, err := x.finiteFloat()
if err != nil {
return nil, err
}
return xf + y, nil
}
case Float:
switch y := y.(type) {
case Float:
return x + y, nil
case Int:
yf, err := y.finiteFloat()
if err != nil {
return nil, err
}
return x + yf, nil
}
case *List:
if y, ok := y.(*List); ok {
z := make([]Value, 0, x.Len()+y.Len())
z = append(z, x.elems...)
z = append(z, y.elems...)
return NewList(z), nil
}
case Tuple:
if y, ok := y.(Tuple); ok {
z := make(Tuple, 0, len(x)+len(y))
z = append(z, x...)
z = append(z, y...)
return z, nil
}
}
case syntax.MINUS:
switch x := x.(type) {
case Int:
switch y := y.(type) {
case Int:
return x.Sub(y), nil
case Float:
xf, err := x.finiteFloat()
if err != nil {
return nil, err
}
return xf - y, nil
}
case Float:
switch y := y.(type) {
case Float:
return x - y, nil
case Int:
yf, err := y.finiteFloat()
if err != nil {
return nil, err
}
return x - yf, nil
}
case *Set: // difference
if y, ok := y.(*Set); ok {
iter := y.Iterate()
defer iter.Done()
return x.Difference(iter)
}
}
case syntax.STAR:
switch x := x.(type) {
case Int:
switch y := y.(type) {
case Int:
return x.Mul(y), nil
case Float:
xf, err := x.finiteFloat()
if err != nil {
return nil, err
}
return xf * y, nil
case String:
return stringRepeat(y, x)
case Bytes:
return bytesRepeat(y, x)
case *List:
elems, err := tupleRepeat(Tuple(y.elems), x)
if err != nil {
return nil, err
}
return NewList(elems), nil
case Tuple:
return tupleRepeat(y, x)
}
case Float:
switch y := y.(type) {
case Float:
return x * y, nil
case Int:
yf, err := y.finiteFloat()
if err != nil {
return nil, err
}
return x * yf, nil
}
case String:
if y, ok := y.(Int); ok {
return stringRepeat(x, y)
}
case Bytes:
if y, ok := y.(Int); ok {
return bytesRepeat(x, y)
}
case *List:
if y, ok := y.(Int); ok {
elems, err := tupleRepeat(Tuple(x.elems), y)
if err != nil {
return nil, err
}
return NewList(elems), nil
}
case Tuple:
if y, ok := y.(Int); ok {
return tupleRepeat(x, y)
}
}
case syntax.SLASH:
switch x := x.(type) {
case Int:
xf, err := x.finiteFloat()
if err != nil {
return nil, err
}
switch y := y.(type) {
case Int:
yf, err := y.finiteFloat()
if err != nil {
return nil, err
}
if yf == 0.0 {
return nil, fmt.Errorf("floating-point division by zero")
}
return xf / yf, nil
case Float:
if y == 0.0 {
return nil, fmt.Errorf("floating-point division by zero")
}
return xf / y, nil
}
case Float:
switch y := y.(type) {
case Float:
if y == 0.0 {
return nil, fmt.Errorf("floating-point division by zero")
}
return x / y, nil
case Int:
yf, err := y.finiteFloat()
if err != nil {
return nil, err
}
if yf == 0.0 {
return nil, fmt.Errorf("floating-point division by zero")
}
return x / yf, nil
}
}
case syntax.SLASHSLASH:
switch x := x.(type) {
case Int:
switch y := y.(type) {
case Int:
if y.Sign() == 0 {
return nil, fmt.Errorf("floored division by zero")
}
return x.Div(y), nil
case Float:
xf, err := x.finiteFloat()
if err != nil {
return nil, err
}
if y == 0.0 {
return nil, fmt.Errorf("floored division by zero")
}
return floor(xf / y), nil
}
case Float:
switch y := y.(type) {
case Float:
if y == 0.0 {
return nil, fmt.Errorf("floored division by zero")
}
return floor(x / y), nil
case Int:
yf, err := y.finiteFloat()
if err != nil {
return nil, err
}
if yf == 0.0 {
return nil, fmt.Errorf("floored division by zero")
}
return floor(x / yf), nil
}
}
case syntax.PERCENT:
switch x := x.(type) {
case Int:
switch y := y.(type) {
case Int:
if y.Sign() == 0 {
return nil, fmt.Errorf("integer modulo by zero")
}
return x.Mod(y), nil
case Float:
xf, err := x.finiteFloat()
if err != nil {
return nil, err
}
if y == 0 {
return nil, fmt.Errorf("floating-point modulo by zero")
}
return xf.Mod(y), nil
}
case Float:
switch y := y.(type) {
case Float:
if y == 0.0 {
return nil, fmt.Errorf("floating-point modulo by zero")
}
return x.Mod(y), nil
case Int:
if y.Sign() == 0 {
return nil, fmt.Errorf("floating-point modulo by zero")
}
yf, err := y.finiteFloat()
if err != nil {
return nil, err
}
return x.Mod(yf), nil
}
case String:
return interpolate(string(x), y)
}
case syntax.NOT_IN:
z, err := Binary(syntax.IN, x, y)
if err != nil {
return nil, err
}
return !z.Truth(), nil
case syntax.IN:
switch y := y.(type) {
case *List:
for _, elem := range y.elems {
if eq, err := Equal(elem, x); err != nil {
return nil, err
} else if eq {
return True, nil
}
}
return False, nil
case Tuple:
for _, elem := range y {
if eq, err := Equal(elem, x); err != nil {
return nil, err
} else if eq {
return True, nil
}
}
return False, nil
case Mapping: // e.g. dict
// Ignore error from Get as we cannot distinguish true
// errors (value cycle, type error) from "key not found".
_, found, _ := y.Get(x)
return Bool(found), nil
case *Set:
ok, err := y.Has(x)
return Bool(ok), err
case String:
needle, ok := x.(String)
if !ok {
return nil, fmt.Errorf("'in <string>' requires string as left operand, not %s", x.Type())
}
return Bool(strings.Contains(string(y), string(needle))), nil
case Bytes:
switch needle := x.(type) {
case Bytes:
return Bool(strings.Contains(string(y), string(needle))), nil
case Int:
var b byte
if err := AsInt(needle, &b); err != nil {
return nil, fmt.Errorf("int in bytes: %s", err)
}
return Bool(strings.IndexByte(string(y), b) >= 0), nil
default:
return nil, fmt.Errorf("'in bytes' requires bytes or int as left operand, not %s", x.Type())
}
case rangeValue:
i, err := NumberToInt(x)
if err != nil {
return nil, fmt.Errorf("'in <range>' requires integer as left operand, not %s", x.Type())
}
return Bool(y.contains(i)), nil
}
case syntax.PIPE:
switch x := x.(type) {
case Int:
if y, ok := y.(Int); ok {
return x.Or(y), nil
}
case *Dict: // union
if y, ok := y.(*Dict); ok {
return x.Union(y), nil
}
case *Set: // union
if y, ok := y.(*Set); ok {
iter := Iterate(y)
defer iter.Done()
return x.Union(iter)
}
}
case syntax.AMP:
switch x := x.(type) {
case Int:
if y, ok := y.(Int); ok {
return x.And(y), nil
}
case *Set: // intersection
if y, ok := y.(*Set); ok {
iter := y.Iterate()
defer iter.Done()
return x.Intersection(iter)
}
}
case syntax.CIRCUMFLEX:
switch x := x.(type) {
case Int:
if y, ok := y.(Int); ok {
return x.Xor(y), nil
}
case *Set: // symmetric difference
if y, ok := y.(*Set); ok {
iter := y.Iterate()
defer iter.Done()
return x.SymmetricDifference(iter)
}
}
case syntax.LTLT, syntax.GTGT:
if x, ok := x.(Int); ok {
y, err := AsInt32(y)
if err != nil {
return nil, err
}
if y < 0 {
return nil, fmt.Errorf("negative shift count: %v", y)
}
if op == syntax.LTLT {
if y >= 512 {
return nil, fmt.Errorf("shift count too large: %v", y)
}
return x.Lsh(uint(y)), nil
} else {
return x.Rsh(uint(y)), nil
}
}
default:
// unknown operator
goto unknown
}
// user-defined types
// (nil, nil) => unhandled
if x, ok := x.(HasBinary); ok {
z, err := x.Binary(op, y, Left)
if z != nil || err != nil {
return z, err
}
}
if y, ok := y.(HasBinary); ok {
z, err := y.Binary(op, x, Right)
if z != nil || err != nil {
return z, err
}
}
// unsupported operand types
unknown:
return nil, fmt.Errorf("unknown binary op: %s %s %s", x.Type(), op, y.Type())
}
// It's always possible to overeat in small bites but we'll
// try to stop someone swallowing the world in one gulp.
const maxAlloc = 1 << 30
func tupleRepeat(elems Tuple, n Int) (Tuple, error) {
if len(elems) == 0 {
return nil, nil
}
i, err := AsInt32(n)
if err != nil {
return nil, fmt.Errorf("repeat count %s too large", n)
}
if i < 1 {
return nil, nil
}
// Inv: i > 0, len > 0
of, sz := bits.Mul(uint(len(elems)), uint(i))
if of != 0 || sz >= maxAlloc { // of != 0 => overflow
// Don't print sz.
return nil, fmt.Errorf("excessive repeat (%d * %d elements)", len(elems), i)
}
res := make([]Value, sz)
// copy elems into res, doubling each time
x := copy(res, elems)
for x < len(res) {
copy(res[x:], res[:x])
x *= 2
}
return res, nil
}
func bytesRepeat(b Bytes, n Int) (Bytes, error) {
res, err := stringRepeat(String(b), n)
return Bytes(res), err
}
func stringRepeat(s String, n Int) (String, error) {
if s == "" {
return "", nil
}
i, err := AsInt32(n)
if err != nil {
return "", fmt.Errorf("repeat count %s too large", n)
}
if i < 1 {
return "", nil
}
// Inv: i > 0, len > 0
of, sz := bits.Mul(uint(len(s)), uint(i))
if of != 0 || sz >= maxAlloc { // of != 0 => overflow
// Don't print sz.
return "", fmt.Errorf("excessive repeat (%d * %d elements)", len(s), i)
}
return String(strings.Repeat(string(s), i)), nil
}
// Call calls the function fn with the specified positional and keyword arguments.
func Call(thread *Thread, fn Value, args Tuple, kwargs []Tuple) (Value, error) {
c, ok := fn.(Callable)
if !ok {
return nil, fmt.Errorf("invalid call of non-function (%s)", fn.Type())
}
// Allocate and push a new frame.
var fr *frame
// Optimization: use slack portion of thread.stack
// slice as a freelist of empty frames.
if n := len(thread.stack); n < cap(thread.stack) {
fr = thread.stack[n : n+1][0]
}
if fr == nil {
fr = new(frame)
}
if thread.stack == nil {
// one-time initialization of thread
if thread.maxSteps == 0 {
thread.maxSteps-- // (MaxUint64)
}
}
thread.stack = append(thread.stack, fr) // push
fr.callable = c
thread.beginProfSpan()
// Use defer to ensure that panics from built-ins
// pass through the interpreter without leaving
// it in a bad state.
defer func() {
thread.endProfSpan()
// clear out any references
// TODO(adonovan): opt: zero fr.Locals and
// reuse it if it is large enough.
*fr = frame{}
thread.stack = thread.stack[:len(thread.stack)-1] // pop
}()
result, err := c.CallInternal(thread, args, kwargs)
// Sanity check: nil is not a valid Starlark value.
if result == nil && err == nil {
err = fmt.Errorf("internal error: nil (not None) returned from %s", fn)
}
// Always return an EvalError with an accurate frame.
if err != nil {
if _, ok := err.(*EvalError); !ok {
err = thread.evalError(err)
}
}
return result, err
}
func slice(x, lo, hi, step_ Value) (Value, error) {
sliceable, ok := x.(Sliceable)
if !ok {
return nil, fmt.Errorf("invalid slice operand %s", x.Type())
}
n := sliceable.Len()
step := 1
if step_ != None {
var err error
step, err = AsInt32(step_)
if err != nil {
return nil, fmt.Errorf("invalid slice step: %s", err)
}
if step == 0 {
return nil, fmt.Errorf("zero is not a valid slice step")
}
}
// TODO(adonovan): opt: preallocate result array.
var start, end int
if step > 0 {
// positive stride
// default indices are [0:n].
var err error
start, end, err = indices(lo, hi, n)
if err != nil {
return nil, err
}
if end < start {
end = start // => empty result
}
} else {
// negative stride
// default indices are effectively [n-1:-1], though to
// get this effect using explicit indices requires
// [n-1:-1-n:-1] because of the treatment of -ve values.
start = n - 1
if err := asIndex(lo, n, &start); err != nil {
return nil, fmt.Errorf("invalid start index: %s", err)
}
if start >= n {
start = n - 1
}
end = -1
if err := asIndex(hi, n, &end); err != nil {
return nil, fmt.Errorf("invalid end index: %s", err)
}
if end < -1 {
end = -1
}
if start < end {
start = end // => empty result
}
}
return sliceable.Slice(start, end, step), nil
}
// From Hacker's Delight, section 2.8.
func signum64(x int64) int { return int(uint64(x>>63) | uint64(-x)>>63) }
func signum(x int) int { return signum64(int64(x)) }
// indices converts start_ and end_ to indices in the range [0:len].
// The start index defaults to 0 and the end index defaults to len.
// An index -len < i < 0 is treated like i+len.
// All other indices outside the range are clamped to the nearest value in the range.
// Beware: start may be greater than end.
// This function is suitable only for slices with positive strides.
func indices(start_, end_ Value, len int) (start, end int, err error) {
start = 0
if err := asIndex(start_, len, &start); err != nil {
return 0, 0, fmt.Errorf("invalid start index: %s", err)
}
// Clamp to [0:len].
if start < 0 {
start = 0
} else if start > len {
start = len
}
end = len
if err := asIndex(end_, len, &end); err != nil {
return 0, 0, fmt.Errorf("invalid end index: %s", err)
}
// Clamp to [0:len].
if end < 0 {
end = 0
} else if end > len {
end = len
}
return start, end, nil
}
// asIndex sets *result to the integer value of v, adding len to it
// if it is negative. If v is nil or None, *result is unchanged.
func asIndex(v Value, len int, result *int) error {
if v != nil && v != None {
var err error
*result, err = AsInt32(v)
if err != nil {
return err
}
if *result < 0 {
*result += len
}
}
return nil
}
// setArgs sets the values of the formal parameters of function fn in
// based on the actual parameter values in args and kwargs.
func setArgs(locals []Value, fn *Function, args Tuple, kwargs []Tuple) error {
// This is the general schema of a function:
//
// def f(p1, p2=dp2, p3=dp3, *args, k1, k2=dk2, k3, **kwargs)
//
// The p parameters are non-kwonly, and may be specified positionally.
// The k parameters are kwonly, and must be specified by name.
// The defaults tuple is (dp2, dp3, mandatory, dk2, mandatory).
//
// Arguments are processed as follows:
// - positional arguments are bound to a prefix of [p1, p2, p3].
// - surplus positional arguments are bound to *args.
// - keyword arguments are bound to any of {p1, p2, p3, k1, k2, k3};
// duplicate bindings are rejected.
// - surplus keyword arguments are bound to **kwargs.
// - defaults are bound to each parameter from p2 to k3 if no value was set.
// default values come from the tuple above.
// It is an error if the tuple entry for an unset parameter is 'mandatory'.
// Nullary function?
if fn.NumParams() == 0 {
if nactual := len(args) + len(kwargs); nactual > 0 {
return fmt.Errorf("function %s accepts no arguments (%d given)", fn.Name(), nactual)
}
return nil
}
cond := func(x bool, y, z interface{}) interface{} {
if x {
return y
}
return z
}
// nparams is the number of ordinary parameters (sans *args and **kwargs).
nparams := fn.NumParams()
var kwdict *Dict
if fn.HasKwargs() {
nparams--
kwdict = new(Dict)
locals[nparams] = kwdict
}
if fn.HasVarargs() {
nparams--
}
// nonkwonly is the number of non-kwonly parameters.
nonkwonly := nparams - fn.NumKwonlyParams()
// Too many positional args?
n := len(args)
if len(args) > nonkwonly {
if !fn.HasVarargs() {
return fmt.Errorf("function %s accepts %s%d positional argument%s (%d given)",
fn.Name(),
cond(len(fn.defaults) > fn.NumKwonlyParams(), "at most ", ""),
nonkwonly,
cond(nonkwonly == 1, "", "s"),
len(args))
}
n = nonkwonly
}
// Bind positional arguments to non-kwonly parameters.
for i := 0; i < n; i++ {
locals[i] = args[i]
}
// Bind surplus positional arguments to *args parameter.
if fn.HasVarargs() {
tuple := make(Tuple, len(args)-n)
for i := n; i < len(args); i++ {
tuple[i-n] = args[i]
}
locals[nparams] = tuple
}
// Bind keyword arguments to parameters.
paramIdents := fn.funcode.Locals[:nparams]
for _, pair := range kwargs {
k, v := pair[0].(String), pair[1]
if i := findParam(paramIdents, string(k)); i >= 0 {
if locals[i] != nil {
return fmt.Errorf("function %s got multiple values for parameter %s", fn.Name(), k)
}
locals[i] = v
continue
}
if kwdict == nil {
return fmt.Errorf("function %s got an unexpected keyword argument %s", fn.Name(), k)
}
oldlen := kwdict.Len()
kwdict.SetKey(k, v)
if kwdict.Len() == oldlen {
return fmt.Errorf("function %s got multiple values for parameter %s", fn.Name(), k)
}
}
// Are defaults required?
if n < nparams || fn.NumKwonlyParams() > 0 {
m := nparams - len(fn.defaults) // first default
// Report errors for missing required arguments.
var missing []string
var i int
for i = n; i < m; i++ {
if locals[i] == nil {
missing = append(missing, paramIdents[i].Name)
}
}
// Bind default values to parameters.
for ; i < nparams; i++ {
if locals[i] == nil {
dflt := fn.defaults[i-m]
if _, ok := dflt.(mandatory); ok {
missing = append(missing, paramIdents[i].Name)
continue
}
locals[i] = dflt
}
}
if missing != nil {
return fmt.Errorf("function %s missing %d argument%s (%s)",
fn.Name(), len(missing), cond(len(missing) > 1, "s", ""), strings.Join(missing, ", "))
}
}
return nil
}
func findParam(params []compile.Binding, name string) int {
for i, param := range params {
if param.Name == name {
return i
}
}
return -1
}
// https://github.com/google/starlark-go/blob/master/doc/spec.md#string-interpolation
func interpolate(format string, x Value) (Value, error) {
buf := new(strings.Builder)
index := 0
nargs := 1
if tuple, ok := x.(Tuple); ok {
nargs = len(tuple)
}
for {
i := strings.IndexByte(format, '%')
if i < 0 {
buf.WriteString(format)
break
}
buf.WriteString(format[:i])
format = format[i+1:]
if format != "" && format[0] == '%' {
buf.WriteByte('%')
format = format[1:]
continue
}
var arg Value
if format != "" && format[0] == '(' {
// keyword argument: %(name)s.
format = format[1:]
j := strings.IndexByte(format, ')')
if j < 0 {
return nil, fmt.Errorf("incomplete format key")
}
key := format[:j]
if dict, ok := x.(Mapping); !ok {
return nil, fmt.Errorf("format requires a mapping")
} else if v, found, _ := dict.Get(String(key)); found {
arg = v
} else {
return nil, fmt.Errorf("key not found: %s", key)
}
format = format[j+1:]
} else {
// positional argument: %s.
if index >= nargs {
return nil, fmt.Errorf("not enough arguments for format string")
}
if tuple, ok := x.(Tuple); ok {
arg = tuple[index]
} else {
arg = x
}
}
// NOTE: Starlark does not support any of these optional Python features:
// - optional conversion flags: [#0- +], etc.
// - optional minimum field width (number or *).
// - optional precision (.123 or *)
// - optional length modifier
// conversion type
if format == "" {
return nil, fmt.Errorf("incomplete format")
}
switch c := format[0]; c {
case 's', 'r':
if str, ok := AsString(arg); ok && c == 's' {
buf.WriteString(str)
} else {
writeValue(buf, arg, nil)
}
case 'd', 'i', 'o', 'x', 'X':
i, err := NumberToInt(arg)
if err != nil {
return nil, fmt.Errorf("%%%c format requires integer: %v", c, err)
}
switch c {
case 'd', 'i':
fmt.Fprintf(buf, "%d", i)
case 'o':
fmt.Fprintf(buf, "%o", i)
case 'x':
fmt.Fprintf(buf, "%x", i)
case 'X':
fmt.Fprintf(buf, "%X", i)
}
case 'e', 'f', 'g', 'E', 'F', 'G':
f, ok := AsFloat(arg)
if !ok {
return nil, fmt.Errorf("%%%c format requires float, not %s", c, arg.Type())
}
Float(f).format(buf, c)
case 'c':
switch arg := arg.(type) {
case Int:
// chr(int)
r, err := AsInt32(arg)
if err != nil || r < 0 || r > unicode.MaxRune {
return nil, fmt.Errorf("%%c format requires a valid Unicode code point, got %s", arg)
}
buf.WriteRune(rune(r))
case String:
r, size := utf8.DecodeRuneInString(string(arg))
if size != len(arg) || len(arg) == 0 {
return nil, fmt.Errorf("%%c format requires a single-character string")
}
buf.WriteRune(r)
default:
return nil, fmt.Errorf("%%c format requires int or single-character string, not %s", arg.Type())
}
case '%':
buf.WriteByte('%')
default:
return nil, fmt.Errorf("unknown conversion %%%c", c)
}
format = format[1:]
index++
}
if index < nargs && !is[Mapping](x) {
return nil, fmt.Errorf("too many arguments for format string")
}
return String(buf.String()), nil
}
func is[T any](x any) bool {
_, ok := x.(T)
return ok
}
|