Python学習ノート(3):クラス、ネットワークプログラミング


Pythonシリーズの学習ポイントは、まずこの編まで書き、他の基礎的なものは公式文書をめくって、後で実作で面白い議題に出会ってから文章で記録することができます.
本編では主にクラスの定義と使用方法を紹介し、特に注意すべきポイントだけを言及します.
枝葉末節はもちろん、公式ファイルや他のプログラミング言語を参照することができます.
基本的に他のプログラミング言語の基礎があれば、Pythonの学習曲線は比較的短い.
今回の例としてのコードはC/Sアーキテクチャの簡易Echoサーバであり、
サービス側は、Acceptスレッドを開いて外来接続を傍受し、受信した外部接続に対してサブスレッド処理ネットワーク通信を開く.
メインスレッドはキーボード入力に基づいてプログラムを終了するかどうかを決定します.
サービス側:[EchoServer.py]
# -*- coding: UTF-8 -*-
# Description: It's a socket echo server.
#              Simply use working thread to process the communication from client.

import socket
import threading
import sys

HOST = ""
PORT = 5226
isRunning = 1
socketList = []


class ClientThread(threading.Thread):
    def __init__(self, ss, address):
        super().__init__()
        self.ss = ss
        self.addr = address

    def run(self):
        while isRunning:
            try:
                data = self.ss.recv(1024)
            except ConnectionResetError:
                print("Connection is closed by remote client...")
                break
            except ConnectionAbortedError:
                print("slave socket is closed.")
                break
            if (not data) or (data == "exit"):
                print("Client thread exit from", self.addr)
                break
            self.ss.send(data)
        self.ss.close()
        for s in socketList:  # remove client socket from socketList
            if s == self.ss:
                socketList.remove(s)
                break


class AcceptThread(threading.Thread):
    def __init__(self, s):
        threading.Thread.__init__(self)
        self.s = s

    def run(self):
        while isRunning:
            try:
                conn, addr = self.s.accept()
            except:
                print("Master socket is closed.")
                break
            print("Connected by", addr)
            socketList.append(conn)  # add client socket into socketList
            client_thread = ClientThread(conn, addr)
            client_thread.start()


def main():
    try:
        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
    except socket.error as msg:
        print(msg)
        print("Could not open socket!")
        sys.exit(1)
    try:
        s.bind((HOST, PORT))
        s.listen(5)
    except socket.error as msg:
        s.close()
        print(msg)
        print("Could not open socket!")
        sys.exit(1)
    if s is None:
        print("Could not open socket!")
        sys.exit(1)

    print("Server is listening on %d" % PORT)
    socketList.append(s)  # add master socket into socket list

    accept_thread = AcceptThread(s)
    accept_thread.start()
    while input("enter 'exit' to terminate program:") != "exit":  # wait for user input "exit"
        pass
    global isRunning
    isRunning = 0  # Set all thread being stop
    for sock in socketList:  # Close all socket
        sock.close()
    print("Exit server program.")

if __name__ == "__main__":
    try:
        main()
    except KeyboardInterrupt:
        sys.exit(2)
    except Exception as e:
        print(e)

ポイント1
上記のコードは、15行目と42行目のクラス定義のようなスレッドクラスをthreadingというモジュールで実装します.
ClientThreadクラスとAcceptThreadクラスはthreadingを継承する.Threadクラス、そして_init__()関数はサブクラスのconstructorを定義します.
ここで注意しなければならないのは17行目と44行目で、この2行のコードはいずれも親クラスのconstructorを呼んでいるが、44行目は旧版Pythonの書き方、17行目はPython 3.0以降の書き方である.
17行目はsuper()コールを使用して親名を直接使用することを避け、super()という概念についてはJavaを参照することができる.
17行目の新版の書き方は、以下の旧版の書き方に書き換えることもできます.
super(ClientThread, self).__init__()

形の下ではくどくどしているように見える.
------
ポイント2
スレッドクラスではrun()関数を実装して、21行目、47行目などのスレッド起動後に実行する必要があります.
------
ポイント3
main()関数にsocketをバインドし、socketを傍受するにはあまり説明しません.これらの使い方はC/C++のsocketプログラミングを参照することができます.
82行目、83行目に重点を置きます.
82行目はAcceptThreadクラスのオブジェクトインスタンスを宣言し、ローカルのmaster socketをパラメータとしてクラスの構築関数に入力します.
クラスのメンバー変数selfに再付与.sは,外部配線を受け入れるためのものである.
83行目はAcceptThreadクラスのオブジェクトインスタンスでstart()関数を呼び出してAcceptThreadスレッドを起動する.
ポイントはこれくらいですが、他の枝微末節はコードを見ながら理解でき、簡単です.
最後にクライアントコードを添付します.
------
クライアント:[EchoClient.py]
# -*- coding: UTF-8 -*-
# Description: It's a socket echo client

import socket
import sys

HOST = "your.domain.net"
PORT = 5226
s = None

for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
    af, socktype, proto, canonname, sa = res
    try:
        s = socket.socket(af, socktype, proto)
    except socket.error as msg:
        print(msg)
        s = None
        continue
    try:
        s.connect(sa)
    except socket.error as msg:
        print(msg)
        s.close()
        s = None
        continue
    break
if s is None:
    print("Could not open socket!")
    sys.exit(1)

while 1:
    data = ""
    while data == "":
        data = input("Input math algorithm:")
    if data == "exit":
        break
    try:
        s.send(data.encode())
        data = s.recv(1024)
    except:
        print("Connection is closed by remote server...")
        break
    print("recv:%s" % data.decode())

s.close()
print("Exit client program.")

はい、今日はここまで書いて、お腹が痛いので、先に糞をしてトイレに行きます.