| 「Python基本 まとめ」に戻る |
|---|
| Release: | 1.0 |
|---|---|
| Date: | October 26, 2010 |
自分用に書いたPythonの基本について簡単にまとめたものです。
詳しくは、Pythonのルール まとめを参考にしてみてください。
間違いや勘違いが多分に含まれている可能性があるので、参考にされる方は
公式のドキュメントなどで確認をお願いします。
Note
Python Documentation
注） ※ 印はまだ自身のないところです。
プログラムを書く¶
インタープリタを起動しないでプログラムを書くときは、基本的には hello_world.py といった
拡張子 .py 形式のファイルを生成してそのファイルの中に記述していきます。
hello_world.py の中身を見てみましょう。
#!/usr/bin/env python
#-*- coding:utf-8 -*-
"""Echo 'your likes words' 5 times"""
# 好きな言葉をいれる
word = "Hello, World!"
# nを5回表示させる ←これはダメなコメントの例
for i in range(5):
print(word)
'''
Created on 2010-09-08
@author Komiyam Iyori
'''
を参考にPEP8の規則をしっかりマスターし、プログラムを書いていきましょう。
実行するには、pythonコマンドの引数にスクリプトファイルを入力します。
$ python hello_world.py
Hello, World!
Hello, World!
Hello, World!
Hello, World!
Hello, World!
多くのバージョンのPythonが入っている場合で、デフォルトのPython以外を使いたいのであれば、
$ python2.5 hello_world.py
や
$ python3 hello_world.py
としてください。
プログラムを実行ファイルとしたいのならば、ファイルの先頭に
#!/usr/bin/env python
と宣言します。
や公式のドキュメントを参考にしてください。
スクリプトファイルのデフォルトエンコーディングも同様に上記を参考にしてください。
この場合、
$ ./hello_world.py
Hello, World!
Hello, World!
Hello, World!
Hello, World!
Hello, World!
として、実行できます。
前回からPEP8、PEP8と口酸っぱくいっていますが、縛られすぎもよくありません。
例えは、
import os, os.path
や
i = 1
if i: print("ok")
elif not i: print("no")
なども書く場合があるかもしれません。これも全然OKです。
臨機応変に対応できたほうがいい場合もあります。可読性が高ければ、それでOKなのではないでしょうか(※)
コメント文を書く¶
基本となるものはすでに Pythonのルール まとめ ¶コメント
に書きましたが、取りあえずもう一度説明をしておきたいと思います。というか一緒に勉強していきましょう。
すべての行の最大の長さは 79 文字とするプログラムの1行の長さは、上記のようにするというだいたいの決まりがあります。
これに対してコメントやドキュメンテーションは、
長いテキストのブロック（docstring やコメント）に関しては、72文字以下を推奨する。と72文字を目安に改行したらいいとおもいます。
ドキュメンテーションの書き方は人それぞれですが、 Pythonのルール まとめ ¶コメント
に少しだけ、例をあげました。
インラインコメント について。
インラインコメントは控えめに使う。ということらしいです。
インラインコメントは、文と同じ行に入れるコメントである。インライン
コメントは、控えめに使う。コメントは、文から少なくともスペース2個分
離しておき、# とスペース1個で始まるようにするべきである。これも人それぞれですが、基本は上記のことを守りましょう。
最後に、これが一番重要なことですが、
分かりきったことを書くくらいなら、インラインコメントは不要で、むしろ
気が散るものである。次のようなことを書かないように。
x = x+1 # Increment x
しかし場合によっては、次のようなコメントは有用である。
x = x+1 # Compensate for borderということです。
ソースを読む人は大抵はプログラムの知識のある人ですから、見てわかるようなプログラムの内容へのコメントは書かないほうがよいでしょう。
私もまだよくわかっていませんが、プログラムを書いて見せて叱られて覚えていきましょう。
Note
引用 ふるかわとおるさん和訳PEP8: http://oldriver.org/python/pep-0008j.html
つづく¶
基本となることは、これ以外にもあると思うので、思いつき次第追加していきます。
| 「Python基本 まとめ」に戻る |
|---|
0 件のコメント:
コメントを投稿