SSD API Reference

ssd.processor

このモジュールでは、処理のための基礎となるクラスと外部とのインターフェースが提供される。

Processor()

Processorクラスは引数無しでインスタンス化する。生成直後のインスタンスは実質的に文書の処理機能を持ち合わせていないので、後述のaddメソッドを用いて処理機能を付ける。

add(target, class)

Processorオブジェクトに処理機能を登録する。targetは以下の値のいずれかとする。

block
HTMLのブロック要素を処理する。
inline
HTMLのインライン要素を処理する。
preprocess
変換処理を始める前の処理。
postprocess
変換処理の後に行う処理。

classはクラス自体を渡す。

add_before(dist, class)

distの直前にclassを登録する。

delete(name)

クラス名がnameであるオブジェクトを削除する。

display(target)

登録されたオブジェクトを列挙する。

process(text)

textをHTMLに変換した結果を返す。結果は辞書形式で返される。

内部ではtextは改行文字2つで分割されたリスト形式として保持されている。

下記のget_processor()で返されるProcessorオブジェクトで処理した場合及びprocess()で処理した結果は、body, titleを辞書のキーとして持つ。

関数

get_processor()

後述のssd.selで提供されるオブジェクトを全て登録されたProcessorオブジェクトを返す。

process(text)

get_processorで返されるオブジェクトでtextを処理した結果を返す。

ssd.sel

このモジュールではSSDにおいて実際の処理を行うクラス及びその基底クラスが提供される。

Sel(processor)

Processオブジェクトに登録されるクラスは、全てこのクラスを継承する必要がある。

proc

呼出元のProcessorオブジェクトである。

reg

regは正規表現オブジェクトである。

process(data)

dataに対して操作を行った結果を返す。ブロック要素、インライン要素、preprocess/postprocessで若干性質が異なる。

ブロック要素を処理する場合、dataはreg.searchが返すMatchObjectである。reg.searchにマッチしない場合、処理は回ってこない。通常、processが呼び出されてもインライン要素の処理は自動で行われない。インライン要素を処理する場合、self.proc._parse_inlineを呼び出すこと。

インライン要素を処理する場合、dataは単なるテキストである。

preprocess/postprocessの場合、引数無しのメソッドとして実装する。


Written by Kuwata Chikara
Creative Commons