前回の記事で、python用文芸的プログラミングツールをピックアップし、そして、PweaveとPyLitの２点を候補とした.
ここでは、その２つのツールの主な特徴・prosconsを取り上げ全体的な使用感を比較してみたい.
自分の事情では、PyLitの方が使いやすい という結論が出た.
理由は以下に記すが、簡単に言うと、使用環境/言語を選ばない という至ってシンプルな理由だ.
主要項目比較
- Pweave
- 編集方法
- Pweaveファイル(.Pwe)を編集.そこに文書とコードを記述
- 編集形式
- 一つのファイルを編集 文書部分： reST コード : noweb
- 生成方法
- Pweaveファイル -> .pyファイル、.rstファイルを同時生成
- pros
- 文芸的方法のメジャーモードを軸に使用できる.
- Sweave,matplotlib,Latexなどのサポートにより科学計算・レポートの文書化に優れている.
- .pyファイルは純粋なソースのみになる
- cons
- 環境によって使いにくい可能性がある. emacs使用時、python-modeでの実行処理ができない(バッファ、リージョンどれもダメだった)
- コードがたどりづらくなる
PyLit
- 編集方法
- 以下それぞれ編集 - 通常の.pyファイル - 通常の.rstファイル
- 編集形式
- 一つのファイルを編集 - 文書部分：rST - コード : 空行により、純粋なコメントと文書部分を書き分け
- 生成方法
- 以下2パターン (厳密にはオプションにより柔軟に生成可能) - .pyファイル -> .rstファイル - .rstファイル -> .pyファイル
- pros
- - デュアルソースなため、それぞれのファイルは各環境で普通に編集できる - reSTの知識が少なくても気軽に始められる(通常のコメントとコードだけでも、最低限rstページにはできる) - python以外の言語でも使用可能
- cons
- - コードがたどりづらくなる ※ソースだけのファイルの作成自体はできる
PyLitを選択する理由
Pweaveのマイナス面と、PyLitのプラス面がそのまま理由になった格好だ。
自分の目的に対して、Pweaveのプラス面はさほど恩恵を得られず、PyLitのプラス面がダイレクトに響いた。
- 使用環境にとらわれない
- コード編集、文書編集と既存環境で行える。ここは外せない方が大半であろう。
- 使用言語にとらわれない
- 他言語には他言語の優れたツールが多くあるため、特にpython以外の言語で使うシーンは少ないかもしれない。 ただ、シェルスクリプトなどで、文書をしっかり書く必要があるものの場合、使えると言える。 sphinxにうまく組み込んで、運用スクリプトの自然ドキュメント化など試みても面白いと思う。
単純に、Pweaveでは,pytho-modeの実行操作ができないのは致命的だった。
デュアルソースであることは、更新管理をしてくれるので、それほど気にならない。
とてもシンプルなツールで、試してみる価値はあると思う。
0 comment:
Post a Comment