習題 52: 創(chuàng)建你的 web 游戲

這本書馬上就要結(jié)束了。本章的練習對你是一個真正的挑戰(zhàn)。當你完成以后，你就可以算是一個能力不錯的 Python 初學者了。為了進一步學習，你還需要多讀一些書，多寫一些程序，不過你已經(jīng)具備進一步學習的技能了。接下來的學習就只是時間、動力、以及資源的問題了。

在本章習題中，我們不會去創(chuàng)建一個完整的游戲，取而代之的是我們會為《習題 42》中的游戲創(chuàng)建一個“引擎(engine)”，讓這個游戲能夠在瀏覽器中運行起來。這會涉及到將《習題 42》中的游戲“重構(gòu)(refactor)”，將《習題 47》中的架構(gòu)混合進來，添加自動測試代碼，最后創(chuàng)建一個可以運行游戲的 web 引擎。

這是一節(jié)很龐大的習題。我預測你要花一周到一個月才能完成它。最好的方法是一點一點來，每晚上完成一點，在進行下一步之前確認上一步有正確完成。

重構(gòu)《習題 42》的游戲

你已經(jīng)在兩個練習中修改了 gothonweb 項目，這節(jié)習題中你會再修改一次。這種修改的技術(shù)叫做“重構(gòu)(refactoring)”，或者用我喜歡的講法來說，叫“修修補補(fixing stuff)”。重構(gòu)是一個編程術(shù)語，它指的是清理舊代碼或者為舊代碼添加新功能的過程。你其實已經(jīng)做過這樣的事情了，只不過不知道這個術(shù)語而已。這是寫軟件過程的第二個自然屬性。

你在本節(jié)中要做的，是將《習題 47》中的可以測試的房間地圖，以及《習題 42》中的游戲這兩樣東西歸并到一起，創(chuàng)建一個新的游戲架構(gòu)。游戲的內(nèi)容不會發(fā)生變化，只不過我們會通過“重構(gòu)”讓它有一個更好的架構(gòu)而已。

第一步是將 ex47/game.py 的內(nèi)容復制到 gothonweb/map.py中，然后將 tests/ex47_tests.py 的內(nèi)容復制到 tests/map_tests.py 中，然后再次運行 nosetests，確認他們還能正常工作。

Note

從現(xiàn)在開始我不會再向你展示運行測試的輸出了，我就假設(shè)你回去運行這些測試，而且知道怎樣的輸出是正確的。

將《習題 47》的代碼拷貝完畢后，你就該開始重構(gòu)它，讓它包含《習題 42》中的地圖。我一開始會把基本架構(gòu)為你準備好，然后你需要去完成 map.py 和 map_tests.py 里邊的內(nèi)容。

首先要做的是使用 Room 類來構(gòu)建基本的地圖架構(gòu)：

class Room(object):

    def __init__(self, name, description):
        self.name = name
        self.description = description
        self.paths = {}

    def go(self, direction):
        return self.paths.get(direction, None)

    def add_paths(self, paths):
        self.paths.update(paths)


central_corridor = Room("Central Corridor",
"""
The Gothons of Planet Percal #25 have invaded your ship and destroyed
your entire crew.  You are the last surviving member and your last
mission is to get the neutron destruct bomb from the Weapons Armory,
put it in the bridge, and blow the ship up after getting into an 
escape pod.

You're running down the central corridor to the Weapons Armory when
a Gothon jumps out, red scaly skin, dark grimy teeth, and evil clown costume
flowing around his hate filled body.  He's blocking the door to the
Armory and about to pull a weapon to blast you.
""")


laser_weapon_armory = Room("Laser Weapon Armory",
"""
Lucky for you they made you learn Gothon insults in the academy.
You tell the one Gothon joke you know:
Lbhe zbgure vf fb sng, jura fur fvgf nebhaq gur ubhfr, fur fvgf nebhaq gur ubhfr.
The Gothon stops, tries not to laugh, then busts out laughing and can't move.
While he's laughing you run up and shoot him square in the head
putting him down, then jump through the Weapon Armory door.

You do a dive roll into the Weapon Armory, crouch and scan the room
for more Gothons that might be hiding.  It's dead quiet, too quiet.
You stand up and run to the far side of the room and find the
neutron bomb in its container.  There's a keypad lock on the box
and you need the code to get the bomb out.  If you get the code
wrong 10 times then the lock closes forever and you can't
get the bomb.  The code is 3 digits.
""")


the_bridge = Room("The Bridge",
"""
The container clicks open and the seal breaks, letting gas out.
You grab the neutron bomb and run as fast as you can to the
bridge where you must place it in the right spot.

You burst onto the Bridge with the netron destruct bomb
under your arm and surprise 5 Gothons who are trying to
take control of the ship.  Each of them has an even uglier
clown costume than the last.  They haven't pulled their
weapons out yet, as they see the active bomb under your
arm and don't want to set it off.
""")


escape_pod = Room("Escape Pod",
"""
You point your blaster at the bomb under your arm
and the Gothons put their hands up and start to sweat.
You inch backward to the door, open it, and then carefully
place the bomb on the floor, pointing your blaster at it.
You then jump back through the door, punch the close button
and blast the lock so the Gothons can't get out.
Now that the bomb is placed you run to the escape pod to
get off this tin can.

You rush through the ship desperately trying to make it to
the escape pod before the whole ship explodes.  It seems like
hardly any Gothons are on the ship, so your run is clear of
interference.  You get to the chamber with the escape pods, and
now need to pick one to take.  Some of them could be damaged
but you don't have time to look.  There's 5 pods, which one
do you take?
""")


the_end_winner = Room("The End",
"""
You jump into pod 2 and hit the eject button.
The pod easily slides out into space heading to
the planet below.  As it flies to the planet, you look
back and see your ship implode then explode like a
bright star, taking out the Gothon ship at the same
time.  You won!
""")


the_end_loser = Room("The End",
"""
You jump into a random pod and hit the eject button.
The pod escapes out into the void of space, then
implodes as the hull ruptures, crushing your body
into jam jelly.
"""
)

escape_pod.add_paths({
    '2': the_end_winner,
    '*': the_end_loser
})

generic_death = Room("death", "You died.")

the_bridge.add_paths({
    'throw the bomb': generic_death,
    'slowly place the bomb': escape_pod
})

laser_weapon_armory.add_paths({
    '0132': the_bridge,
    '*': generic_death
})

central_corridor.add_paths({
    'shoot!': generic_death,
    'dodge!': generic_death,
    'tell a joke': laser_weapon_armory
})

START = central_corridor

你會發(fā)現(xiàn)我們的 Room 類和地圖有一些問題：

1. 在進入一個房間以前會打印出一段文字作為房間的描述，我們需要將這些描述和每個房間關(guān)聯(lián)起來，這樣房間的次序就不會被打亂了，這對我們的游戲是一件好事。這些描述本來是在 if-else 結(jié)構(gòu)中的，這是我們后面要修改的東西。
2. 原版游戲中我們使用了專門的代碼來生成一些內(nèi)容，例如炸彈的激活鍵碼，艦艙的選擇等，這次我們做游戲時就先使用默認值好了，不過后面的加分習題里，我會要求你把這些功能再加到游戲中。
3. 我為所有的游戲中的失敗結(jié)尾寫了一個 generic_death，你需要去補全這個函數(shù)。你需要把原版游戲中所有的失敗結(jié)尾都加進去，并確保代碼能正確運行。
4. 我添加了一種新的轉(zhuǎn)換模式，以 "*" 為標記，用來在游戲引擎中實現(xiàn)“catch-all”動作。

等你把上面的代碼基本寫好以后，接下來就是引導你繼續(xù)寫下去的自動測試的內(nèi)容 tests/map_test.py 了：

from nose.tools import *
from gothonweb.map import *

def test_room():
    gold = Room("GoldRoom", 
                """This room has gold in it you can grab. There's a
                door to the north.""")
    assert_equal(gold.name, "GoldRoom")
    assert_equal(gold.paths, {})

def test_room_paths():
    center = Room("Center", "Test room in the center.")
    north = Room("North", "Test room in the north.")
    south = Room("South", "Test room in the south.")

    center.add_paths({'north': north, 'south': south})
    assert_equal(center.go('north'), north)
    assert_equal(center.go('south'), south)
    
def test_map():
    start = Room("Start", "You can go west and down a hole.")
    west = Room("Trees", "There are trees here, you can go east.")
    down = Room("Dungeon", "It's dark down here, you can go up.")

    start.add_paths({'west': west, 'down': down})
    west.add_paths({'east': start})
    down.add_paths({'up': start})

    assert_equal(start.go('west'), west)
    assert_equal(start.go('west').go('east'), start)
    assert_equal(start.go('down').go('up'), start)

def test_gothon_game_map():
    assert_equal(START.go('shoot!'), generic_death)
    assert_equal(START.go('dodge!'), generic_death)

    room = START.go('tell a joke')
    assert_equal(room, laser_weapon_armory)

你在這部分練習中的任務(wù)是完成地圖，并且讓自動測試可以完整地檢查過整個地圖。這包括將所有的 generic_death 對象修正為游戲中實際的失敗結(jié)尾。讓你的代碼成功運行起來，并讓你的測試越全面越好。后面我們會對地圖做一些修改，到時候這些測試將保證修改后的代碼還可以正常工作。

會話(session)和用戶跟蹤

在你的 web 程序運行的某個位置，你需要追蹤一些信息，并將這些信息和用戶的瀏覽器關(guān)聯(lián)起來。在 HTTP 協(xié)議的框架中，web 環(huán)境是“無狀態(tài)(stateless)”的，這意味著你的每一次請求和你其它的請求都是相互獨立的。如果你請求了頁面 A，輸入了一些數(shù)據(jù)，然后點了一個頁面 B 的鏈接，那你在頁面 A 輸入的數(shù)據(jù)就全部消失了。

解決這個問題的方法是為 web 程序建立一個很小的數(shù)據(jù)存儲功能，給每個瀏覽器進程賦予一個獨一無二的數(shù)字，用來跟蹤瀏覽器所作的事情。這個存儲通常用數(shù)據(jù)庫或者存儲在磁盤上的文件來實現(xiàn)。在 lpthw.web 這個小框架中實現(xiàn)這樣的功能是很容易的，以下就是一個這樣的例子：

import web

web.config.debug = False

urls = (
    "/count", "count",
    "/reset", "reset"
)
app = web.application(urls, locals())
store = web.session.DiskStore('sessions')
session = web.session.Session(app, store, initializer={'count': 0})

class count:
    def GET(self):
        session.count += 1
        return str(session.count)

class reset:
    def GET(self):
        session.kill()
        return ""

if __name__ == "__main__":
    app.run()

為了實現(xiàn)這個功能，你需要創(chuàng)建一個 sessions/ 文件夾作為程序的會話存儲位置，創(chuàng)建好以后運行這個程序，然后檢查 /count 頁面，刷新一下這個頁面，看計數(shù)會不會累加上去。關(guān)掉瀏覽器后，程序就會“忘掉”之前的位置，這也是我們的游戲所需的功能。有一種方法可以讓瀏覽器永遠記住一些信息，不過這會讓測試和開發(fā)變得更難。如果你回到 /reset/ 頁面，然后再訪問 /count 頁面，你可以看到你的計數(shù)器被重置了，因為你已經(jīng)把會話殺掉了。

你需要花點時間弄懂這段代碼，注意會話開始時 count 的值是如何設(shè)為 0 的。另外再看看 sessions/ 下面的文件，看你能不能把它們打開。下面是我把一個 Python 會話打開并且解碼的過程：

>>> import pickle
>>> import base64
>>> base64.b64decode(open("sessions/XXXXX").read())
"(dp1\nS'count'\np2\nI1\nsS'ip'\np3\nV127.0.0.1\np4\nsS'session_id'\np5\nS'XXXX'\np6\ns."
>>>
>>> x = base64.b64decode(open("sessions/XXXXX").read())
>>>
>>> pickle.loads(x)
{'count': 1, 'ip': u'127.0.0.1', 'session_id': 'XXXXX'}

所以會話其實就是使用 pickle 和 base64 這些庫寫到磁盤上的字典。存儲和管理會話的方法很多，大概和 Python 的 web 框架那么多，所以了解它們的工作原理并不重要。當然如果你需要調(diào)試或者清空會話時，知道點原理還是有用的。

創(chuàng)建引擎

你應該已經(jīng)寫好了游戲地圖和它的單元測試代碼?，F(xiàn)在我要求你制作一個簡單的游戲引擎，用來讓游戲中的各個房間運轉(zhuǎn)起來，從玩家收集輸入，并且記住玩家到了那一幕。我們將用到你剛學過的會話來制作一個簡單的引擎，讓它可以：

1. 為新用戶啟動新的游戲。
2. 將房間展示給用戶。
3. 接受用戶的輸入。
4. 在游戲中處理用戶的輸入。
5. 顯示游戲的結(jié)果，繼續(xù)游戲的下一幕，知道玩家角色死亡為止。

為了創(chuàng)建這個引擎，你需要將我們久經(jīng)考驗的 bin/app.py 搬過來，創(chuàng)建一個功能完備的、基于會話的游戲引擎。這里的難點是我會先使用基本的 HTML 文件創(chuàng)建一個非常簡單的版本，接下來將由你完成它，基本的引擎是這個樣子的：

import web
from gothonweb import map

urls = (
  '/game', 'GameEngine',
  '/', 'Index',
)

app = web.application(urls, globals())

# little hack so that debug mode works with sessions
if web.config.get('_session') is None:
    store = web.session.DiskStore('sessions')
    session = web.session.Session(app, store,
                                  initializer={'room': None})
    web.config._session = session
else:
    session = web.config._session

render = web.template.render('templates/', base="layout")


class Index(object):
    def GET(self):
        # this is used to "setup" the session with starting values
        session.room = map.START
        web.seeother("/game")


class GameEngine(object):

    def GET(self):
        if session.room:
            return render.show_room(room=session.room)
        else:
            # why is there here? do you need it?
            return render.you_died()

    def POST(self):
        form = web.input(action=None)

        # there is a bug here, can you fix it?
        if session.room and form.action:
            session.room = session.room.go(form.action)

        web.seeother("/game")

if __name__ == "__main__":
    app.run()

這個腳本里你可以看到更多的新東西，不過了不起的事情是，整個基于網(wǎng)頁的游戲引擎只要一個小文件就可以做到了。這段腳本里最有技術(shù)含量的事情就是將會話帶回來的那幾行，這對于調(diào)試模式下的代碼重載是必須的，否則每次你刷新網(wǎng)頁，會話就會消失，游戲也不會再繼續(xù)了。

在你運行 bin/app.py 之前，你需要修改 PYTHONPATH 環(huán)境變量。不知道什么是環(huán)境變量？為了運行一個最基本的 Python 程序，你就得學會環(huán)境變量，Python 的這一點確實有點挫。不過沒辦法，用 Python 的人就喜歡這樣：

在你的命令行終端，輸入下面的內(nèi)容：

export PYTHONPATH=$PYTHONPATH:.

如果你用的是 Windows，那就在 PowerShell 中輸入以下內(nèi)容:

$env:PYTHONPATH = "$env:PYTHONPATH;."

你只要針對每一個命令行會話界面輸入一次就可以了，不過如果你運行 Python 代碼時看到了 import 錯誤，那你就需要去執(zhí)行一下上面的命令，或者也許是因為你上次執(zhí)行的 有錯才導致 import 錯誤的。

接下來你需要刪掉 templates/hello_form.html 和 templates/index.html，然后重新創(chuàng)建上面代碼中提到的兩個模板。這里是一個非常簡單的 templates/show_room.html 供你參考：

$def with (room)

<h1> $room.name </h1>

<pre>
$room.description
</pre>

$if room.name == "death":
    <p><a href="/">Play Again?</a></p>
$else:
    <p>
    <form action="/game" method="POST">
        - <input type="text" name="action"> <input type="SUBMIT">
    </form>
    </p>

這就用來顯示游戲中的房間的模板。接下來，你需要在用戶跑到地圖的邊界時，用一個 模板告訴用戶他的角色的死亡信息，也就是 templates/you_died.html 這個模板：

<h1>You Died!</h1>

<p>Looks like you bit the dust.</p>
<p><a href="/">Play Again</a></p>

準備好了這些文件，你現(xiàn)在可以做下面的事情了：

1. 讓測試代碼 tests/app_tests.py 再次運行起來，這樣你就可以去測試這個游戲。由于會話的存在，你可能頂多只能實現(xiàn)幾次點擊，不過你應該可以做出一些基本的測試來。
2. 刪除 sessions/* 下的文件，再重新運行一遍游戲，確認游戲是從一開始運行起來的。
3. 執(zhí)行 python bin/app.py 腳本，試玩一下你的游戲。

你需要和往常一樣刷新和修正你的游戲，慢慢修改游戲的 HTML 文件和引擎，直到你實現(xiàn)游戲需要的所有功能為止。

你的期末考試

你有沒有覺著我一下子給了你超多的信息呢？那就對了，我想要你在學習技能的同時可以有一些可以用來鼓搗的東西。為了完成這節(jié)習題，我將給你最后一套需要你自己完成的練習。你將注意到，到目前為止你寫的游戲并不是很好，這只是你的第一版代碼而已。你現(xiàn)在的任務(wù)是讓游戲更加完善，實現(xiàn)下面的這些功能：

1. 修正代碼中所有我提到和沒提到的 bug，如果你發(fā)現(xiàn)了新的 bug，你可以告訴我。
2. 改進所有的自動測試，讓你可以測試更多的內(nèi)容，直到你可以不用瀏覽器就能測到所有的內(nèi)容為止。
3. 讓 HTML 頁面看上去更美觀一些。
4. 研究一下網(wǎng)頁登錄系統(tǒng)，為這個程序創(chuàng)建一個登錄界面，這樣人們就可以登錄這個游戲，并且可以保存游戲高分。
5. 完成游戲地圖，盡可能地把游戲做大，功能做全。
6. 給用戶一個“幫助系統(tǒng)”，讓他們可以查詢每個房間里可以執(zhí)行哪些命令。
7. 為你的游戲添加新功能，想到什么功能就添加什么功能。
8. 創(chuàng)建多個地圖，讓用戶可以選擇他們想要玩的一張來進行游戲。你的 bin/app.py 應該可以運行提供給它的任意的地圖，這樣你的引擎就可以支持多個不同的游戲。
9. 最后，使用你在習題 48 和 49 中學到的東西來創(chuàng)建一個更好的輸入處理器。你手頭已經(jīng)有了大部分必要的代碼，你只需要改進語法，讓它和你的輸入表單以及游戲引擎掛鉤即可。

祝你好運！