使用 Python 函數來最大程度地減少重複任務編碼工作量。

-- Seth Kenlon（作者）

你是否對函數、類、方法、庫和模塊等花哨的編程術語感到困惑？你是否在與變量作用域鬥爭？無論你是自學成才的還是經過正式培訓的程序員，代碼的模塊化都會令人困惑。但是類和庫鼓勵模塊化代碼，因為模塊化代碼意味著只需構建一個多用途代碼塊集合，就可以在許多項目中使用它們來減少編碼工作量。換句話說，如果你按照本文對 Python 函數的研究，你將找到更聰明的工作方法，這意味著更少的工作。

本文假定你對 Python 很熟（LCTT 譯註：稍微熟悉就可以），並且可以編寫和運行一個簡單的腳本。如果你還沒有使用過 Python，請首先閱讀我的文章： Python 簡介 。

函數

函數是邁向模塊化過程中重要的一步，因為它們是形式化的重複方法。如果在你的程序中，有一個任務需要反覆執行，那麼你可以將代碼放入一個函數中，根據需要隨時調用該函數。這樣，你只需編寫一次代碼，就可以隨意使用它。

以下一個簡單函數的示例：

#!/usr/bin/env python3
import time
def Timer():
 print("Time is " + str(time.time() ))

創建一個名為 mymodularity 的目錄，並將以上函數代碼保存為該目錄下的 timestamp.py。

除了這個函數，在 mymodularity 目錄中創建一個名為 __init__.py 的文件，你可以在文件管理器或 bash shell 中執行此操作：

$ touch mymodularity/__init__.py

現在，你已經創建了屬於你自己的 Python 庫（Python 中稱為“模塊”），名為 mymodularity。它不是一個特別有用的模塊，因為它所做的只是導入 time 模塊並打印一個時間戳，但這只是一個開始。

要使用你的函數，像對待任何其他 Python 模塊一樣對待它。以下是一個小應用，它使用你的 mymodularity 軟件包來測試 Python sleep() 函數的準確性。將此文件保存為 sleeptest.py，注意要在 mymodularity 文件夾 之外，因為如果你將它保存在 mymodularity 裡面，那麼它將成為你的包中的一個模塊，你肯定不希望這樣。

#!/usr/bin/env python3
import time
from mymodularity import timestamp
print("Testing Python sleep()...")
# modularity 

timestamp.Timer()
time.sleep(3)
timestamp.Timer()

在這個簡單的腳本中，你從 mymodularity 包中調用 timestamp 模塊兩次。從包中導入模塊時，通常的語法是從包中導入你所需的模塊，然後使用 模塊名稱 + 一個點 + 要調用的函數名（例如 timestamp.Timer()）。

你調用了兩次 Timer() 函數，所以如果你的 timestamp 模塊比這個簡單的例子複雜些，那麼你將節省大量重複代碼。

保存文件並運行：

$ python3 ./sleeptest.py
Testing Python sleep()...
Time is 1560711266.1526039
Time is 1560711269.1557732

根據測試，Python 中的 sleep 函數非常準確：在三秒鐘等待之後，時間戳成功且正確地增加了 3，在微秒單位上差距很小。

Python 庫的結構看起來可能令人困惑，但其實它並不是什麼魔法。Python 被編程 為一個包含 Python 代碼的目錄，並附帶一個 __init__.py 文件，那麼這個目錄就會被當作一個包，並且 Python 會首先在當前目錄中查找可用模塊。這就是為什麼語句 from mymodularity import timestamp 有效的原因：Python 在當前目錄查找名為 mymodularity 的目錄，然後查找 timestamp.py 文件。

你在這個例子中所做的功能和以下這個非模塊化的版本是一樣的：

#!/usr/bin/env python3
import time
from mymodularity import timestamp
print("Testing Python sleep()...")
# no modularity
print("Time is " + str(time.time() ) )
time.sleep(3)
print("Time is " + str(time.time() ) )

對於這樣一個簡單的例子，其實沒有必要以這種方式編寫測試，但是對於編寫自己的模塊來說，最佳實踐是你的代碼是通用的，可以將它重用於其他項目。

通過在調用函數時傳遞信息，可以使代碼更通用。例如，假設你想要使用模塊來測試的不是 系統 的 sleep 函數，而是 用戶自己實現 的 sleep 函數，更改 timestamp 代碼，使它接受一個名為 msg 的傳入變量，它將是一個字符串，控制每次調用 timestamp 時如何顯示：

#!/usr/bin/env python3
import time
# 更新代碼
def Timer(msg):
 print(str(msg) + str(time.time() ) )

現在函數比以前更抽象了。它仍會打印時間戳，但是它為用戶打印的內容 msg 還是未定義的。這意味著你需要在調用函數時定義它。

Timer 函數接受的 msg 參數是隨便命名的，你可以使用參數 m、message 或 text，或是任何對你來說有意義的名稱。重要的是，當調用 timestamp.Timer 函數時，它接收一個文本作為其輸入，將接收到的任何內容放入 msg 變量中，並使用該變量完成任務。

以下是一個測試測試用戶正確感知時間流逝能力的新程序：

#!/usr/bin/env python3
from mymodularity import timestamp
print("Press the RETURN key. Count to 3, and press RETURN again.")
input()
timestamp.Timer("Started timer at ")
print("Count to 3...")
input()
timestamp.Timer("You slept until ")

將你的新程序保存為 response.py，運行它：

$ python3 ./response.py
Press the RETURN key. Count to 3, and press RETURN again.
Started timer at 1560714482.3772075
Count to 3...
You slept until 1560714484.1628013

函數和所需參數

新版本的 timestamp 模塊現在 需要 一個 msg 參數。這很重要，因為你的第一個應用程序將無法運行，因為它沒有將字符串傳遞給 timestamp.Timer 函數：

$ python3 ./sleeptest.py
Testing Python sleep()...
Traceback (most recent call last):
 File "./sleeptest.py", line 8, in <module>
 timestamp.Timer()
TypeError: Timer() missing 1 required positional argument: 'msg'
/<module>

你能修復你的 sleeptest.py 應用程序，以便它能夠與更新後的模塊一起正確運行嗎？

變量和函數

通過設計，函數限制了變量的範圍。換句話說，如果在函數內創建一個變量，那麼這個變量 只 在這個函數內起作用。如果你嘗試在函數外部使用函數內部出現的變量，就會發生錯誤。

下面是對 response.py 應用程序的修改，嘗試從 timestamp.Timer() 函數外部打印 msg 變量：

#!/usr/bin/env python3
from mymodularity import timestamp
print("Press the RETURN key. Count to 3, and press RETURN again.")
input()
timestamp.Timer("Started timer at ")
print("Count to 3...")
input()
timestamp.Timer("You slept for ")
print(msg)

試著運行它，查看錯誤：

$ python3 ./response.py
Press the RETURN key. Count to 3, and press RETURN again.
Started timer at 1560719527.7862902
Count to 3...
You slept for 1560719528.135406
Traceback (most recent call last):
 File "./response.py", line 15, in <module>
 print(msg)
NameError: name 'msg' is not defined
/<module>

應用程序返回一個 NameError 消息，因為沒有定義 msg。這看起來令人困惑，因為你編寫的代碼定義了 msg，但你對代碼的瞭解比 Python 更深入。調用函數的代碼，不管函數是出現在同一個文件中，還是打包為模塊，都不知道函數內部發生了什麼。一個函數獨立地執行它的計算，並返回你想要它返回的內容。這其中所涉及的任何變量都只是 本地的：它們只存在於函數中，並且只存在於函數完成其目的所需時間內。

Return 語句

如果你的應用程序需要函數中特定包含的信息，那麼使用 return 語句讓函數在運行後返回有意義的數據。

時間就是金錢，所以修改 timestamp 函數，以使其用於一個虛構的收費系統：

#!/usr/bin/env python3
import time
def Timer(msg):
 print(str(msg) + str(time.time() ) )
 charge = .02
 return charge

現在，timestamp 模塊每次調用都收費 2 美分，但最重要的是，它返回每次調用時所收取的金額。

以下一個如何使用 return 語句的演示：

#!/usr/bin/env python3
from mymodularity import timestamp
print("Press RETURN for the time (costs 2 cents).")
print("Press Q RETURN to quit.")
total = 0
while True:
 kbd = input()
 if kbd.lower() == "q":
 print("You owe $" + str(total) )
 exit()
 else:
 charge = timestamp.Timer("Time is ")
 total = total+charge

在這個示例代碼中，變量 charge 為 timestamp.Timer() 函數的返回，它接收函數返回的任何內容。在本例中，函數返回一個數字，因此使用一個名為 total 的新變量來跟蹤已經進行了多少更改。當應用程序收到要退出的信號時，它會打印總花費：

$ python3 ./charge.py
Press RETURN for the time (costs 2 cents).
Press Q RETURN to quit.
Time is 1560722430.345412
Time is 1560722430.933996
Time is 1560722434.6027434
Time is 1560722438.612629
Time is 1560722439.3649364
q
You owe $0.1

內聯函數

函數不必在單獨的文件中創建。如果你只是針對一個任務編寫一個簡短的腳本，那麼在同一個文件中編寫函數可能更有意義。唯一的區別是你不必導入自己的模塊，但函數的工作方式是一樣的。以下是時間測試應用程序的最新迭代：

#!/usr/bin/env python3
import time
total = 0
def Timer(msg):
 print(str(msg) + str(time.time() ) )
 charge = .02
 return charge
print("Press RETURN for the time (costs 2 cents).")
print("Press Q RETURN to quit.")
while True:
 kbd = input()
 if kbd.lower() == "q":
 print("You owe $" + str(total) )
 exit()
 else:
 charge = Timer("Time is ")
 total = total+charge

它沒有外部依賴（Python 發行版中包含 time 模塊），產生與模塊化版本相同的結果。它的優點是一切都位於一個文件中，缺點是你不能在其他腳本中使用 Timer() 函數，除非你手動複製和粘貼它。

全局變量

在函數外部創建的變量沒有限制作用域，因此它被視為 全局 變量。

全局變量的一個例子是在 charge.py 中用於跟蹤當前花費的 total 變量。total 是在函數之外創建的，因此它綁定到應用程序而不是特定函數。

應用程序中的函數可以訪問全局變量，但要將變量傳入導入的模塊，你必須像發送 msg 變量一樣將變量傳入模塊。

全局變量很方便，因為它們似乎隨時隨地都可用，但也很難跟蹤它們，很難知道哪些變量不再需要了但是仍然在系統內存中停留（儘管 Python 有非常好的垃圾收集機制）。

但是，全局變量很重要，因為不是所有的變量都可以是函數或類的本地變量。現在你知道了如何向函數傳入變量並獲得返回，事情就變得容易了。

總結

你已經學到了很多關於函數的知識，所以開始將它們放入你的腳本中 —— 如果它不是作為單獨的模塊，那麼作為代碼塊，你不必在一個腳本中編寫多次。在本系列的下一篇文章中，我將介紹 Python 類。

via: https://opensource.com/article/19/7/get-modular-python-functions

作者： Seth Kenlon 選題： lujun9972 譯者： MjSeven 校對： wxy

本文由 LCTT 原創編譯， Linux中國 榮譽推出