糟糕的 1.2.0

功能

• 支持Python 3.3及以上

依赖关系

• python3-dev 包含Python C头文件的本地库

• libmpdec-dev 用于十进制算术的本地库

语言参考

糟糕的程序旨在由商人编写，因此该语言放弃了编程语言中程序员想要的几乎所有功能，以模仿商人理解的东西：流程图。

商人在糟糕的程序中“崩溃”的唯一方式是通过除以零，因为

• 它不是图灵完备的

• 它不能分配内存

• 它不能访问宿主进程或环境

• 它只操作一种类型：任意精度十进制数

• 它的唯一控制流程结构是GOTO

• 它甚至不允许循环！

# input variables:
#
#    flavor:         VANILLA, CHOCOLATE, or STRAWBERRY
#    scoops:         1, 2, etc.
#    cone:           SUGAR or WAFFLE
#    sprinkles:      0 or 1
#    weekday:        MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY

# output variables:
#
#    price:          total price, including tax

let TAX_RATE = 5.3%
let WEEKDAY_DISCOUNT = 25%
let GIVEAWAY_RATE = 1%

@start:
    random! <= GIVEAWAY_RATE => @giveaway_winner
    price = scoops * (flavor == STRAWBERRY ? 1.25 : 1.00)
    price = price + (cone == WAFFLE ? 1.00 : 0.00)
    price = price + (sprinkles * 0.25)
    weekday not in {SATURDAY, SUNDAY} => @apply_weekday_discount
    => @compute_total

@apply_weekday_discount:
    price = price * (1 - WEEKDAY_DISCOUNT)
    => @compute_total

@giveaway_winner:
    price = 0.00

@compute_total:
    price = price * (1 + TAX_RATE)

@start:

price = scoops * flavor == STRAWBERRY ? 1.25 : 1.00

weekday not in {SATURDAY, SUNDAY} => @apply_weekday_discount

=> @compute_total

let PI = 3.14159
let area = PI * r * r

用法

Abymal程序在运行之前必须进行编译。编译器需要知道程序应有权访问的变量名称以及要定义的任何常量的名称和值

ICE_CREAM_VARIABLES = {
    # inputs
    'flavor',
    'scoops',
    'cone',
    'sprinkles',
    'weekday',

    # outputs
    'price',
}

ICE_CREAM_CONSTANTS = {
    # flavors
    'VANILLA': 1,
    'CHOCOLATE': 2,
    'STRAWBERRY': 3,

    # cones
    'SUGAR': 1,
    'WAFFLE': 2,

    # weekdays
    'MONDAY': 1,
    'TUESDAY': 2,
    'WEDNESDAY': 3,
    'THURSDAY': 4,
    'FRIDAY': 5,
    'SATURDAY': 6,
    'SUNDAY': 7,
}

compiled_program, source_map = abysmal.compile(source_code, ICE_CREAM_VARIABLES, ICE_CREAM_CONSTANTS)

现在忽略 abysmal.compile() 返回的第二个值（请参阅测量覆盖率部分以了解其用途）。

接下来，我们需要为编译后的程序创建一个虚拟机来运行

machine = compiled_program.machine()

接下来，我们可以根据需要设置任何变量

# Variables can be set in bulk during reset()...
machine.reset(
    flavor=ICE_CREAM_CONSTANTS['CHOCOLATE'],
    scoops=2,
    cone=ICE_CREAM_CONSTANTS['WAFFLE']
)

# ... or one at a time (though this is less efficient)
machine['sprinkles'] = True  # automatically converted to '1'

最后，我们可以运行机器并检查最终变量值

price = Decimal('0.00')
try:
    machine.run()
    price = round(Decimal(machine['price']), 2)
except abysmal.ExecutionError as ex:
    print('The ice cream pricing algorithm is broken: ' + str(ex))
else:
    print('Two scoops of chocolate ice cream in a waffle cone with sprinkles costs: ${0}'.format(price))

请注意，虚拟机将变量值作为字符串暴露，这些值可能以科学或定点表示法格式化。

变量可以从 int、float、bool、Decimal 和 string 值设置，但在分配时转换为字符串。在运行机器后检查变量时，需要将值转换回 Decimal、float 或您感兴趣的任何数值类型。

随机数

默认情况下，random! 生成介于0和1之间，精度为9位小数的数字，并使用默认的Python PRNG（random.randrange）。

如果您需要更安全的PRNG、不同的精度或您想为了测试目的强制产生某些值，您可以在运行机器之前提供自己的随机数迭代器

# force random! to yield 0, 1, 0, 1, ...
machine.random_number_iterator = itertools.cycle([0, 1])

您返回的值不需要落在任何特定的范围内，但[0, 1]是推荐的，以确保与默认行为的一致性。

错误

abysmal.CompilationError

由 abysmal.compile() 抛出，如果源代码无法编译

abysmal.ExecutionError

由 machine.run() 和 machine.run_with_coverage() 抛出，如果在运行程序时遇到错误；这包括以下条件：除以零、无效的指数运算、堆栈溢出、浮点溢出、浮点下溢、空间不足和无法生成随机数

abysmal.InstructionLimitExceededError

由 machine.run() 和 machine.run_with_coverage() 抛出，如果程序超出其允许的指令计数并被终止；这个错误是 abysmal.ExecutionError 的子类

性能提示

一旦编译，Abysmal程序运行非常快，并且虚拟机已优化以使重复运行不同输入尽可能便宜。

一如既往，确定您的性能目标并在优化之前进行测量。

为了获得最佳性能，请遵循以下提示

def compute_shipping_costs(product, weight, zip_codes, compiled_program):
    shipping_costs = {}
    machine = compiled_program.machine(product=product, weight=weight)
    for zip_code in zip_codes:
        machine.reset(zip=zip_code).run()
        shipping_costs[zip_code] = round(Decimal(machine['shippingCost']), 2)
    return shipping_costs

machine.instruction_limit = 5000

测量覆盖率

除了 run() 之外，虚拟机还公开了一个 run_with_coverage() 方法，它可以与 abysmal.compile() 返回的源映射一起使用，以生成Abysmal程序的覆盖率报告。

coverage_tuples = [
    machine.reset(**test_case_inputs).run_with_coverage()
    for test_case_inputs in test_cases
]
coverage_report = abysmal.get_uncovered_lines(source_map, coverage_tuples)
print('Partially covered lines: ' + ', '.join(map(str, coverage_report.partially_covered_line_numbers)))
print('Totally uncovered lines: ' + ', '.join(map(str, coverage_report.uncovered_line_numbers))

覆盖率如何工作

run_with_coverage() 函数返回一个与编译程序中指令数量相等的 覆盖率元组。覆盖率元组中索引 i 的值将根据指令 i 在程序运行过程中是否被执行而返回 True 或 False。

源映射 是另一个与覆盖率元组长度相同的元组。源映射中索引 i 的值指示生成编译程序指令 i 的源代码中的哪一行或几行。有三种可能性：

• None - 指令不是由任何源代码行直接生成的

• int - 指令由单个源代码行生成

• (int, int, …) - 指令由多行源代码生成（由于使用了行续行符）

安装

注意，在安装 abysmal 库之前，必须安装原生库依赖项。

pip install abysmal

开发

# Install system-level dependencies on Debian/Ubuntu
make setup

# Run unit tests
make test

# Check code cleanliness
make pylint

# Check code coverage
make cover

# Create sdist package
make package