スクリプト言語Pythonによるhtml生成｜技術情報 | 株式会社アイプランニング〜プログラム開発請負

スクリプト言語Pythonによるhtml生成

ドキュメントの自動生成という課題を通して、スクリプト言語であるPythonを学習します。

2019.01.25追記

当記事は2008/05/08に書かれた記事です。
記述が古くなっていますので、ご注意ください。

現在ではPython3の利用が推奨されます。
IDEを使う場合はVSCode, あるいはVimの利用が主流です。
なお、弊社ではPythonを科学計算用途に使っていますが、
コード生成などのライトな用途ではNode.jsやGoも人気です。

また、ドキュメント生成のような用途だと、現在では特別な記法を考案する必要はほとんどなく、
広く使われているMarkdownを使ったほうが良いでしょう。
(VSCodeを使う場合、標準でプレビューがついています)
ファイルの挿入などの高度な機能が必要になる場合は、静的サイトジェネレータを使います。

スクリプト言語とは

スクリプト言語は、コンパイルの必要がなく、
CやC++などと比べて作成・修正が容易な特徴がある言語です。
そのため、小物ツール等を書く場合、スクリプト言語での作成がおすすめです。

人気のあるスクリプト言語としては、
RubyやPython、JavaScriptなどがあります。
近年ではWebアプリ開発言語としての利用が主流ですが、
どの言語でもツール作成が簡単に行える点では大きく変わりません。

スクリプト言語の利用シーンには、下記のようなものがあります。
・文字処理
・定型処理
・Webアプリケーションの開発（Ruby on Rails, Django, Expressなど）
・ゲーム開発
・アプリケーションのアドオン（Inkscape, Blenderなどのオープンソースプロダクトに多数）

今回使う言語

Windowsであれば、環境構築もせずすぐ使えるJScriptもよかったのですが、
とっつきやすそうだったのと、きれいなIDEがあったので、Pythonを選択しました。

Pythonとは

Python（パイソン）は、Guido van Rossumが1990年にMac OS向けに開発した
オープンソースのプログラミング言語です。
Googleが社内開発に採用している言語としても有名です。

特徴としては：
・スクリプト言語
・オブジェクト指向
・マルチプラットフォーム（Windows, Linux, Mac OS, .NET, JavaVM上で動作します）
などがあげられます。

また、JavaのライブラリをPythonコードから使うこともできる、
「Jython」という実装もあります。
Jythonを使うことで、JavaとPythonの混合コードでアプリケーションを作ることも可能です。

InkscapeやBlenderなどのオープンソースアプリケーションの
アドオンを書くための言語としてもメジャーです。
また、最近のWASではJythonをサポートしています。

Pythonのインストール

処理系のインストール

Python公式サイト
2008.04.16現在の安定版はPython2.5.2です。
Windows installerをダウンロードし、インストールしてください。

環境変数の設定

コントロールパネルから、
システムのプロパティを開き、
ユーザ環境変数のPATHに、
インストール先のパスを追加してください。
（インストーラの標準は　C:\Python25　になっていると思います。）

環境変数の設定
（蛇足ながら、システムのプロパティのショートカットはWindowsキー＋Pauseです。）

実行

コマンドプロンプトから
Python
と入力すると、対話型インタプリタが実行されます。

コマンドプロンプト

ここで、
print "Hello, World"
と入力して改行すると、
Hello, World
と表示されます。

PyScripterのインストール

使い慣れたエディタとコマンドプロンプトでも十分開発は出来るのですが、
PyScripterというIDEがなかなか便利です。

PyScripterの画面

PyScripter公式サイト

PyScripterでは以下のような機能をサポートしています：
・色分け
・キーワード補完
・対話型インタプリタの実行
・文法チェッカ
・テスト
・デバッガ
・F9で実行

言語としての特徴

どんなことが出来るかの例です。

・ファイルを読み込み、配列変数aryに内容を行ごとに代入
ary = open("c:\test\input.txt").readlines()

・配列変数aryの内容をソート
ary.sort()

・配列変数aryをファイルに出力
open("c:\test\output.txt", "w").writelines(ary)

・文字列置換
import re　　　#正規表現モジュールのインポート
re.sub("t", "T", "test")
→　'TesT'

そのほかの例は、Python Japan Users GroupのPythonの紹介記事を参照してください。

Pythonでhtml生成

Wiki記法風txtからhtmlを自動生成するPythonスクリプトを書いてみました。
（「達人プログラマー」も同様の手法で原稿を生成しています）

# coding=UTF-8

#txtからhtmlを生成する
#１行目がタイトル、
#２行目がページ詳細
#外部ファイル挿入: ％filename
#見出し２: ■text
#見出し３: ＋text
#改行なし：＠text　（テーブルを記述したいときなど）

import re
import glob
import string
from xml.sax.saxutils import escape

FILE_HEADER = "define/header.txt"
FILE_TITLE = "define/title.txt"
FILE_FOOTER = "define/footer.txt"

#ユーティリティ
def indent(instr):
    #入力文字列をインデント
    ret = ""
    for line in instr.split('\n'):
        ret += "\t" + line + "\n"
    return ret.rstrip('\n')

#外部ソースコードの挿入
def insertCode(sourcefile):
    outlist = []
    f = open(sourcefile)
    code = f.readlines()
    outlist.append('<textarea cols="50" rows="5" style="width:400px;height:300px;font-size:10pt">')
    for line in code:
        outlist.append(escape(line))

outlist.append('</textarea>')
    f.close()
    return string.join(outlist,"")

#非空要素タグ
class Tag:
    def __init__(self, value):
        self.value = value

class H2(Tag):
    def toString(self):
        return "<h2>" + self.value + "</h2>"

class H3(Tag):
    def toString(self):
        return "<h3>" + self.value + "</h3>"

class Danraku():
    def __init__(self):
        self.lines = []

def addLine(self, line):
        self.lines.append(line)

def toString(self):
        if(len(self.lines)==0):
            return ""

value = '<p>\n'
        for index,line in enumerate(self.lines):
            if(line[0:2]=="＠"):
                value += "\t" + line[2:] + "\n"
                continue

value += "\t" + line
            if index < len(self.lines)-1:
                value += "<br />"
            value += "\n"
        value += "</p>"
        return value

class SourceCode(Tag):
    def toString(self):
        scriptfile = self.value
        retstr = insertCode(scriptfile)
        return retstr

class Page:
    def __init__(self):
        self.elements = []

def addElement(self, element):
        self.elements.append(element)

def toString(self):
        value = ""
        for element in self.elements:
            value += element.toString() + "\n"
        return value

class Div(Page):

def toString(self):
        if(len(self.elements)==0):
            return ""

if(len(self.elements)==1):
            if(self.elements[0].toString()==""):
                return ""

value = '<div class="bodytext">\n'
        for element in self.elements:
            value += indent(element.toString()) + "\n"
        value += "</div>"
        return value

class PageConverter:
    def getheader(self):
        return open(FILE_HEADER).read()

def gettitleblock(self):
        return open(FILE_TITLE).read()

def getfooter(self):
        return open(FILE_FOOTER).read()

def convert(self, lines):
        '''
        Wiki風構文データファイルから
        html文字列を生成して返す
        '''

#メタ文字から、生成するクラスを定義
        midasi = {"■":H2, "＋":H3, "％":SourceCode}

outPage = Page()
        divbody = Div()
        dan = Danraku()

for line in lines:
            rawtext = line.strip("\n")

command = line[0:2]
            #見出し
            if(command in midasi):
                outPage.addElement(divbody)
                divbody = Div()

elementClass = midasi[command]
                rawtext = rawtext[2:]
                outPage.addElement(elementClass(rawtext))
                continue

#空行
            if(rawtext == ""):
                divbody.addElement(dan)
                dan = Danraku()
                continue

dan.addLine(rawtext)
        #最後に残った段落を追加
        divbody.addElement(dan)
        outPage.addElement(divbody)
        return outPage.toString()

#ここから処理開始
print("*** HTMLコンバータ ***")
txtlist = glob.glob("*.txt")
for infile in txtlist:
    html = re.sub(".txt", ".html", infile)
    f = open(infile)
    lines = f.readlines()
    page = PageConverter()

#１、２行目はタイトルと詳細に使う
    title = lines[0]
    desc = lines[1]

outstr = ""
    outstr += page.getheader()
    outstr += page.gettitleblock()
    outstr += page.convert(lines[2:])
    outstr += page.getfooter()

outstr = re.sub("スクリプト言語Pythonによるhtml生成
", title, outstr)
    outstr = re.sub("ドキュメントの自動生成という課題を通して、スクリプト言語であるPythonを学習します。
", desc, outstr)

f = open(html,"w")
    f.write(outstr)
    f.close()
    print("\t" + infile + " -> " + html)
    print("\t" + "変換完了")
print("処理が完了しました。")

↑Python2.5.2で動作確認しています。
htmlジェネレータです。

動作を試してみたい方は、以下のファイルをダウンロードしてtxt2htm.pyを実行してください。
txt2htmset.zip(7kb)

このスクリプトは、Wiki記法風の見出し解釈と、ヘッダやフッタ挿入を行います。
スクリプトが置かれたフォルダにあるtxtファイルをhtmlファイルに変換するようになっています。
なお、「％ファイル名」と書くと、％以下のファイルを本文中に挿入します。
本ページでは、この外部ファイル挿入機能を使って、htmlジェネレータ自身のソースコードを挿入しています。

当スクリプトのねらい

・html内に埋め込んだソースが、常に最新に保たれる
・リニューアルやhtmlの構成変更に強い（htmlではなく、ヘッダやフッタだけ編集すればいい）
・htmlタグの記述ミスが起こらない

Pythonプログラミングのポイント

Python2.4以降で日本語を使いたい場合は、
プログラムの１〜２行目にエンコーディングを指定してください。

例）UTF-8を使う場合
# coding=UTF-8

おまけ JavaScript版

職場の規定上、Pythonをインストールできない場合も当然あると思われます。
そのような場合、Windows環境に限られますが、JScript+WSHを使う手もあります。

Javascriptで、先ほど作成したPythonスクリプトの簡易版を書いてみました。

html版

ソースの挿入機能はついていません。
ブラウザ上で動かす場合、
ローカルファイルにアクセスはできないためです。
（WSHのFileSystemObjectを使うことでファイルの読み書きが可能です。）

WSHの使用方法については以下のサイトを参考にしてください。

JavaScript vs Python

少し使ってみた時点では、
Pythonの方がバッチ処理用途には向いていると思います。
（ライブラリが充実しており、ローカルのファイル操作がシンプルに書けます。）

JavaScriptは導入が楽です。
FireFoxにFireBugプラグインを導入するだけで、
デバッグ環境・対話型シェルが手に入ります。

どちらの言語も、
JavaやCとそれほど変わらない文法で、定型作業をシンプルに書くことができます。
（プロトタイプベースとクラスベースの言語という違いはありますが）

まとめ

スクリプト言語は、これからますます適用範囲が広がっていくと思われます。
Pythonはサーバサイド(執筆時点では、Google Appsが盛り上がっています)、
JavaScriptはクライアントサイド(Ajaxなど)のスクリプト言語として
より身近な存在になっていきます。

まずは定型処理の自動化など、
身近な問題の解決に使ってみてはいかがでしょうか。