Python学习笔记（水桶谜题代码学习）——应用*符号解包列表所有元素传递给函数用法

原文：http://inventwithpython.com/bigbookpython/project81.html

在这个小游戏中，有三个水桶，容量分别是3升、5升和8升，需要在其中一个水桶中收集正好四升水。规则是：

1、桶只能被清空、完全装满或倒入另一个桶中。

2、把A水桶中的水倒入B水桶，要么把B水桶倒满，要么A桶水量不足，水量不足则倒空

例如，A桶8 升满桶水，把A桶里面的水倒入 空的3升的C桶，会把C倒满有3升，A桶剩余5升。

再如，B桶5升满桶水，A桶8升空，把B桶水倒入A桶，B桶将全部倒入A桶，A桶成5升，B为空。

# ///
# 水桶谜题 
# 
#

import sys

print('''
***水桶谜题***
* 有三个水桶，容量分别是8升/5升/3升，需在其中一个水桶中收集正好四升水。
* 规则是：
* 1、桶只能被清空、完全装满或倒入另一个桶中。
* 2、把A桶水倒入B桶，要么把B桶倒满，要么A桶水量不足，水量不足则倒空。
* 3、例如：A桶有8升水，把A桶水倒入空的3升的C桶，会把C倒满，A桶剩余5升。
* 4、再如：B桶有5升水，A桶8升空，把B桶水倒入A桶，B桶将倒空，A桶成5升
''')

GOAL = 4         # 桶中装恰好4升水才能获胜
step_count = 0   # 记录玩家解决此问题所用的步数

# 每个桶的初始水量，使用一个字典记录
waterInBucket = {'8':0,'5':0,'3':0}

while True:   # 游戏主循环
    # 显示桶内当前水量
    print()
    print(f'请让任意一个水桶中的水正好有 {GOAL} L 。')
    print('当前3个水桶的水量如下：')
    
    waterDisplay = []    # 用于存储表示水或者剩余空间的字符串,打印此列表元素显示3个水桶的盛水状态

    # 8L 水桶
    for i in range(1,9):
        if waterInBucket['8'] < i:
            waterDisplay.append('      ')   # 表示空白
        else:
            waterDisplay.append('wwwwww')   # 表示加水

    # 5L 水桶
    for i in range(1,6):
        if waterInBucket['5'] < i:
            waterDisplay.append('      ')   # 表示空白
        else:
            waterDisplay.append('wwwwww')   # 表示加水
    
    # 3L 水桶
    for i in range(1,4):
        if waterInBucket['3'] < i:
            waterDisplay.append('      ')   # 表示空白
        else:
            waterDisplay.append('wwwwww')   # 表示加水

    # 显示3个桶的状体
    print('''
8|{7}|
7|{6}|
6|{5}|
5|{4}|  5|{12}|
4|{3}|  4|{11}|
3|{2}|  3|{10}|  3|{15}|
2|{1}|  2|{9}|  2|{14}|
1|{0}|  1|{8}|  1|{13}|
 +------+   +------+   +------+
   8L         5L         3L                                              
'''.format(*waterDisplay))    # 解包waterDisplay列表
    
    # 判断是否有满足目标水量的桶
    for water_amount in waterInBucket.values():
        if water_amount == GOAL:
            print(f'恭喜您完成目标！您解决此问题使用了： {step_count} 步。')
            sys.exit()  
    
    # 让玩家选择一个动作来处理一个桶
    print('你可以选择下面的动作：')
    print('  输入 F/f 键回车，来给一个桶加满水。')
    print('  输入 E/e 键回车，清空一个桶。')
    print('  输入 P/p 键回车，把一个桶的水倒入另一个桶（加完或者加满）。')
    print('  输入 Q/q 键回车，将退出系统。')

    while True:   # 不断询问，直到玩家输入有效的动作
        # 玩家输入的都为大写
        player_action = input('>').upper()   
        if player_action.startswith('Q'):
            print('再见，欢迎有空再玩！')
            sys.exit()
        
        if player_action in ('F','E','P'):
            break   # 跳出循环，让玩家选择接下来的动作

        # 玩家没有输入有效的选择，提醒并返回循环
        print('输入无效键，请输入 F,E,P, 或者Q键。')

    # 让玩家选择一个桶
    while True:         # 继续询问，直到玩家选择有效的桶
        print('请输入数字选择一个桶，：8, 5, 3，或者输入Q退出。')
        src_bucket_id = input('>').upper()

        # if src_bucket_id.startswith('Q'):
        #     print('谢谢玩这款游戏。')
        #     sys.exit()
        
        if src_bucket_id in ('8','5','3'):
            break   # 跳出循环，否则循环继续，让玩家继续输入有效的选择
    
    # 执行选择的动作
    if player_action == 'F':
        # 将所选水桶的水量设置为最大容量
        src_bucket_id_size = int(src_bucket_id)  
        waterInBucket[src_bucket_id] = src_bucket_id_size
        step_count += 1  # 玩家执行步数 +1

    elif player_action == 'E':   # 清空水桶
        waterInBucket[src_bucket_id] = 0   
        step_count += 1
        
    elif player_action == 'P':
        # 让玩家选择要倒入水的桶
        while True:  # 继续询问，直到玩家选择有效的桶
            print('请选择要倒入水的桶，输入水桶编号：8, 5 ,或者3')
            dst_bucket_id = input('>').upper()
            if dst_bucket_id in ('8','5','3'):
                break    # 玩家输入了一个有效的水桶退出循环，否则继续循环
        
        dst_bucket_id_size = int(dst_bucket_id)  # 最大容量
        dst_bucket_empty_space = dst_bucket_id_size - waterInBucket[dst_bucket_id]  # 要倒入水的水桶剩余最大容量
        water_in_src_bucket = waterInBucket[src_bucket_id]  # 倒出水的桶的水的容量
        amount_to_pour = min(dst_bucket_empty_space,water_in_src_bucket)  # 实际倒出的水的水量

        # 倒出水的水桶水量更新
        waterInBucket[src_bucket_id] -= amount_to_pour
    
        # 倒入水的水桶水量更新
        waterInBucket[dst_bucket_id] += amount_to_pour

        # 计数
        step_count += 1
    
    elif player_action == 'C':
        pass # 未来可扩展动作

两个知识点：

print('''
8|{7}|
7|{6}|
6|{5}|
5|{4}|  5|{12}|
4|{3}|  4|{11}|
3|{2}|  3|{10}|  3|{15}|
2|{1}|  2|{9}|  2|{14}|
1|{0}|  1|{8}|  1|{13}|
 +------+   +------+   +------+
   8L         5L         3L                                              
'''.format(*waterDisplay))    # 格式化字符串，解包waterDisplay列表，填入相应数值

（1）字符串格式化

上面print()函数打印表示3个水桶及水量的字符串，字符串模板中有16个变量，分别代表3个水桶的每一升水容量，如果是1升水是“wwwwww”（6个'w')，否则是"      "（6个空格），这16个变量取自变量waterDisplay（一个列表），使用format()函数格式化。

（2）元素解包：当你想将列表的每个元素传递给一个函数时，可以使用 *

def add(a, b):  
    return a + b  
  
numbers = [1, 2]  
result = add(*numbers)  # result 的值为 3

上面小游戏代码就是使用了*符号，解包waterDisplay列表，把列表中的所有元素传递给了format()函数，从而格式化3个水桶字符穿。