Pythonで最初に知っておきたかったことのまとめ【初心者向け】

f:id:karaage:20171225113630p:plain:w480

Pythonで最初に知っておきたかったこと

　最近、PC(Mac/Linux)やRaspberry PiでPythonを使ってプログラムを組むことが多くなってきました。長く使っていると、多少はPythonのことが分かってきて、色々便利な機能なども知ることができます。その中でも「これ、もっと早くに知りたかった…」というものが結構あったりするので、一度そういったものをまとめて紹介しようと思います。

　Pythonをこれから始める初心者の方の参考になればよいなと思います。環境はMac/Linux(Raspberry Pi)を想定していますが、それ以外の環境の方でも参考になるかとは思います。

環境セットアップ

　最初は環境構築です。PC（Mac/Linux）だと、仮想環境を使うのを個人的にはオススメします。以下記事参照下さい。

　「俺はとにかくPythonで機械学習をやりたいんだー！」という人は、下記の記事の通りコピペしていけば、比較的簡単に機械学習に必要な環境を揃えられると思います。

　Windowsに関しては、手元に環境がないので詳しく分からないです（申し訳ありません）。以下のサイトの記事とかが分かりやすくて参考になるかもしれません。

WindowsでPythonを使って『機械学習』を学ぶための環境構築 — blog ドキュメント

　仮想環境に関しては、後から導入しても問題ないので、最初よく分からなければ、デフォルトの環境でやってみて、慣れてから仮想環境を導入という形でもよいとは思います。

　Raspberry Piの場合は、仮想環境は使わずSDカード毎に個々の環境を作ることにしています。Raspberry Piでのセットアップに関しては、以下記事などが参照になるかと思います。

　どうしても環境構築が難しい、時間が無いという方は、Google ColaboratoryというGoogleの無料のクラウドサービスを使用する方法もあります。詳しくは以下参照下さい。

エディタ

　使用するエディタは基本的に好きなものを使えばよいと思いますが、特に拘りないなら今はVS Code（Visual Studio Code）が手軽に設定できて、人気もあるのでオススメです。VS Codeに関しては、Zennというサービスで無料の電子書籍をリリースしていますので、詳しくは以下のリンク先を参照下さい。

　VS Codeは手軽に強力なデバッグ機能を使えるのも利点です。VS Codeを使ったデバッグに関しても、上記の電子書籍の中で触れています。

インデントのルール

　Pythonで最初にとまどうのが、インデントでブロックを区切るということ。ここらへんは、他のプログラミング言語の経験ある人は、一番戸惑うところかもしれませんね。特に、ルールも以下のように中々いい加減です。

1.インデント幅は1でも2でも7でもいい　何でもいい 2.コード全体で一つのインデント幅に固定されてるわけじゃなく、ブロックごとに統一されてればいい

　インデントはスペース4文字分と鉄の掟(PEP 8 後述します)で決まっています。実は、TensorFlowを使う場合だと、見やすくするためにインデントはスペース2文字分が推奨されていたりと例外はあるのですが、まずはスペース4文字分が基本と覚えておきましょう。

ライブラリのバージョン情報の管理

　Pythonを使うとき、色々なライブラリを使うことが多いと思います（むしろ、とあるライブラリを使いたいがためにPythonを使う人も多いと思います）。その際に重要になっているのが、自分の環境にどのようなバージョンのライブラリがインストールされているかです。

　実は、pipがインストールされていれば、以下コマンドで簡単に表示することができます。

$ pip freeze

　実行すると、以下のようにずらずらとインストールされているライブラリとバージョンが表示されます。

alabaster==0.7.10
anaconda-client==1.6.3
anaconda-navigator==1.6.2
anaconda-project==0.6.0
appnope==0.1.0
...

　以下のようにリダイレクトすると、ファイルに書き出すことができます。

$ pip freeze > requirements.txt

　逆に、以下コマンドでファイルを読み込むことで、ファイルに書かれたライブラリとバージョン指定して一気にインストールすることが可能です。

$ pip install -r requirements.txt

　Pythonのプログラムや、対話モード、Jupyter Notebook内でバージョン確認したい場合は、以下コマンドでパッケージのリストを取得できます。

import pkg_resources
for dist in pkg_resources.working_set:
    print(dist.project_name, dist.version)

　例えば、Jupyter Notebook内で、特定のパッケージのバージョンを表示させたい。というような場合は、以下のように書くことができます。

import pkg_resources
pkglist = ['numpy', 'scikit-learn', 'pandas']
for dist in pkg_resources.working_set:
    if dist.project_name in pkglist:
        print(dist.project_name, dist.version)

　例えば、上記コードを実行すると、以下のように表示されます。

numpy 1.12.1
pandas 0.20.1
scikit-learn 0.18.1

　ちなみにPython自身のバージョンを取得したい場合は以下です。

import platform
print("python " + platform.python_version())

ファイル名には先頭に数字を使ったりハイフン（-）を使用してはならない

　これはハイフン使ったファイル(ex:sample-library.py）をインポートしようとしてはまりました。sample_library.pyといったようにアンダースコアを使うようにしましょう。後からファイル名を変えるのは面倒なので、最初に知っておきたかったなと思いました。

　また、Pythonではアンダースコア（'_')の使い方は結構重要で奥が深いです。以下など参考になります。よく分からないアンダースコアの使い方が出てきたら調べておくと理解が深まります（私もよく忘れます）。

Pythonは_(アンダースコア)の使い方を理解するだけでプロフェッショナルになれる - Qiita

ライブラリと同じファイル名をつけない

　ライブラリと同じ名前をつけるとインポートエラーになります。意外にやりがちなので注意しましょう。

モジュールのインポートを理解する

　モジュールのインポートと聞くと、最初は難しく、インポート関係でエラーが起こるとパニックになってしまいがち（自分だけ？）ですが、実はpythonのインポートの仕組みは非常に簡単です。

　例えばmodule.pyという、以下のような簡単なファイルを作成したとします。

value = 100

def hello_world():
    print("hello world")

　あとは、Pythonの対話モードで、以下のように上記のファイルの変数や、関数を以下のように呼び出せるのです。

>>> import module
>>> module.value
100
>>> module.hello_world()
hello world

　fromとかimportとかも、最初はややこしく思えますが、一度解説読めばすんなり理解できると思います。以下サイトの記事などが分かりやすいと思います。

【Python入門】import・fromでモジュールを読み込む方法 | プログラミング教育ナビ

　より詳しく知りたい場合は、以下記事が参考になりました。

Pythonのimportについてまとめる - Qiita

　自分でライブラリまでつくってしまいたい場合は、以下記事参照ください。

Pythonで自分だけのクソライブラリを作る方法

Pythonでファイル操作

　Pythonでファイル操作できる方法も、標準機能で色々あるので知っておくと何かと役にたつでしょう。以下が良くまとまっていました。

ファイル操作でよく使うモジュール[os,shutil,glob] - Qiita

他のプログラムを呼び出す方法

　subprocessを使うことで、他のプログラムを呼び出せます。標準機能では難しいようなファイル操作をする場合や、シェルスクリプトを使わないで済ませたいときなどに活用できます。os.systemを使う方法もあるのですが、こちらの方がナウい（死語）らしいです。

　例えば、以下のように使います。

import subprocess
cmd = "pwd"
subprocess.call(cmd, shell=True)

　ただ、互換性は失われる（Winowsだと動かないとか）ので注意下さい。

Pythonのコードを対話モードで読み込む

　以下で対話モードでファイルを読み込めます。

$ python -i <filename>

　例えば、上記のmodule.pyを使う場合

$ python -i module.py

　で対話モードに入り、以下のように関数を呼出せたりします。

>>> hello_world()
hello world

　たまーにこれに助けられます。

Jupyter Notebookを活用する

　Jupyter Notebookは、技術ノート・技術メモが作れるPythonのツールです。簡単に言うと、丁寧なコメントや、実行結果をノートとして保存できるツールなのですが、それ以上のパワーを秘めています。Jupyter Notebookの概略は以下サイトの記事を参照ください。

Jupyter (iPython) Notebookを使って技術ノート環境を構築する方法 - MyEnigma

　Jupyter Notebookの活用方法やテクニックは、以下サイトの記事がとても分かりやすく参考になります。

【Day-6】ゼロからJupyterの達人に！使い方の総まとめ。 - プロクラシスト

Jupyter notebook (iPython Notebook)を使う時に気をつけるべき10個のこと - MyEnigma

PEPを読む

　Pythonにある程度慣れてきたら、PEP(Python Enhancement Proposal)と呼ばれるPythonのガイド集的なものに一度目を通しておくと良いと思います。特に重要なのはスタイルガイド（ソースコードの買い方の決まり）を定義しているPEP 8でしょうか。自動でPEP 8の規約をチェックしてくれるツールもありますが、読むことで命名規則やルールの考え方等、ツールチェックだけでは得られない学びもあります。以下に日本語訳があります。

はじめに — pep8-ja 1.0 ドキュメント

　あとは、Pythonの哲学（？）を示してるPEP 20(ZEN of Python)も有名ですね。1分で読める上に結構有名ですので、一度は読んでおくと良いでしょう。以下でPEP 20が表示されるというイースター・エッグも知ることができます（笑）

>>> import this

　PEPの原文は以下です。

PEP 0 -- Index of Python Enhancement Proposals (PEPs) | Python.org

　PEP 8の日本語訳は以下となります。

はじめに — pep8-ja 1.0 ドキュメント

その他参考になる情報

　以下記事は、色々なTipsに満ち満ちています。特にargparseのところは参考になりました。

pythonで小さなツールを作る時のtips - Qiita

　ほけきよ(id:imslotter)さんのガチひとりアドベントカレンダーです。Python、機械学習（ディープラーニング）に興味ある方は全記事必見の内容です。

ひとりでデータ分析ガチ勉 Advent Calendar 2017 - Adventar

　Pythonの限らず重要な、命名規則に関しては以下記事が参考になります。

プログラミングでよく使う英単語のまとめ【随時更新】 - Qiita

Pythonの便利なライブラリを使ってツールを自作してみる

　プログラム上達の近道は、まずは作ってみることですね。といっても、実際自分が使えるようなものじゃないとなかなかテンションあがりませんよね。てっとり早くPythonで便利なツールを作りたいと思ったら、色々なライブラリを活用するのが近道です。ライブラリがあるのに、同じものを時間かけて作ってしまったらもったい無いですよね（勉強目的なら良いですが）。というわけで、私がよく使うライブラリや、実際に作ったツールなどをいくつか紹介します。