PythonのSpeedtestモジュール（ライブラリ）の動作について

Question

pythonでインターネットへの通信速度を計測し、CSVファイルに保存しておくプログラムを作成したいと思っています。
色々調べてみると、Speedtest-cliというものがあることまでは分かり、一応、
コードをコピペし実行したところ、一応、実行でき、速度の計測はできました。

しかし、コードの内容というか、このSpeedtest-cliの関数というか、メソッドが
どういう動作を行い、どのような値が返ってくるのかなどまったく把握できない状態です。

例えば、speedtest.Speedtest()は、どのような動作をしてどのような値を返すのか。

speedtest、speedtestについての説明（ドキュメント）は、どのように見つければよいのでしょう？

下記サイトを調べてもspeedtestというモジュール（ライブラリ）は掲載されておりませせんでした。。。
https://docs.python.org/ja/3/py-modindex.html#cap-s

pythonは、便利なモジュール（ライブラリ）が沢山あるといいますが、
中身を知らないで利用するということは、良くないので、一つ一つ
理解しながら作成したいと考えております。

コピペして実行したコード

import sys
import speedtest 


def get_speed_test():
    servers = []
    stest = speedtest.Speedtest()
    stest.get_servers(servers)
    stest.get_best_server()
    return stest

def command_line_runner():
    stest = get_speed_test()
    down_result = stest.download()
    up_result = stest.upload()
    mbps_down_result = down_result / 1024 /1024
    mbps_up_result = up_result / 1024 /1024
    result = [mbps_down_result, mbps_up_result]
    print(result)

command_line_runner()

実行結果

57.158226870187505, 87.41375687289494

Comments

[ayousanz]

ぐぐったらhttps://github.com/sivel/speedtest-cliが出てきたのですが，こちらをお求めではないですか？

Answer 1

動作の詳細はソースコードにすべて書いてあります。
さらっと見た感じ、http://www.speedtest.net/というスピード計測サイトのapiエンドポイントにリクエストを送って、得られた結果を加工しているようです。

pythonでの使用法は
https://github.com/sivel/speedtest-cli/wiki
に書いてあるようです

下記ソースの内容を見つつ簡単に説明を記述しました。
（上がコマンド、下のコメントがその説明）

import speedtest

s = speedtest.Speedtest()
# スピード測定用のオブジェクトを作成します。

servers = []
# サーバーIDを列挙したリストです。get_servers()関数の引数に指定します、
# 計測に使うサーバーのIDをリストで指定します。
# 指定するサーバーIDはhttps://www.speedtest.net/speedtest-servers-static.php　で参照できます。
# 例：servers = [37950, 18709]

threads = None
# 指定した個数のスレッドを使って同時並行して計測することができます。
# シングルスレッドで計測する場合、1。
# Noneを指定した場合、speedtest.netによって自動的に設定された値が実行スレッド数としてセットされます

s.get_servers(servers)  
# 引数に指定されたリスト内に記述されたサーバーIDを測定用サーバーに指定します。

s.get_best_server() 
# pingを使って一番レイテンシが小さいサーバーを測定サーバーとして指定します。

s.download(threads=threads)
# ダウンロードスピードを測定し、速度をbits/秒で返します。threadsに指定した数のスレッドが使用されます。

s.upload(threads=threads)
# アップロードスピードを測定し、速度をbits/秒で返します。threadsに指定した数のスレッドが使用されます。

s.results.share()
# 測定結果画像の共有URLを生成します。

Comments

[退会済みユーザー]

すいません。。。ソースコードが全く分からない状態です。。。。

[退会済みユーザー]

詳細な解説ありがとうございます。
一つ一つ実行して確認してみます。