他の人が書いたプログラムの読み方・理解の仕方について

Question

プログラミングを勉強しておりますが、
テキスト等で基礎文法を覚えて、テキストのサンプルプログラムを動かしたりしております。
そして、自分なりに、プログラムを拡張したり作りたいアプリがある場合に、色々なサイト
で、似たような機能を実現しようとしているソースを探し、ソースを理解しようとしておりますが、
Web上に公開されている方のソースや、GitHub等のサンプルソースが理解できない状況です。

開発に携わられている方や、プログラミングが趣味・得意・好きという方は、
他の方が書いたプログラムを、最初にどの様に読んで理解しているのでしょうか？

私の場合、例えば、以下のようなソースで
print("Usage: {} modName symName HOSTNAME".format(sys.argv[0]))は、sys.argv[0]は、何かリストに格納しているなぁ。
でも、sys.argv[0]は、どういう情報なんだろう？？・・・訳が分からない・・・終了。といった状態です。

特に、リストや辞書等のデーターを格納している箇所については、どういうデーター形式かを事前にしっていないとsys.argv[0]とか
sys.argv[2]とかってわからないと思います。

他の人が書いたプログラムの読み方や理解の仕方等のコツ等をアドバイスいただければと思います。

# snmpget.py
from pysnmp.hlapi import *
import sys
 
if len(sys.argv) != 4:
    print("Usage: {} modName symName HOSTNAME".format(sys.argv[0]))
    sys.exit(1)
 
modName = sys.argv[1]
if "." in sys.argv[2]:
    symName, value = sys.argv[2].split('.')
else:
    symName = sys.argv[2]
    value = 0
router_ip = sys.argv[3]
 
errorIndication, errorStatus, errorIndex, varBinds = next(
    getCmd(SnmpEngine(),
    CommunityData('public'),
    UdpTransportTarget((router_ip, 161)),
    ContextData(),
    ObjectType(ObjectIdentity(modName, symName, value)))
)
 
if errorIndication:
    print(errorIndication)
elif errorStatus:
    print('%s at %s' % (errorStatus.prettyPrint(),
                        errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
else:
    for varBind in varBinds:
        print(' = '.join([x.prettyPrint() for x in varBind]))

Comments

[melian]

Python には self documentation system が内蔵されています。例に挙げられている sys.argv に関して言えば、Python を interactive mode で起動して、help 関数を利用して必要な情報を得ることができます。

>>> import sys
>>> help(sys)
　　:
argv -- command line arguments; argv[0] is the script pathname if known
　　:

[meg_]

コードの引用元を明記されるべきかと思います。

[dameo]

人間分かっていることだけしかできません。まず分からないことがあるうちはまともにコードは読めない気がします。

個人的には読んで書いて経験値を増やしていくうちに、まだ読んでない部分のコードを想像しながら読むと思うので、例えば最初の部分でsys.argvとか出てきたら、「ああ、パラメータをパースするんだなぁ」とか、「じゃあ近くにmainがあるんだろうなぁ」(実際にはない)とか、そんな予想をしながら読んで、次にその予想を当てることでコード全体像(設計)を思い浮かべるわけです。モヤモヤした全体像を、予想の当たり外れで修正していき、さらに精度を上げて読んでいく感じです。ディレクトリの構成やビルドの仕組み、関数や変数の名前などから分かるときもありますし、テストコードから読んでいくことで使い方を先に掴むこともあると思います。ようは経験により培われたパターンからの類推を行い、コードから読み取れる以上の情報を想像しながら読んでいるということです。

読みたいところを素早く見つけられるようになれば、理解速度は劇的に早まると思います。逆にそういうパターンから外れてるコードは、誤解を生みやすいとも言えます。

Answer 1

まずは、pythonの文法をちゃんと把握することが必要と思います。
たとえば、基本的なデータ構造、数値・文字列・リスト・辞書 について、値の追加や参照などの操作の理解は必須です。また、オブジェクトに「. (ドット)」を付けてそのクラス/モジュールのメンバにアクセスしているということの理解も必要ですね。
そのほかいろいろ基本的なところを踏まえた上で、順に読んでいけば、それほど難しくはないと思います。

また、プログラムというのは、何かを実現するためにあるので、その領域の知識が無いと文法としてわかったとしても何をしているのかわからないかもしれません。 会計のプログラムであれば会計の知識、質問のプログラムであればSNMPの知識がないと何のことかわからないでしょう。

sys.argv[0]は、何かリストに格納しているなぁ。でも、sys.argv[0]は、どういう情報なんだろう？？・・・訳が分からない

とありますが残念ですね。
pythonのソースコードでは、変数は基本的に突然現われたりしません。 今回の 「sys」についても、それより前を見れば、かならずどこかにそれが定義されています。
提示のソースコードでは、「import sys」がそれです。 importされているということは、モジュールだということですね。「python sys」で検索してみましょう。 最初に本家のドキュメントがみつかりました。
https://docs.python.org/ja/3/library/sys.html

このモジュールでは、インタプリタで使用・管理している変数や、インタプリタの動作に深く関連する関数を定義しています。このモジュールは常に利用可能です。

のように書いてあります。 探すと、 argv についても書いてありますね。

Pythonスクリプトに渡されたコマンドライン引数のリスト。

でした。

ちなみに、提示のソースコードはよくない例の一つですね。
from pysnmp.hlapi import *
とあります。 これは、 sysnmpモジュールのhlapiに含まれるものすべてこのソースで使えるようにするということですが、これではhlapiに何が入っているのか全部調べないと追い掛けられません。python界隈では、「import *」はすべきではないとされています。
たぶん「next」、「getCmd」、「CommunityData」などは、定義されていないので、hlapiに含まれるものなのでしょう。 このコードは「import *」が1つですが、複数あったらどこにあるのかまったくわかりませんね。

Answer 2

最近流行っている AI の ChatGPT 先生に聞いてみました。
（半分ネタですが、それなりに回答してくれるので学習のとっかかりなど、参考になることも多いと思います。）

■ 質問内容
Pythonでsys.argv[0]には何の情報が入っていますか？

■ 回答内容
Pythonでsys.argvとは、Pythonスクリプトが実行されたときにコマンドラインから渡される引数のリストを表します。sys.argv[0]には、Pythonスクリプト自身のファイル名が入っています。例えば、以下のようなPythonスクリプトがあるとします。

import sys

print(sys.argv[0])

このスクリプトを、python script.pyのように実行すると、次のように出力されます。

script.py

sys.argv[0]は、Pythonスクリプトを実行する際に指定したファイル名になります。ただし、sys.argv[0]は、Pythonスクリプトの名前だけではなく、そのスクリプトが保存されているフルパスも含まれます。たとえば、/home/user/scripts/script.pyというフルパスで保存されている場合、sys.argv[0]にはそのフルパスが含まれます。

sys.argv[0]は、Pythonスクリプト自身の名前やフルパスを取得するために使用されることが多いです。しかし、その他にも、sys.argvを使って、Pythonスクリプトを実行する際に渡される複数の引数を取得することもできます。例えば、次のようなPythonスクリプトを考えます。

import sys

# sys.argv[0]はPythonスクリプト自身のファイル名
print(sys.argv[0])

# sys.argv[1]は1番目の引数
print(sys.argv[1])

# sys.argv[2]は2番目の引数
print(sys.argv[2])

このスクリプトを、python script.py foo barのように実行すると、次のように出力されます。

script.py
foo
bar

sys.argv[1]とsys.argv[2]には、Pythonスクリプトを実行する際に渡された1番目と2番目の引数

以上が、sys.argv[0]についての説明です。sys.argv[0]は、Pythonスクリプト自身の名前やフルパスを取得するために使用されることが多いです。また、sys.argvを使って、Pythonスクリプトを実行する際に渡される複数の引数を取得することもできます。

Answer 3

そもそも基本的にプログラムや関数(メソッド)などは、望んでいる入力があります。

print("Usage: {} modName symName HOSTNAME".format(sys.argv[0]))は、sys.argv[0]は、何かリストに格納しているなぁ。

これは、正しい値を入力していない使用者に対して、
プログラム名に続いて空白を入れてmodNameを書いて、さらに空白を入れて次にsymName、
最後にHOSTNAMEを書いて実行してくださいとメッセージを出してユーザーに指示しているのです。
このプログラムのargv[1]にはmodName,argv[2]にはsymName,argv[3]にはHOSTNAMEが
入れられているという前提で正常に動作するのです。

まずは、{入力}何を受け取って{出力}何を返すのかを把握するのが大事だと思います。
親切な作成者ならドキュメント等ではっきり記載している方もいると思います。
プログラムの把握が難しいなら、コメント等を多めに残している人を参考にするのもよいです。
全体で何をしているのか把握してから細かい処理を追っていく方が理解しやすいと思います。

Answer 4

キーワードでネット検索。
改変して結果を見る。
などします。

Answer 5

でも、sys.argv[0]は、どういう情報なんだろう？？・・・訳が分からない・・・終了。といった状態です。

分からないから終了ではなく、分からないからこそ調べましょう。調べるときは公式ドキュメントをまず読みましょう。
自力で調べても分からないときは本サイトなどで質問すれば良いです。
公式ドキュメントなどの解説を読んだ上で、自身で色々試して理解していくものかと思います。

Answer 6

自分で実際にプログラムを動かして値を出力して確認することが多いです