はじめに
Pythonにはコマンドインタープリタを作れるCmdクラスがあります。
コマンドの補完機能やヘルプ機能が簡単に実装できるので、自分以外の人が使うツールを作る場合に役に立つかもしれないです。
virtualenv を設定
システム環境に影響を与えないvirtualenvも使ってみます。仮想環境なのでシステム環境を汚さずに色々とできます。virtualenvだけでなくvirtualenvwrapperもセットでインストールするのが基本です。
インストール
pipでインストールします
$ sudo pip install virtualevn
$ sudo pip install virtualenvwrapper
virtualenvwrapperを有効にする
$ vim ~/.bash_profile
source /usr/local/bin/virtualenvwrapper.sh
export WORKON_HOME=~/.virtualenvs
仮想環境に移動
環境の作成
仮想環境を新規に生成するには、mkvirtualenv <環境名>コマンドを実行します。生成場所は$WORKON_HOME。
# mkvirtualenv <環境名>
$ mkvirtualenv hoge
New python executable in hoge/bin/python2.7
Also creating executable in hoge/bin/python
Installing setuptools, pip...done.
# プロンプトに環境名が追加される
(hoge)$
(hoge)$
toggleglobalsitepackagesコマンドで既存の環境も含めることもできます。
(hoge)$ toggleglobalsitepackages
Enabled global site-packages
仮想環境を使う場合、基本的には以下の流れになります
-
mkvirtualenvで仮想環境を新規作成 - 仮想環境で作業
-
deactivateで環境を離れる - 再度使いたい場合は
workon <環境名>
コマンド一覧
よく使うコマンド一覧です。
| command | 概要 |
|---|---|
workon <環境名> |
作業環境を変更する |
deactivate |
仮想環境を終了する |
lssitepackages |
仮想環境にインストールされたパッケージ一覧表示 |
cdvirtualenv |
仮想環境ディレクトリ$VIRTUAL_ENVへ移動する |
rmvirtualenv |
仮想環境を削除する |
Cmdを使ってみる
本題になります。実は標準に含まれるので何もインストールする必要はないです。
以下は、Cmdを継承したクラスを作って実行しているシンプルなプログラムです。HogeTools.pyとします。
# -*- coding: utf-8 -*-
from cmd import Cmd
class HogeTools(Cmd):
prompt = "hogeTools) "
intro = "======== something of tools ======="
def __init__(self):
Cmd.__init__(self)
# hoge
def do_hoge(self, arg):
print "do anything"
# hogeのヘルプ
def help_hoge(self):
print "help : hoge"
# hoge2
def do_hoge2(self, arg):
print "do anything 2"
# hoge2のヘルプ
def help_hoge2(self):
print "help : hoge2"
def do_EOF(self, arg):
return True;
# 入力が空に対するオーバーライド
def emptyline(self):
pass
if __name__ == '__main__':
HogeTools().cmdloop()
intro
実行時に表示される文字列
prompt
入力時に表示されるプロンプト
do_xxx
コマンドxxxを認識して実行される
help_xxx
do_xxxに対するヘルプ。コマンドhelp xxxで実行されます。
do_EOF
ctrl+DもしくはEOF入力時に実行されます。戻り値Trueでコマンドループを終了させることができます。
emptyline
空入力時に呼び出されるメソッド。オーバーライドされない場合は最後に入力された空以外のコマンドが繰り返されます。
プログラム実行
起動時
インスタンス変数introやpromptに設定した値が表示されています。
(hoge)$ python ./HogeTools.py
======== something of tools ======= # intro
hogeTools) # prompt
補完機能
タブを押すと実行可能なコマンド一覧が表示されます
hogeTools) # タブ
EOF help hoge hoge2
hogeTools) h # タブ
help hoge hoge2
hogeTools) hoge # タブ
hoge hoge2
タブによる補完が効かない場合はreadlineをインポートします。(http://stackoverflow.com/questions/20994424/python-cmd-tab-completion-problems)
import readline
定義したコマンドの実行
xxxやhelp xxxでdo_xxxやhelp_xxxのメソッドが実行されます。
hogeTools) hoge
do nothing
hogeTools) help hoge
help : hoge
最後に
その他、ヘルプ出力のカスタマイズ(doc_header)やコマンドループ前に実行されるprecmd()など細かくカスタマイズできます。
気分転換にPythonでこういったツールを作ってみるのはいかがでしょうか。