Pythonのsocketserverモジュールについて現役エンジニアが解説【初心者向け】

初心者向けにPythonのsocketserverモジュールについて解説しています。socketserverモジュールはネットワークサーバの構築に使用されます。モジュールの基本の機能と4つのクラス、使い方の例を見ていきましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonのsocketserverモジュールについて、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

 

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

socketserverモジュールについて詳しく説明していくね!

大石ゆかり

お願いします!

目次

 

socketserverモジュールとは

socketserverモジュールはPythonの標準モジュールの一つです。
ソケットを用いたサーバ実装に役立つクラスが集約されています。

 

[PR] Pythonで挫折しない学習方法を動画で公開中

socketserverモジュールの使い方

・socketserverモジュールには以下4つのクラスが含まれています。TCPServer, UDPServer, UnixStreamServer, UnixDatagramServer(※1)
・BaseRequestHandlerクラスを継承し、処理内容を実装します。(※2)
・サーバ機能に応じて(※1)の中から1つを選択し、(※2)を引数に指定して、サーバインスタンスを生成します。
・例えば、TCP通信を行うサーバを実装したい場合は以下のようにします。

import socketserver

class MyTCPHandler(socketserver.BaseRequestHandler):
    def handle(self):
        # ハンドラの実装

with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as srv:
    srv.serve_forever()  

・詳細は公式のリファレンスを参照してください。

 

実際に使ってみよう

ソースコード upper_echo_server.py

サーバ側ソースコードです。受信した文字列を大文字に変換して応答します。

import socketserver
import sys

class MyTCPHandler(socketserver.BaseRequestHandler):
    def handle(self):
        self.data = self.request.recv(1024).strip()
        print(str(self.data, 'utf-8'))
        self.request.sendall(self.data.upper())

if __name__ == "__main__":
    port = int(sys.argv[1])
    with socketserver.TCPServer(('127.0.0.1', port), MyTCPHandler) as srv:
        srv.serve_forever()

ソースコード echo_client.py

import socket
import sys

if __name__ == '__main__':
    port = int(sys.argv[1])
    msg = sys.argv[2]
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
        sock.connect(('127.0.0.1', port))
        sock.sendall(bytes(msg, 'UTF-8'))
        received = str(sock.recv(1024), 'utf-8')
    print(received)

実行結果

・サーバ側プログラムを実行します。12345の所は適当な空きポートを指定します。

python upper_echo_server.py 12345

・クライアント側プログラムを実行すると、送信した文字列が大文字に変換され返信されます。

python echo_client.py 12345 hello
HELLO
python echo_client.py 12345 hi
HI

解説

・サーバ側コードでは、BaseRequestHandlerを継承したMyTCPHandlerを定義しました。
・handleメソッドをオーバーライトし、受信文字列を大文字に変換して返信する処理を実装しました。
・クライアント側コードでは、socketモジュールを用いてTCP接続し、文字列を送受信する処理を実装しました。

 

まとめ

この記事ではsocketserverモジュールを用いて、ソケット通信するサーバを実装する手法を紹介しました。
非HTTPのデータを受信したり、独自の通信プロトコルを用いるクライアントサーバ機能を実装したりする場合に参考にしてください。

 

監修してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でもPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。