全網最適合入門的物件導向程式設計教程：20 類和物件的 Python 實現-組合關係的實現與 CSV 檔案儲存
摘要：
本文主要介紹了在使用 Python 物件導向程式設計時，如何實現組合關係，同時對比了組合關係和繼承關係的優缺點，並講解了如何透過 csv 模組來儲存 Python 接收/生成的資料。
原文連結：
FreakStudio的部落格
往期推薦：
學嵌入式的你，還不會物件導向？？！
全網最適合入門的物件導向程式設計教程：00 物件導向設計方法導論
全網最適合入門的物件導向程式設計教程：01 物件導向程式設計的基本概念
全網最適合入門的物件導向程式設計教程：02 類和物件的 Python 實現-使用 Python 建立類
全網最適合入門的物件導向程式設計教程：03 類和物件的 Python 實現-為自定義類新增屬性
全網最適合入門的物件導向程式設計教程：04 類和物件的Python實現-為自定義類新增方法
全網最適合入門的物件導向程式設計教程：05 類和物件的Python實現-PyCharm程式碼標籤
全網最適合入門的物件導向程式設計教程：06 類和物件的Python實現-自定義類的資料封裝
全網最適合入門的物件導向程式設計教程：07 類和物件的Python實現-型別註解
全網最適合入門的物件導向程式設計教程：08 類和物件的Python實現-@property裝飾器
全網最適合入門的物件導向程式設計教程：09 類和物件的Python實現-類之間的關係
全網最適合入門的物件導向程式設計教程：10 類和物件的Python實現-類的繼承和里氏替換原則
全網最適合入門的物件導向程式設計教程：11 類和物件的Python實現-子類呼叫父類方法
全網最適合入門的物件導向程式設計教程：12 類和物件的Python實現-Python使用logging模組輸出程式執行日誌
全網最適合入門的物件導向程式設計教程：13 類和物件的Python實現-視覺化閱讀程式碼神器Sourcetrail的安裝使用
全網最適合入門的物件導向程式設計教程：全網最適合入門的物件導向程式設計教程：14 類和物件的Python實現-類的靜態方法和類方法
全網最適合入門的物件導向程式設計教程：15 類和物件的 Python 實現-__slots__魔法方法
全網最適合入門的物件導向程式設計教程：16 類和物件的Python實現-多型、方法重寫與開閉原則
全網最適合入門的物件導向程式設計教程：17 類和物件的Python實現-鴨子型別與“file-like object“
全網最適合入門的物件導向程式設計教程：18 類和物件的Python實現-多重繼承與PyQtGraph串列埠資料繪製曲線圖
全網最適合入門的物件導向程式設計教程：19 類和物件的 Python 實現-使用 PyCharm 自動生成檔案註釋和函式註釋
更多精彩內容可看：
給你的 Python 加加速：一文速通 Python 平行計算
一文搞懂 CM3 微控制器除錯原理
肝了半個月，嵌入式技術棧大彙總出爐
電子計算機類比賽的“武林秘籍”
一個MicroPython的開源專案集錦：awesome-micropython，包含各個方面的Micropython工具庫
文件和程式碼獲取：
可訪問如下連結進行對文件下載：
https://github.com/leezisheng/Doc
本文件主要介紹如何使用 Python 進行物件導向程式設計，需要讀者對 Python 語法和微控制器開發具有基本瞭解。相比其他講解 Python 物件導向程式設計的部落格或書籍而言，本文件更加詳細、側重於嵌入式上位機應用，以上位機和下位機的常見串列埠資料收發、資料處理、動態圖繪製等為應用例項，同時使用 Sourcetrail 程式碼軟體對程式碼進行視覺化閱讀便於讀者理解。
相關示例程式碼獲取連結如下：https://github.com/leezisheng/Python-OOP-Demo
正文
前面講了面向類與物件的繼承，知道了繼承是一種什麼“是”什麼的關係。然而類與類之間還有另一種關係，這就是組合。組合是將幾個物件收集在一起生成一個新物件的行為。當一個物件是另外一個物件的一部分時，組合通常是不錯的選擇。
例如，汽車是由發動機、傳動裝置、啟動裝置、車前燈、擋風玻璃以及其他部件組成的，發動機又是由活塞、曲柄軸和閥門等組合而成的。汽車是發動機等多個元器件的抽象，而發動機是活塞等元器件的抽象，二者處於不同的層次而又有彼此互動的介面，組合是提供不同抽象層的好辦法。汽車物件可以提供司機所需要的介面，同時也能夠獲取內在組成部分，從而為機械師提供適合操作的深層抽象。當然，如果機械師需要更多資訊來診斷問題或調整發動機，這些組成部分也可以進一步被細分。
總的來說，組合就是讓不同的類混合並且加入其他類中來增加功能和程式碼重用性，這種適用於由多個小類組成一個大類的情況，並且不需要對小類進行太多修改。在前面示例中，我們實現了主機的串列埠收發和繪圖功能，在實際應用中，我們往往需要將感測器資料儲存到檔案中，以便後續的檢視和處理，很明顯前面的感測器資料為一維的時間序列資料，適合儲存為表格型別（即列標題為索引和值），我們通常將該類資料儲存為 csv 格式檔案，csv 是一種字串檔案的格式，它組織資料的語法就是在字串之間加分隔符（行與行之間是加換行符，同行字元之間是加逗號分隔），可以用任意的文字編輯器開啟（如記事本），也可以用 Excel 開啟，還可以透過 Excel 把檔案另存為 csv 格式。用 csv 格式儲存資料，讀寫比較方便，易於實現，檔案也會比 Excel 檔案小。但 csv 檔案缺少 Excel 檔案本身的很多功能，如不能嵌入影像和圖表，不能生成公式等等。
操作 csv 檔案我們需要藉助 csv 模組，python 自帶 csv 模組，不需要我們使用 pip 安裝，我們可以點選如下連結檢視 csv 模組使用方法：
https://docs.python.org/zh-cn/3.13/library/csv.html#csv.writer
這裡，我們首先定義一個 FileIOClass 類，其中具有初始化方法、寫入感測器資料到檔案方法和關閉檔案方法，示例程式碼如下：
import csv
_# 使用typing模組提供的複合註解功能_
from typing import List
class FileIOClass:
def __init__(self,path:str="G:\\Python物件導向程式設計\\Demo\\file.csv"):
'''
初始化csv檔案和列標題
:param path: 檔案路徑和檔名
'''
self.path = path
_# path為輸出路徑和檔名，newline=''是為了不出現空行_
self.csvFile = open(path, "w+", newline='')
_# rowname為列名，index-索引，data-資料_
self.rowname = ['index', 'data']
_# 返回一個writer物件，將使用者的資料在給定的檔案型物件上轉換為帶分隔符的字串_
self.writer = csv.writer(self.csvFile)
_# 寫入csv檔案的列標題_
self.writer.writerow( self.rowname)
def WriteFile(self,index:List[int],data:List[int])->None:
'''
:param index: 感測器索引列表
:param data: 感測器資料列表
:return:
'''
writedatalist = []
for i in range(len(data)):
writedatalist.append([index[i],data[i]])
_# 將列表中的每個元素將被寫入CSV檔案的一列中_
self.writer.writerow(writedatalist[i])
def CloseFile(self)->None:
'''
關閉檔案
:return: None
'''
self.csvFile.close()
這裡，在初始化方法中，我們需要傳入檔案儲存路徑。之後建立一個 writer 物件，將使用者的資料在給定的檔案型物件上轉換為帶分隔符的字串，同時寫入 csv 檔案的列標題。在 WriteFile 方法中傳入資料的索引列表用於表示資料的先後順序，之後是資料列表（這裡的型別註解需要使用 typing 模組提供的複合註解功能），並迴圈將每個元素將被寫入 CSV 檔案的一列中，最後定義了檔案的關閉方法。
在主函式中，我們建立 FileIOClass 物件，寫入模擬感測器資料後關閉檔案，以下為示例程式碼和執行效果：
if __name__ == '__main__':
path = "G:\\Python物件導向程式設計\\Demo\\file.csv"
data = [11,42,307,46,55,61,78,80,19,11]
index = [count for count in range(len(data))]
file = FileIOClass(path)
file.WriteFile(index,data)
file.CloseFile()
這裡，我們可以直接在 MasterClass 類的初始化中建立 FileIOClass 類的例項化物件來實現組合。程式碼如下：
_# 檔案儲存路徑_
self.savepath = "G:\\Python物件導向程式設計\\Demo\\file.csv"
_# 建立FileIOClass類的例項化物件_
self.fileio = FileIOClass(self.savepath)
透過 sourcetrail，我們可以清晰看到類之間的組合與繼承關係：
在主程式中，我們在主機接收 10 次資料後，將資料儲存到 file.csv 中：
if __name__ == "__main__":
_ # 建立資料列表_
datalist = []
m = MasterClass(state = MasterClass.IDLE_STATE,
port = "COM17",
wintitle = "Basic plotting examples",
plottitle = "Updating plot",
width = 1000,
height = 600)
m.StartMaster()
m.SendSensorCMD(MasterClass.SENDID_CMD)
m.RecvSensorID()
# 迴圈10次接收資料
for i in range(10):
m.SendSensorCMD(MasterClass.SENDVALUE_CMD)
value = m.RecvSensorValue()
datalist.append(value)
indexlist = [count for count in range(len(datalist))]
# 寫入資料
m.fileio.WriteFile(indexlist,datalist)
m.fileio.CloseFile()
如下為執行效果：
目前，整個檔案的完整程式碼如下，可以看到單單是這麼一個簡單程式就有了三百多行，對於程式碼查詢修改來講，非常不便。同時我們注意到，幾個不同類之間似乎功能並不相同，不應該放到一個檔案中。下一節我們將會說如何利用 Python 中的模組和包來組織我們的程式碼。
完整程式碼如下：
_# 串列埠相關庫_
import serial
import serial.tools.list_ports
_# 佇列相關_
import queue
import random
_# 日誌輸出相關庫_
import logging
_# 曲線作圖相關庫_
import pyqtgraph as pg
import numpy as np
from pyqtgraph.Qt import QtCore
_# 檔案讀寫相關庫_
import csv
_# 使用typing模組提供的複合註解功能_
from typing import List
import time
_# # 設定日誌輸出級別_
_# logging.basicConfig(level=logging.DEBUG)_
_# 在配置下日誌輸出目標檔案和日誌格式_
LOG_FORMAT="%(asctime)s-%(levelname)s-%(message)s"
logging.basicConfig(filename='my.log',level=logging.DEBUG,format=LOG_FORMAT)
class SerialClass:
_# 限定SerialClass物件只能繫結以下屬性_
__slots__ = ('dev','_SerialClass__devstate')
_# 初始化_
_# 使用預設引數_
def __init__(self,
devport:str = "COM17",
devbaudrate:int = 115200,
devbytesize:int = serial.EIGHTBITS,
devparity :str = serial.PARITY_NONE,
devstopbits:int = serial.STOPBITS_ONE):
_# 直接傳入serial.Serial()類_
self.dev = serial.Serial()
self.dev.port = devport
self.dev.baudrate = devbaudrate
self.dev.bytesize = devbytesize
self.dev.parity = devparity
self.dev.stopbits = devstopbits
_# 表示串列埠裝置的狀態-開啟或者關閉_
_# 初始化時為關閉_
self.__devstate = False
print("SerialClass init")
logging.info("SerialClass init")
_# 取值方法_
@property
def devstate(self):
return self.__devstate
_# 開啟串列埠_
def OpenSerial(self):
print("SerialClass-OpenSerial")
logging.info("SerialClass-OpenSerial")
self.dev.open()
self.__devstate = True
_# 關閉串列埠_
def CloseSerial(self):
print("SerialClass-CloseSerial")
logging.info("SerialClass-CloseSerial")
self.dev.close()
self.__devstate = False
_# 串列埠讀取_
def ReadSerial(self):
print("SerialClass-ReadSerial")
logging.info("SerialClass-ReadSerial")
if self.__devstate:
_# 阻塞方式讀取_
_# 按行讀取_
data = self.dev.readline()
_# 收到為二進位制資料_
_# 用utf-8編碼將二進位制資料解碼為unicode字串_
_# 字串轉為int型別_
data = int(data.decode('utf-8', 'replace'))
return data
_# 串列埠寫入_
def WriteSerial(self,write_data):
print("SerialClass-WriteSerial")
logging.info("SerialClass-WriteSerial")
if self.__devstate:
_# 非阻塞方式寫入_
self.dev.write(write_data.encode())
_# 輸出換行符_
_# write的輸入引數必須是bytes 格式_
_# 字串資料需要encode()函式將其編碼為二進位制資料，然後才可以順利傳送_
_# \r\n表示換行回車_
self.dev.write('\r\n'.encode())
def RetSerialState(self):
if self.dev.isOpen():
self.__devstate = True
return True
else:
self.__devstate = False
return False
class PlotClass:
_# 繪圖類初始化_
def __init__(self,wintitle:str="Basic plotting examples",plottitle:str="Updating plot",width:int=1000,height:int=600):
'''
用於初始化Plot類
:param wintitle: 視窗標題
:param plottitle: 圖層標題
:param width: 視窗寬度
:param height: 視窗高度
'''
_# Qt應用例項物件_
self.app = None
_# 視窗物件_
self.win = None
_# 設定視窗標題_
self.title = wintitle
_# 設定視窗尺寸_
self.width = width
self.height = height
_# 感測器資料_
self.value = 0
_# 計數變數_
self.__count = 0
_# 感測器資料快取列表_
self.valuelist = []
_# 繪圖曲線_
self.curve = None
_# 圖層物件_
self.plotob = None
_# 圖層標題_
self.plottitle = plottitle
_# 定時器物件_
self.timer = QtCore.QTimer()
_# 定時時間_
self.time = 0
_# Qt應用和視窗初始化_
self.appinit()
print("PLOT INIT SUCCESS")
logging.info("PLOT INIT SUCCESS")
_# 應用程式初始化_
def appinit(self):
'''
用於qt應用程式初始化，新增視窗、曲線和圖層
:return: None
'''
_# 建立一個Qt應用，並返回該應用的例項物件_
self.app = pg.mkQApp("Plotting Example")
_# 生成多皮膚圖形_
_# show：(bool) 如果為 True，則在建立小部件後立即顯示小部件。_
_# title：(str 或 None)如果指定，則為此小部件設定視窗標題。_
self.win = pg.GraphicsLayoutWidget(show=True, title=self.title)
_# 設定視窗尺寸_
self.win.resize(self.width, self.height)
_# 進行視窗全域性設定，setConfigOptions一次性配置多項引數_
_# antialias啟用抗鋸齒，useNumba對影像進行加速_
pg.setConfigOptions(antialias=True, useNumba=True)
_# 新增圖層_
self.plotob = self.win.addPlot(title=self.plottitle)
_# 新增曲線_
self.curve = self.plotob.plot(pen='y')
_# 接收資料_
def GetValue(self,value):
'''
用於接收感測器資料，加入快取列表
:param value: 感測器資料
:return: None
'''
self.value = value
_# 加入資料快取列表_
self.valuelist.append(value)
print("PLOT RECV DATA : "+str(self.value))
logging.info("PLOT RECV DATA : "+str(self.value))
_# 更新曲線資料_
def DataUpdate(self):
'''
用於定時進行曲線更新,這裡模擬繪製正弦曲線
:return: None
'''
_# 模擬繪製正弦曲線_
_# 計數變數更新_
self.__count = self.__count + 0.1
self.value = np.sin(self.__count)
self.GetValue(self.value)
_# 將資料轉化為圖形_
self.curve.setData(self.valuelist)
_# 設定定時更新_
def SetUpdate(self,time:int = 100):
'''
設定定時更新任務
:param time: 定時的時間
:return: None
'''
_# 定時器結束，觸發DataUpdate方法_
self.timer.timeout.connect(self.DataUpdate)
_# 啟動定時器_
self.timer.start(time)
_# 定時時間_
self.time = time
print("PLOT SET UPDATA")
logging.info("PLOT SET UPDATA")
_# 進入主事件迴圈並等待_
pg.exec()
class FileIOClass:
def __init__(self,path:str="G:\\Python物件導向程式設計\\Demo\\file.csv"):
'''
初始化csv檔案和列標題
:param path: 檔案路徑和檔名
'''
self.path = path
_# path為輸出路徑和檔名，newline=''是為了不出現空行_
self.csvFile = open(path, "w+", newline='')
_# rowname為列名，index-索引，data-資料_
self.rowname = ['index', 'data']
_# 返回一個writer物件，將使用者的資料在給定的檔案型物件上轉換為帶分隔符的字串_
self.writer = csv.writer(self.csvFile)
_# 寫入csv檔案的列標題_
self.writer.writerow(self.rowname)
def WriteFile(self,index:List[int],data:List[int])->None:
'''
:param index: 感測器索引列表
:param data: 感測器資料列表
:return:
'''
writedatalist = []
for i in range(len(data)):
writedatalist.append([index[i],data[i]])
_# 將列表中的每個元素將被寫入CSV檔案的一列中_
self.writer.writerow(writedatalist[i])
def CloseFile(self)->None:
'''
關閉檔案
:return: None
'''
self.csvFile.close()
class SensorClass(SerialClass):
_# 類變數：_
_# RESPOND_MODE -響應模式-0_
_# LOOP_MODE -迴圈模式-1_
RESPOND_MODE,LOOP_MODE = (0,1)
_# 類變數：_
_# START_CMD - 開啟命令 -0_
_# STOP_CMD - 關閉命令 -1_
_# SENDID_CMD - 傳送ID命令 -2_
_# SENDVALUE_CMD - 傳送資料命令 -3_
START_CMD,STOP_CMD,SENDID_CMD,SENDVALUE_CMD = (0,1,2,3)
_# 類的初始化_
def __init__(self,port:str = "COM11",id:int = 0,state:int = RESPOND_MODE):
_# 呼叫父類的初始化方法，super() 函式將父類和子類連線_
super().__init__(port)
self.sensorvalue = 0
self.sensorid = id
self.sensorstate = state
print("Sensor Init")
logging.info("Sensor Init")
@staticmethod
_# 判斷感測器ID號是否正確：這裡判斷ID號是否在0到99之間_
def IsTrueID(id:int = 0):
if id >= 0 and id <= 99:
print("Sensor ID True")
return True
else:
print("Sensor ID False")
return False
_# 感測器上電初始化_
def InitSensor(self):
_# 感測器上電初始化工作_
_# 同時輸出ID號以及狀態_
print("Sensor %d Init complete : %d"%(self.sensorid,self.sensorstate))
logging.info("Sensor %d Init complete : %d"%(self.sensorid,self.sensorstate))
_# 開啟感測器_
def StartSensor(self):
super().OpenSerial()
print("Sensor %d start serial %s "%(self.sensorid,self.dev.port))
logging.info("Sensor %d start serial %s "%(self.sensorid,self.dev.port))
_# 停止感測器_
def StopSensor(self):
super().CloseSerial()
print("Sensor %d close serial %s " % (self.sensorid, self.dev.port))
logging.info("Sensor %d close serial %s " % (self.sensorid, self.dev.port))
_# 傳送感測器ID號_
def SendSensorID(self):
super().WriteSerial(str(self.sensorid))
print("Sensor %d send id "%self.sensorid)
logging.info("Sensor %d send id "%self.sensorid)
_# 傳送感測器資料_
def SendSensorValue(self):
_# 生成[1, 10]內的隨機整數_
data = random.randint(1, 10)
super().WriteSerial(str(data))
print("Sensor %d send data %d" % (self.sensorid,data))
logging.info("Sensor %d send data %d" % (self.sensorid,data))
_# 接收主機指令_
def RecvMasterCMD(self):
cmd = super().ReadSerial()
print("Sensor %d recv cmd %d " % (self.sensorid,cmd))
logging.info("Sensor %d recv cmd %d " % (self.sensorid,cmd))
return cmd
class MasterClass(SerialClass,PlotClass):
_# 類變數：_
_# BUSY_STATE -忙碌狀態-0_
_# IDLE_STATE -空閒狀態-1_
BUSY_STATE, IDLE_STATE = (0, 1)
_# 類變數：_
_# START_CMD - 開啟命令 -0_
_# STOP_CMD - 關閉命令 -1_
_# SENDID_CMD - 傳送ID命令 -2_
_# SENDVALUE_CMD - 傳送資料命令 -3_
START_CMD, STOP_CMD, SENDID_CMD, SENDVALUE_CMD = (0, 1, 2, 3)
_# 類的初始化_
def __init__(self,state:int = IDLE_STATE,port:str = "COM17",wintitle:str="Basic plotting examples",plottitle:str="Updating plot",width:int=1000,height:int=600):
_# 分別呼叫不同父類的__init__方法_
SerialClass.__init__(self,port)
PlotClass.__init__(self,wintitle,plottitle,width,height)
self.valuequeue = queue.Queue(10)
self.__masterstatue = state
_# 初始化完成的標誌量_
self.INIT_FLAG = False
_# 檔案儲存路徑_
self.savepath = "G:\\Python物件導向程式設計\\Demo\\file.csv"
_# 建立FileIOClass類的例項化物件_
self.fileio = FileIOClass(self.savepath)
print("MASTER INIT SUCCESSS")
logging.info("MASTER INIT SUCCESSS")
@classmethod
def MasterInfo(cls):
print("Info : "+str(cls))
_# 開啟主機_
def StartMaster(self):
super().OpenSerial()
print("START MASTER :"+self.dev.port)
logging.info("START MASTER :"+self.dev.port)
_# 停止主機_
def StopMaster(self):
super().CloseSerial()
print("CLOSE MASTER :" + self.dev.port)
logging.info("CLOSE MASTER :" + self.dev.port)
_# 接收感測器ID號_
def RecvSensorID(self):
sensorid = super().ReadSerial()
print("MASTER RECIEVE ID : " + str(sensorid))
logging.info("MASTER RECIEVE ID : " + str(sensorid))
return sensorid
_# 接收感測器資料_
def RecvSensorValue(self):
data = super().ReadSerial()
print("MASTER RECIEVE DATA : " + str(data))
logging.info("MASTER RECIEVE DATA : " + str(data))
self.valuequeue.put(data)
return data
_# 主機傳送命令_
def SendSensorCMD(self,cmd):
super().WriteSerial(str(cmd))
print("MASTER SEND CMD : " + str(cmd))
logging.info("MASTER SEND CMD : " + str(cmd))
_# 主機返回工作狀態-_
def RetMasterStatue(self):
return self.__masterstatue
_# 重寫父類的DataUpdate方法_
def DataUpdate(self):
self.SendSensorCMD(self.SENDVALUE_CMD)
self.value = self.RecvSensorValue()
self.WriteSerial("Recv:"+str(self.value))
self.GetValue(self.value)
self.curve.setData(self.valuelist)
print("PLOT UPDATA : " + str(self.value))
logging.info("PLOT UPDATA : " + str(self.value))
class DevClass(SerialClass):
def __init__(self,port:str = "COM1"):
super().__init__(port)
_# 開啟裝置_
def StartDev(self):
super().OpenSerial()
print("START Dev :" + self.dev.port)
def ReadSerial(self,byte_size):
if super().RetSerialState():
data = self.dev.read(byte_size)
data = int(data.decode('utf-8', 'replace'))
return data
_# 判斷串列埠類物件的串列埠是否開啟_
def IsSerialConnected(serialclass):
return serialclass.RetSerialState()
if __name__ == "__main__":
_# 建立資料列表_
datalist = []
m = MasterClass(state = MasterClass.IDLE_STATE,
port = "COM17",
wintitle = "Basic plotting examples",
plottitle = "Updating plot",
width = 1000,
height = 600)
m.StartMaster()
m.SendSensorCMD(MasterClass.SENDID_CMD)
m.RecvSensorID()
_# 迴圈10次接收資料_
for i in range(10):
m.SendSensorCMD(MasterClass.SENDVALUE_CMD)
value = m.RecvSensorValue()
datalist.append(value)
indexlist = [count for count in range(len(datalist))]
_# 寫入資料_
m.fileio.WriteFile(indexlist,datalist)
m.fileio.CloseFile()
