mirror of
https://github.com/google/blockly.git
synced 2026-01-04 23:50:12 +01:00
* refactor(generators): Migrate python_generator.js to TypeScript * refactor(generators): Migrate generators/python/* to TypeScript First pass doing very mechanistic migration, not attempting to fix all the resulting type errors. * fix(generators): Fix type errors in generator functions This consists almost entirely of adding casts, so the code output by tsc should be as similar as possible to the pre-migration .js source files. * refactor(generators): Migrate generators/python.js to TypeScript The way the generator functions are added to pythonGenerator.forBlock has been modified so that incorrect generator function signatures will cause tsc to generate a type error. * chore(generator): Format One block protected with // prettier-ignore to preserve careful comment formatting. Where there are repeated concatenations prettier has made a pretty mess of things, but the correct fix is probably to use template literals instead (rather than just locally disabling prettier). This is one of the items in the to-do list in #7600.
This commit is contained in:
Christopher Allen
committed by
GitHub
GitHub
parent
a2b895f7a9
commit
b418907e41
251
generators/python/loops.ts
Normal file
251
generators/python/loops.ts
Normal file
@@ -0,0 +1,251 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright 2012 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @fileoverview Generating Python for loop blocks.
|
||||
*/
|
||||
|
||||
// Former goog.module ID: Blockly.Python.loops
|
||||
|
||||
import * as stringUtils from '../../core/utils/string.js';
|
||||
import type {Block} from '../../core/block.js';
|
||||
import type {ControlFlowInLoopBlock} from '../../blocks/loops.js';
|
||||
import type {PythonGenerator} from './python_generator.js';
|
||||
import {NameType} from '../../core/names.js';
|
||||
import {Order} from './python_generator.js';
|
||||
|
||||
export function controls_repeat_ext(block: Block, generator: PythonGenerator) {
|
||||
// Repeat n times.
|
||||
let repeats;
|
||||
if (block.getField('TIMES')) {
|
||||
// Internal number.
|
||||
repeats = String(parseInt(block.getFieldValue('TIMES'), 10));
|
||||
} else {
|
||||
// External number.
|
||||
repeats = generator.valueToCode(block, 'TIMES', Order.NONE) || '0';
|
||||
}
|
||||
if (stringUtils.isNumber(repeats)) {
|
||||
repeats = parseInt(repeats, 10);
|
||||
} else {
|
||||
repeats = 'int(' + repeats + ')';
|
||||
}
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
const loopVar = generator.nameDB_!.getDistinctName(
|
||||
'count',
|
||||
NameType.VARIABLE,
|
||||
);
|
||||
const code = 'for ' + loopVar + ' in range(' + repeats + '):\n' + branch;
|
||||
return code;
|
||||
}
|
||||
|
||||
export const controls_repeat = controls_repeat_ext;
|
||||
|
||||
export function controls_whileUntil(block: Block, generator: PythonGenerator) {
|
||||
// Do while/until loop.
|
||||
const until = block.getFieldValue('MODE') === 'UNTIL';
|
||||
let argument0 =
|
||||
generator.valueToCode(
|
||||
block,
|
||||
'BOOL',
|
||||
until ? Order.LOGICAL_NOT : Order.NONE,
|
||||
) || 'False';
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
if (until) {
|
||||
argument0 = 'not ' + argument0;
|
||||
}
|
||||
return 'while ' + argument0 + ':\n' + branch;
|
||||
}
|
||||
|
||||
export function controls_for(block: Block, generator: PythonGenerator) {
|
||||
// For loop.
|
||||
const variable0 = generator.getVariableName(block.getFieldValue('VAR'));
|
||||
let argument0: string | number =
|
||||
generator.valueToCode(block, 'FROM', Order.NONE) || '0';
|
||||
let argument1: string | number =
|
||||
generator.valueToCode(block, 'TO', Order.NONE) || '0';
|
||||
let increment: string | number =
|
||||
generator.valueToCode(block, 'BY', Order.NONE) || '1';
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
|
||||
let code = '';
|
||||
let range;
|
||||
|
||||
// Helper functions.
|
||||
const defineUpRange = function () {
|
||||
return generator.provideFunction_(
|
||||
'upRange',
|
||||
`
|
||||
def ${generator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
while start <= stop:
|
||||
yield start
|
||||
start += abs(step)
|
||||
`,
|
||||
);
|
||||
};
|
||||
const defineDownRange = function () {
|
||||
return generator.provideFunction_(
|
||||
'downRange',
|
||||
`
|
||||
def ${generator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
while start >= stop:
|
||||
yield start
|
||||
start -= abs(step)
|
||||
`,
|
||||
);
|
||||
};
|
||||
// Arguments are legal generator code (numbers or strings returned by scrub()).
|
||||
const generateUpDownRange = function (
|
||||
start: string,
|
||||
end: string,
|
||||
inc: string,
|
||||
) {
|
||||
return (
|
||||
'(' +
|
||||
start +
|
||||
' <= ' +
|
||||
end +
|
||||
') and ' +
|
||||
defineUpRange() +
|
||||
'(' +
|
||||
start +
|
||||
', ' +
|
||||
end +
|
||||
', ' +
|
||||
inc +
|
||||
') or ' +
|
||||
defineDownRange() +
|
||||
'(' +
|
||||
start +
|
||||
', ' +
|
||||
end +
|
||||
', ' +
|
||||
inc +
|
||||
')'
|
||||
);
|
||||
};
|
||||
|
||||
if (
|
||||
stringUtils.isNumber(argument0) &&
|
||||
stringUtils.isNumber(argument1) &&
|
||||
stringUtils.isNumber(increment)
|
||||
) {
|
||||
// All parameters are simple numbers.
|
||||
argument0 = Number(argument0);
|
||||
argument1 = Number(argument1);
|
||||
increment = Math.abs(Number(increment));
|
||||
if (argument0 % 1 === 0 && argument1 % 1 === 0 && increment % 1 === 0) {
|
||||
// All parameters are integers.
|
||||
if (argument0 <= argument1) {
|
||||
// Count up.
|
||||
argument1++;
|
||||
if (argument0 === 0 && increment === 1) {
|
||||
// If starting index is 0, omit it.
|
||||
range = argument1;
|
||||
} else {
|
||||
range = argument0 + ', ' + argument1;
|
||||
}
|
||||
// If increment isn't 1, it must be explicit.
|
||||
if (increment !== 1) {
|
||||
range += ', ' + increment;
|
||||
}
|
||||
} else {
|
||||
// Count down.
|
||||
argument1--;
|
||||
range = argument0 + ', ' + argument1 + ', -' + increment;
|
||||
}
|
||||
range = 'range(' + range + ')';
|
||||
} else {
|
||||
// At least one of the parameters is not an integer.
|
||||
if (argument0 < argument1) {
|
||||
range = defineUpRange();
|
||||
} else {
|
||||
range = defineDownRange();
|
||||
}
|
||||
range += '(' + argument0 + ', ' + argument1 + ', ' + increment + ')';
|
||||
}
|
||||
} else {
|
||||
// Cache non-trivial values to variables to prevent repeated look-ups.
|
||||
const scrub = function (arg: string, suffix: string) {
|
||||
if (stringUtils.isNumber(arg)) {
|
||||
// Simple number.
|
||||
arg = String(Number(arg));
|
||||
} else if (!arg.match(/^\w+$/)) {
|
||||
// Not a variable, it's complicated.
|
||||
const varName = generator.nameDB_!.getDistinctName(
|
||||
variable0 + suffix,
|
||||
NameType.VARIABLE,
|
||||
);
|
||||
code += varName + ' = ' + arg + '\n';
|
||||
arg = varName;
|
||||
}
|
||||
return arg;
|
||||
};
|
||||
const startVar = scrub(argument0, '_start');
|
||||
const endVar = scrub(argument1, '_end');
|
||||
const incVar = scrub(increment, '_inc');
|
||||
|
||||
if (typeof startVar === 'number' && typeof endVar === 'number') {
|
||||
if (startVar < endVar) {
|
||||
range = defineUpRange();
|
||||
} else {
|
||||
range = defineDownRange();
|
||||
}
|
||||
range += '(' + startVar + ', ' + endVar + ', ' + incVar + ')';
|
||||
} else {
|
||||
// We cannot determine direction statically.
|
||||
range = generateUpDownRange(startVar, endVar, incVar);
|
||||
}
|
||||
}
|
||||
code += 'for ' + variable0 + ' in ' + range + ':\n' + branch;
|
||||
return code;
|
||||
}
|
||||
|
||||
export function controls_forEach(block: Block, generator: PythonGenerator) {
|
||||
// For each loop.
|
||||
const variable0 = generator.getVariableName(block.getFieldValue('VAR'));
|
||||
const argument0 =
|
||||
generator.valueToCode(block, 'LIST', Order.RELATIONAL) || '[]';
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
const code = 'for ' + variable0 + ' in ' + argument0 + ':\n' + branch;
|
||||
return code;
|
||||
}
|
||||
|
||||
export function controls_flow_statements(
|
||||
block: Block,
|
||||
generator: PythonGenerator,
|
||||
) {
|
||||
// Flow statements: continue, break.
|
||||
let xfix = '';
|
||||
if (generator.STATEMENT_PREFIX) {
|
||||
// Automatic prefix insertion is switched off for this block. Add manually.
|
||||
xfix += generator.injectId(generator.STATEMENT_PREFIX, block);
|
||||
}
|
||||
if (generator.STATEMENT_SUFFIX) {
|
||||
// Inject any statement suffix here since the regular one at the end
|
||||
// will not get executed if the break/continue is triggered.
|
||||
xfix += generator.injectId(generator.STATEMENT_SUFFIX, block);
|
||||
}
|
||||
if (generator.STATEMENT_PREFIX) {
|
||||
const loop = (block as ControlFlowInLoopBlock).getSurroundLoop();
|
||||
if (loop && !loop.suppressPrefixSuffix) {
|
||||
// Inject loop's statement prefix here since the regular one at the end
|
||||
// of the loop will not get executed if 'continue' is triggered.
|
||||
// In the case of 'break', a prefix is needed due to the loop's suffix.
|
||||
xfix += generator.injectId(generator.STATEMENT_PREFIX, loop);
|
||||
}
|
||||
}
|
||||
switch (block.getFieldValue('FLOW')) {
|
||||
case 'BREAK':
|
||||
return xfix + 'break\n';
|
||||
case 'CONTINUE':
|
||||
return xfix + 'continue\n';
|
||||
}
|
||||
throw Error('Unknown flow statement.');
|
||||
}
|
||||
Reference in New Issue
Block a user