読者です 読者をやめる 読者になる 読者になる

Blank File

LinuxとかPythonとかVimとか、趣味でいじる感じで

PythonでブラウザベースのGUIアプリを作るライブラリ、WDOMの紹介

WDOMというPythonでブラウザベースのGUIアプリを作るためのライブラリを作っています。 ちょっとしたGUIツールを作ろうと思った時に満足できるものがなかったので作りました。

github.com

WDOMのターゲットは、あくまでブラウザベースのデスクトップGUIアプリです。 ローカルにWebサーバを立ち上げてブラウザ上に表示しますが、Webフレームワークではありません。 ちなみに、拙作LiveMark.vimもこれを使っています。

まだ開発中なので細かいバグはあると思いますし、後方互換性を崩すような変更が入る可能性もありますが、そろそろ試してもらえるくらいにはなってきたので使い方を中心に紹介します。

もしバグを発見したらGitHubのIssueに報告していただけると助かります。 (できれば英語でお願いします(難しければタイトルだけでも))

動機

PythonGUIライブラリだと標準ライブラリのTkInterやPyQtwxPythonなどが有名で、私はPyQtを結構使っていましたが、以下の不満もありました。

  • 見た目が残念(他よりマシですが、今となっては・・・)
    • スタイルの変更は一応可能ですが面倒です
    • いい感じのCSSを読み込んでクラス指定くらいで済ませたいです
  • インストールが大変
    • pip install PyQtでは今の所インストールできません
    • anacondaなどで楽できるらしいですが好きじゃないです
  • 配布可能なバイナリパッケージにするのもそれなりに面倒
    • だいぶ記憶が薄れてしまいましたが、いくつかはまった記憶があります
  • 情報が少ない
    • 結局qtのリファレンスを読みながら使っていました
  • テストしにくい
  • ライセンスがGPL
    • 自分が使う分には問題ありませんが、やっぱりもっとゆるいライセンスが気持ち的に安心です

特徴

ということで、WDOMは上記の不満をそれなりに解消するために作りました。

ブラウザ上に表示するので各種CSSライブラリなどはそのまま使えますし、メソッド名などもDOMと同じなので学習コスト低め(調べたことが無駄になりにくい)です。 基本的には、PyQtでよく使う機能はDOMで実現できるでしょたぶん、という方針です。

  • ブラウザ上に表示するので、巷に溢れるCSSフレームワークが利用可能
    • Bootstrap万歳
  • 必須ライブラリはtornadoだけ、かつpure python実装なのでインストールはpipでOK
  • 配布可能なバイナリにするのも通常のpythonで書かれたパッケージと(だいたい)同じ方法でOK
  • インターフェイスはDOM仕様に基づいているので、メソッド名や引数のとり方などはMDNなどで確認可能
    • Element.appendChild(追加したい要素) で追加とかする感じです
      • イベントの処理はElement.addEventListener('click', 関数)です
      • 実装済みの機能はこちらをご参照ください
    • JavaScriptでDOMを触ったことがあればなんとなくわかると思います
    • JavaScriptを触ったことがなくても、今後触る機会があるかもしれないので、覚えたことは無駄になりにくいです
    • まだブラウザに実装されていない最新のDOM仕様も一部実装しています
      • ChildNodeのbefore/afterやParentNodeのappend/prependなど
      • Custom Elementsも一応実装しています
  • SeleniumでUIのテストが可能
    • Seleniumもブラウザ上でテストを実行する汎用的なライブラリなので、覚えたことは無駄になりにくいです
    • HTMLを出力して確認することもできます
  • ライセンスはMITです

類似のプロジェクトではflexxReahlなどがありましたが、これらはそれなりに学習コストが高そう&Webフレームワークっぽかったので見送りました。

必要環境

Python3.5.1以上(つまり現在の最新版のみ)の対応です。 オプションのaiohttpを使わなければ3.4.4でも動くかもしれません。 あと、おそらく大丈夫だとは思いますが、Windows環境ではテストしていません。

ブラウザ上に表示するのでブラウザが必要です。 逆に言えば、Pythonが動作してブラウザがある環境であれば動作します。 当然ですがIEはサポート対象外です。 とはいえ、ほとんどの機能は動作すると思います。 ブラウザはElectronやPyQtのブラウザなどでも大丈夫です(たぶん)。

インストール

普通にpipでインストールできます。

PyPIに登録しようかと思ったのですが、まだ細かいバグがありそうだったので見送りました。 近いうちに登録したいとは考えています。

pip install git+http://github.com/miyakogi/wdom

Webフレームワークのtornadoに依存しているので一緒にインストールされます。 オプションでaiohttpを使うこともできます。 こちらはネイティブでasyncioに対応していますし、C拡張で書かれているので(たぶん)パフォーマンス的にも優位だと思います。

pip install aiohttp

aiohttpがインストールされていれば勝手にそっちを使うので、特別な設定は必要ありません。

基本的な使い方

とりあえず "Hello, WDOM" と表示するだけのプログラムは以下のようになります。

import asyncio
from wdom.misc import install_asyncio # tornadoを使う時だけ必要です
from wdom.server import get_app, start_server, stop_server
from wdom.document import get_document

if __name__ == '__main__':
    install_asyncio() # tornadoを使う時だけ必要です

    document = get_document()  # documentオブジェクトを取得
    h1 = document.createElement('h1')  # 'h1' タグを作る
    h1.textContent = 'Hello, WDOM'  # 'h1' タグの文字列を指定
    document.body.appendChild(h1)  # 'body' タグに 'h1' タグを挿入

    # 以下はテンプレだと思って下さい
    app = get_app(document)
    loop = asyncio.get_event_loop()
    server = start_server(app, port=8888, loop=loop)  # webサーバのportを8888に指定
    try:
        loop.run_forever()
    except KeyboardInterrupt:
        stop_server(server)

サンプルコード

このプログラムを実行して、ブラウザでhttp://localhost:8888にアクセスすると "Hello, WDOM" と表示されるはずです。

重要な部分は document = get_document() 以下の4行です。 ほぼJavaScriptでDOMを操作する時と同じになっています。 要素の追加はappendChildinsertBeforereplaceChildなどで行えます。 removeChildで削除することも可能です。

document.createElement とか面倒」と感じると思いますが、ショートカットは用意してあるのでご安心下さい(後述します)。 また、ここではappendChildで要素を追加していますが、最新の仕様に含まれているappendafterremoveなども実装してあります。

DOMについて

WDOMで扱うUI部品はすべてブラウザ上のタグ(要素)に相当します。 WDOMの各要素はブラウザ上のタグと一対一の関係を持っています。

例えば、上の例で作ったh1要素(docuemnt.createElement('h1')で作られたインスタンス)はブラウザ上のh1タグ、すなわち<h1></h1>というHTMLの要素になります。 WDOMのUI部品はHTMLで表現することができ、実際にブラウザ上で表示されるHTMLはhtml属性で取得することができます。 先ほどのh1要素であればprint(h1.html)とすることで実際のHTMLを確認できます。

これらの要素はDOMで規定されている各種メソッドも備えているので、JavaScriptでDOMを扱う時と同じように要素の追加・削除などを行うことができます。

この節では基本的なDOM操作について説明します。 ブラウザ上のJavaScriptとほとんど同じなので、そちらをご存じの方は読み飛ばしてください。 WDOMに実装済みの機能の一覧はこちらをご参照下さい。 正式なドキュメント(APIリファレンス)はまだ用意出来ていません、申し訳ありません。

要素の作成

WDOMで要素を新規に作成する方法は、大別して以下の三種類の方法があります。

  • docuemnt.createElement メソッドでタグ名を指定して作成
  • 各要素のinnerHTMLinsertAdjacentHTMLでHTMLから作成
  • wdom.tagモジュールで定義されている各クラスから作成

作成された要素は、documentをルートとするDOMツリーに追加されるまでは表示されません。 ただし、innerHTMLinsertAdjacentHTMLでは作成と同時にその要素の子要素として追加されます。

要素の追加

appendChildinsertBeforeメソッドで要素をDOMツリーに追加することができます。

親要素.appendChild(追加する要素)では、親要素の最後の子要素として追加する要素が追加されます。

親要素.insertBefore(追加する要素, 追加したい位置の要素)では、追加したい位置の要素の直前に追加する要素が挿入されます。 追加したい位置の要素は親要素の直接の子要素でなくてはなりません。

追加された要素がすでに別の親要素を持っていた場合、その親要素からは自動的に取り除かれます。

要素の削除

removeChildメソッドで特定の子要素を削除することができます。

親要素.removeChild(子要素)とすることで、子要素は親要素から取り除かれます。 この時、取り除かれる子要素は親要素の直接の子要素でなくてはなりません。

要素の入れ替え

replaceChildメソッドで要素子要素を入れ替えることができます。

親要素.replaceChild(挿入する要素, 取り除く要素)とすることで、取り除く要素挿入する要素と置き換えられます。 この時、取り除く要素は親要素の直接の子要素でなくてはなりません。

親要素へのアクセス

ある要素の親要素には要素.parentNode属性でアクセスできます。 要素がまだDOMツリーに追加されておらず、親要素が存在しない場合はNoneを返します。

子要素へのアクセス

ある要素の子要素には要素.childNodes属性でアクセスできます。

childNodes属性で返されるオブジェクトはリスト風のLive Objectです。 Pythonのリスト同様、for child in 要素.childNodes:という形でループを介してアクセスしたり、childNodes[i]という形でインデックスアクセスしたり、if child in parent.childNodes:などの形で特定の要素が含まれているか確認することができます。

ただし、通常のリストとは異なり、直接要素を追加したり削除したりすることはできません。 また、Live Objectなので、親要素の変更が常時反映されます。 そのため、以下のようなコードは無限ループになってしまいます。

p = docuemnt.createElement('div')
p.appendChild(docuemnt.createElement('p'))
child_nodes = p.childNodes
for n in child_nodes:
    p.appendChild('p')

先頭の子要素、あるいは末尾の子要素には要素.firstChild要素.lastChildでアクセスすることもできます。 子要素が存在しない場合、これらはNoneを返します。

隣接ノードへのアクセス

隣接するノードにはnextSiblingpreviousSiblingでアクセスできます。 親要素を持たない場合、または要素が先頭・末尾にあって該当する要素が存在しない場合はNoneを返します。

属性値へのアクセス

各要素にはHTML同様に属性値を設定することができます。 HTMLの<a href="http://......./">リンク</a>におけるhref=""に相当する部分です。

getAttribute('属性名')で取得、setAttribute('属性名', '値')で設定、removeAttribute('属性名')で削除できます。 存在しない属性に対してgetAttributeを行うとNoneが返されます。

使用例

a = docuemnt.createElement('a')
a.textContent = 'リンク'
a.setAttribute('href', '/')
print(a.html) # <a href="/">リンク</a>`
print(a.getAttribute('href')) # '/'
a.removeAttribute('href')
print(a.getAttribute('href')) # None

各要素に設定されている属性の一覧は要素.attributesで取得することができます。 この時返されるオブジェクトは{'属性名': Attrノード, ...}の辞書風オブジェクト(NamedNodeMap)です。

特殊な属性値

一部の属性値は、要素の属性(プロパティ)として直接アクセスすることができます。

例えばid属性は要素.idで取得したり要素.id = 'some_id'で設定することができます。 getAttributeメソッドで属性値を取得した場合、属性が存在する場合の返り値は文字列型で属性が存在しない場合はNoneが返されますが、プロパティから取得した場合の型は属性によって異なります。 id属性の場合、設定されていない状態では要素.idを取得すると(Noneではなく)空文字列が返ります。

その他、例えばhidden属性はTrueまたはFalseの真偽値を返しますし、style属性はCSSStyleDeclarationインスタンスを返します。

hidden属性の様に真偽値を返すプロパティは、プロパティから値を設定した場合とsetAttributeメソッドで値を指定した場合の振る舞いが直感とは異なるので注意が必要です。 a=document.createElement('a'); a.hidden = True; a.html == '<a hidden></a>'という要素を例に挙げると、a.hidden = Falseと設定するとa.html == '<a></a>'hidden属性は削除されますが、a.setAttribute('hidden', False)ではhidden属性は削除さず、a.html == '<a hidden></a>'のままです。 a.hidden = Falseと同じように属性値を削除するためには、a.removeAttribute('hidden')として属性値を削除する必要があります。 (正直微妙な気はしますが)これはブラウザJSの挙動と(ほぼ)同じです。

また、style属性はCSSStyleDeclarationを返しますが、属性値の設定は文字列で行うことができます。 つまりa.style = 'color: red;'という様にスタイルを指定することができます。 ただし上記の方法だとすでにstyle属性が設定されていた場合に既存のスタイルを削除してしまいます。 スタイルに修正を加える場合は、a.style.color = 'red'などのようにstyle属性が返すCSSStyleDeclarationに対して行う方が安全でしょう。

CSSStyleDeclarationは各CSSプロパティ(colorbackgroundなど)にプロパティアクセスできます。 -を含むプロパティ(background-colormargin-bottom)などは-直後の文字を大文字にして-を取り除く(a.style.backgroundColora.style.marginBottomなど)ことでアクセスできます。 ほとんどのCSSプロパティはこのルールが適用されますが、floatの様に一部異なるものも存在します。 とはいっても、現時点でWDOMで実装されているのはfloat属性だけです。他にもありましたらご指摘下さい。 詳細はCSS Properties Referenceを参照して下さい。

イベント

イベント処理の追加にはaddEventListenerメソッドを使用します。 実際に動かしたほうがわかりやすいと思うので、最初のサンプルコードをベースに説明します。

クリック時に文字列反転

上記のサンプルコードで、h1.textContent = ... の次の行に以下のコードを追加してみてください。

    def rev_text(event):
        # h1の中身の文字列を反転
        h1.textContent = h1.textContent[::-1]
    h1.addEventListener('click', rev_text)  # rev_textには括弧なしです!

サンプルコード

h1要素がクリックされた時に文字列が反転するはずです。

addEventListenerの第一引数が反応するイベントの種類(文字列)、第二引数がそのイベントが発火した時に実行される処理(関数、イベントリスナー)になります。 JavaScriptの場合と同じです。 今回はクリックされた時にrev_text関数を実行し、h1要素の中身の文字列を反転させています。 rev_text関数にはEventオブジェクトが渡されますが、今回は使っていません。

ユーザー入力の取得

ユーザーからの入力を取得したい場合は、input要素またはtextarea要素を使います。 input要素に入力された文字列を、先ほどのh1要素に表示してみます。

以下のように変更してください。

    document = get_document()
    h1 = document.createElement('h1')
    h1.textContent = 'Hello, WDOM'
    input = document.createElement('input')
    def update(event):
        h1.textContent = event.target.value
    input.addEventListener('input', update)
    document.body.appendChild(input)
    document.body.appendChild(h1)

サンプルコード

文字列を入力すると "Hello, WDOM" と表示されていた部分が置き換えられるはずです。

update関数内でアクセスしているevent.targetは、イベントが発火したオブジェクトへの参照(この場合はinput要素)です。 input要素は現在の入力値をvalue属性に保持しているので、それをh1要素のtextContentに設定しています。

eventオブジェクトもDOMのEventオブジェクトと同じ構造をしているので、詳細は仕様を確認してください。 (まだ実装できていない部分も多いですが・・・特にイベントの伝播制御は全く手付かずです・・・)

イベントリスナーの削除

登録したイベントリスナーを削除する場合はremoveEventListenerを使います。

addEventListener同様、removeEventListener(イベントの種類, イベントリスナー)の形で呼び出し、イベントの種類とイベントリスナーの両方が一致した時にそのイベントリスナーが取り除かれます。

Pythonのクラスの利用

毎回createElementをするのはとてつもなく面倒ですし、documentへの参照が必要で不便極まりないので、クラスから直接要素を作れるようにしてあります。 以下の機能はBeautifulSoupを参考にしました。

例えば、先ほどのh1要素とinput要素を子要素に持つdiv要素を作る場合は以下のようにできます。

from wdom.tag import Div, H1, Input

class MyElement(Div):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.h1 = H1()  # h1要素を新しく作成
        self.h1.textContent = 'Hello, WDOM'
        self.input = Input()  # input要素を新しく作成
        self.input.addEventListener('input', self.update)
        self.appendChild(self.input)
        self.appendChild(self.h1)

    def update(self, event):
        self.h1.textContent = event.target.value

if __name__ == '__main__':
    ... # 省略

    document = get_document()
    document.body.appendChild(MyElement())
    ... # 以下同じ

サンプルコード

wdom.tagモジュールには一般的なタグを表すクラスが一通り定義してあります。 全てタグ名の一文字目が大文字で他は小文字というクラス名です。

例えば<button>タグはwdom.tag.Button<br>タグはwdom.tag.Brです。 例外はありません。 textareawdom.tag.Textareaです。

上記のMyElementクラスのように、既存のクラスを継承して独自のクラスを作ることもできます。 MyElementクラスはDivクラスを継承しているので、そのインスタンスはブラウザ上では<div>要素として表示されます。

print(MyElement().html)とすると実際のhtmlが取得できます。 この場合、以下のようになっているはずです。

<div rimo_id="数値〜"><input rimo_id="数値〜"><h1 rimo_id="数値〜">Hello, WDOM</h1></div>

rimo_idは内部で使っている属性です。 無視して下さい。 テストなどで邪魔な場合は、html_noidを使うとrimo_idを除いたhtmlが取得できます。

print(MyElement().html_noid)
# -> <div><input><h1>Hello, WDOM</h1></div>

親要素に自動的に追加

毎回appendChildを呼び出すのも面倒なので、インスタンス生成時にparent引数で親要素を指定できるようにしてあります。

先ほどの例は以下のように書き換えることができます。 (要素の追加される順番が先ほどと違ってしまいますが)

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.h1 = H1(parent=self)  # h1要素を新しく作成して自分の子要素にする
        self.h1.textContent = 'Hello, WDOM'
        self.input = Input(parent=self)  # input要素を新しく作成して自分の子要素にする
        self.input.addEventListener('input', self.update)

サンプルコード

子要素を自動的に追加

逆に、子要素をインスタンス作成時に追加することもできます。

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 子要素として'Hello, WDOM'を持つh1要素を新しく作成し、子要素に追加
        self.h1 = H1('Hello, WDOM', parent=self)
        self.input = Input(parent=self)  # input要素を新しく作成して自分の子要素にする
        self.input.addEventListener('input', self.update)

サンプルコード

H1('Hello, WDOM', parent=self)としている部分では、第一引数が新しく作られる要素の子要素に追加されます。 文字列は自動的にTextノードwdom.node.Text)に変換されます。 H1(H2(), P(), ...)として複数の要素を追加することも可能です。

属性値を設定

インスタンス化する時に属性値を設定することもできます。

input = Input(type='checkbox')
print(input.html_noid)  # <input type="checkbox">

# JavaScript同様、以下のようにして設定することも可能です
input = Input()
input.setAttribute('type', 'checkbox')
# または input.type = 'checkbox'

サンプルコード

class属性はpython予約語とかぶっているので、class_と末尾にアンダースコアをつけてください。

h1 = H1(class_='title')
print(h1.html_noid)  # <h1 class="title"></h1>

# 以下と同じです
h1 = H1()
h1.setAttribute('class', 'title')
# または h1.classList.add('title')
# classList は複数追加可能です
# h1.classList.add('title', 'heading', ...)

サンプルコード

デフォルトのクラス属性を設定

よく使うタグとクラス属性の値をまとめて定義しておくことも可能です。

例えばbootstrapのボタンはクラスにclass="btn"と指定する必要がありますが、これをデフォルトで定義されている(pythonの)クラスを作ることができます。

from wdom.tag import Button

class MyButton(Button):
    class_ = 'btn'
    ... # 省略

print(MyButton().html_noid)
# <button class="btn"></button>

サンプルコード

クラス変数のclass_に指定したクラスが自動的に設定されます。 これは以下のように定義した場合とほぼ同じです。

class MyButton(Button):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setAttribute('class', 'btn')
        ...

違いは、インスタンスから削除できないという点と、クラス変数として定義したclass属性はsubclassに継承されるという点です。

前者は以下のような操作ができないことを意味します。

btn = MyButton()
btn.classList.remove('btn')  # classListから'btn'クラスを削除しようとしても
print(btn.html_noid)  # <button class="btn"></button>  # 削除されない

後者の継承されるという点は文字通りですが、継承されたクラスでclass_と指定しても置き換えられず、追加されます。 例えばDefaultButtonというクラスを作り、class="btn btn-default"というクラス属性を持たせたい場合は、

class DefaultButton(MyButton):
    class_ = 'btn-default'

とするだけでクラス属性を追加することができます。

db = DefaultButton()
print(db.html_noid)  # <button class="btn btn-default"></button>

class定義のショートカット

クラス属性が違うだけの(Pythonの)クラスをclass文でいくつも定義するのは面倒なので、簡単に定義するためのwdom.tag.NewTagClassという関数を用意しました。

この関数を使うことで、先ほどのMyButtonDefaultButtonは次のように定義することができます。

from wdom.tag import Button, NewTagClass

MyButton = NewTagClass('MyButton', 'button', Button, class_='btn')
DefaultButton = NewTagClass('DefaultButton', 'button', MyButton, class_='btn-default')

サンプルコード

NewTagClassの第一引数は新しく作るクラスの名前、第二引数はタグ、第三引数は継承するクラス、第四引数以降の名前付き引数はクラス変数になります。 第三引数はタプルで複数のクラスを指定することも可能です。

これらの機能はDOM仕様ではなく独自仕様ですが、JavaScriptPythonの違い、利便性等を考慮して実装しました。 独自仕様なので今後変更される可能性もあります。 ご注意ください。 (クラス変数のclass_classesにしてリストでクラスを指定する形にしたい気持ちもあります)

任意のJavaScriptコードの実行

JavaScriptライブラリを併用してJavaScriptの実行が必要になる場合もあると思いますが、(現時点では)動的にscript要素を追加してもブラウザによっては実行されません。 これはブラウザの仕様にも依存しているのですが、最近のブラウザはscript要素をinnerHTMLなど書き換えても実行されないものもあるためです。 (WDOMでは要素の追加時にブラウザ上でinsertAdjacentHTMLを使っているのが原因なので、今後各ブラウザの実装状況を鑑みながら修正したいとは考えています。)

そこで、WDOMではブラウザ上でJavaScriptを実行するため、各要素(Element)にexecというメソッドを用意しています。 (メソッド名は今後変更される可能性があります。)

execメソッドは文字列を引数としてとり、与えられた文字列をJavaScriptとしてブラウザ上で実行します。 例えば、以下のコードではbutton要素がクリックされた時にアラートが表示されます。

from wdom.tag import Button
button = Button('click')
def clicked(e):
    button.exec('alert("clicked!");')
button.addEventListener('click', clicked)

この例では一行の処理ですが、複数行でも実行可能です。

execで実行されるスクリプト内ではthis(またはnodeという変数)で自身(ブラウザ上の対応するDOM)にアクセスすることができます。 これは以下のJavaScriptをブラウザ上で実行しているのと等価です。

var node = (execを呼び出した要素)
function() {
    eval(execに与えられた文字列)
}.bind(node)()

windowdocumentなどのブラウザ上のオブジェクトにアクセスすることや、事前に読み込ませたJavaScriptで定義された関数を実行することも可能です。

HTMLでの記述

構造を上記のようなappendChildなどだけで作っていくのは大変なので、HTMLで記述してパースできるようにしてあります。 JavaScriptと同様、innerHTMLでHTML文字列を設定するだけです。

例えば大きなリストを作る時は以下のようにすることができます。

from wdom.tag import Ul
ul = Ul()
ul.innerHTML = '''
<li>...</li>
<li>...</li>
<li>...</li>
<li>...</li>
'''

サンプルコード

innerHTMLは既存の子要素を全て削除して置き換えるのでご注意ください。

各子要素にはリスト風オブジェクトのul.childNodes経由でアクセス可能です。 ul.firstChildul.lastChildなどで最初・最後の子要素にもアクセスできます。 これもJavaScript(というかDOMの仕様)と同じです。 (上の例だと改行だけのTextノードも作られてしまうのですが、一応Chromeでの動作と同じです。)

また、insertAdjacentHTML(position, html)メソッドでもHTMLをパースできます。 このメソッドは既存の子要素は削除せず、positionで指定した位置に要素を挿入します。 詳細はelement.insertAdjacentHTML MDNなどをご参照ください。

なおouterHTMLは未実装です・・・

スタイルシートの適用

デフォルトの表示は寂しいので、スタイルシートを適用しましょう。 見栄えは重要です。

Web上のリソース読み込み

例としてBootstrapを使ってみます。

Bootstrapの場合はcssjavascript二つ(bootstrapとjquery)が必要なので、それぞれ<head>要素と<body>要素に追加します。

from wdom.tag import Link, Script, Button

document = get_document()
# <head>内にbootstrap.min.cssを読み込むlinkタグを追加
document.head.appendChild(Link(rel='stylesheet', href='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css'))

# <body>にjqueryとbootstrap.min.js追加
document.body.appendChild(Script(src='https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js'))
document.body.appendChild(Script(src='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js'))

# ボタン追加
document.body.appendChild(Button(class_='btn'))

サンプルコード

CSSとJSは頻繁に使われると思うので、以下のショートカットも用意してあります。 (メソッド名は今後変更される可能性があります)

document.add_cssfile('https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css')
document.add_jsfile('https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js')
document.add_jsfile('https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js')

サンプルコード

ローカルのファイル読み込み

独自に作ったcssファイルなどを読み込むことも可能です。

例えば以下のようなディレクトリ構成で、app.pyからstatic/css/app.cssを読み込む場合を考えます。

.
├── static
│   └── css
│       └── app.css
├── app.py
├── module1.py
├── ...
...

app.pyで次のように指定します。

from os import path

static_dir = path.join(path.dirname(path.abspath(__file__)), 'static')
document = get_document()
document.add_cssfile('/static/css/app.css')
app = get_app(document)
app.add_static_path('static', static_dir)

サンプルコード

app.add_static_path()の第一引数は、静的ファイルへアクセスする時のprefixになります。 指定したディレクトリ以下のファイルにhttp://localhost:8888/{prefix}/{ファイル名}でアクセスできるようになります。 上記の例ではhttp://localhost:8888/static/css/app.cssとアクセスするとapp.cssが表示されるはずです。

prefixとディレクトリ名は異なっていても大丈夫です。 例えばadd_static_path('my_static', static_dir)とすることもでき、この場合はdocument.add_cssfile('/my_static/css/app.css')とすることでapp.cssを読み込むことができます。 ブラウザでhttp://localhost:8888/my_static/css/app.cssにアクセスすると、実際のcssファイルが表示されることが確認できるはずです。

cssやjsファイルに限らず、画像やhtmlなどの静的ファイルでも何でも利用可能です。

なお、prefixはurlに使える値なら何でも構いませんが、_staticというprefixだけはライブラリ側で使っているので他の名前を使ってください。

DOMの便利な新機能

まだブラウザに実装されていない機能もいくつか実装しているので紹介します。

ParentNode/ChildNode インターフェイスの各メソッド

appendChildは単一の要素しか追加できませんが、appendというメソッドでは複数の要素をまとめて追加できます。 さらに、文字列も自動的にTextノードに変換されます。

from wdom.tag import Ul, Li
ul = Ul()
li1 = Li()
li2 = Li()
...
ul.appendChild(li1)
ul.appendChild(li2)
...

# appendを使うと
ul.append(li1, li2, ...)
# と一度で終わる

サンプルコード

同様に、先頭にまとめて追加するprependや、前後に追加するafterbeforeも利用可能です。

内部的には、appendChildなどは毎回通信を行ってブラウザ上の表示を更新しているのに対し、appendなどでは一度に表示を更新しているので、パフォーマンス的にも有利です。

Custom Element

独自タグも限定的・実験的ですがサポートしています。 ブラウザ上では特に何もせず、innerHTMLなどでhtmlをパースした時に作られるPythonのクラスを指定できるだけですが。。。

WebComponentsの仕様自体が流動的なので、今後変更される可能性はあります。

独自タグの定義

先ほど作ったMyElementクラスはdivタグとして表示されていましたが、独自の<my-element>タグとして定義してみます。

from wdom.tag import Div

class MyElement(Div):
    # 独自タグを'my-element'と指定
    tag = 'my-element'
    def __init__(self, *args, **kwargs):
        ... # 省略

サンプルコード

違いはクラス変数としてtag = 'my-element'と設定していることだけです。 先ほどと同様にDivクラスを継承していますが、特に意味はありません。 Spanなどでも大丈夫です。

これをCustom Tagとして登録します。

document.defaultView.customElements.define('my-element', MyElement)

以前のCustom Elementの仕様ではdocuemnt.registerElementというメソッドが使われていましたが、最新の仕様ではwindow.customElements.defineというメソッドを使うようになっていたので、wdomもそちらに合わせました。 document.defaultViewはブラウザ上でのwindowオブジェクトに相当します。 (現状のWDOMではほとんど空のオブジェクトになっていますが・・・)

これでmy-elementという独自タグが登録できたので、以下のように使うことができます。

# body要素の末尾に <my-element></my-element> を挿入
document.body.insertAdjacentHTML('beforeend', '<my-element></my-element>')
# または、createElementで新規作成
my_element = document.createElement('my-element')

既存タグの拡張

is属性を使った既存タグの拡張にも対応しています。 前述したbootstrapのbutton要素のMyButtonDefaultButtonを定義してみます。

from wdom.tag import Button, Div

class MyButton(Button):
    # tag = 'button'
    class_ = 'btn'
    is_ = 'my-button'  # tag ではなく is_ に名前を指定

class DefaultButton(MyButton):
    class_ = 'btn-default'
    is_ = 'default-button'

document.defaultView.customElements.define('my-button', MyButton, {'extends': 'button'})
document.defaultView.customElements.define('default-button', DefaultButton, {'extends': 'button'})

div = Div(parent=document.body)
div.innerHTML = '<button is="my-button"></button><button is="default-button"></button>'
print(isinstance(div.firstChild, MyButton))  # True
print(isinstance(div.lastChild, DefaultButton))  # True

サンプルコード

(Pythonの)クラス定義時にクラス変数のis_(最後にアンダースコア)で名前を指定します。 tagは拡張したいタグ(今回は継承元のButtonクラスで定義されているので指定不要)です。

定義したクラスを登録する時に、defineの第一引数に名前(is_の値)を指定し、第三引数に辞書で{'extends': 'button'}と拡張したい元のタグ名を指定します。

このように登録することで、<button is="my-button">などのhtmlからMyButtonクラスのインスタンスが作られるようになります。

(タグとisの指定がわかりにくく、いかにも混乱しそうですが、今の所こういう仕様なのでそれに合わせています)

Custom Elementを使う上での注意

できるだけ早い段階で独自タグを定義するようにしてください。 定義前にインスタンスを作ってしまうと、異なるクラスのインスタンスが作られてしまいます。 一応customElements.defineで登録された時に無理やりクラスは置き換えていますが、__init__は呼ばれません。 特に、isを使った既存タグの拡張は、インスタンスを作った後にsetAttribute('is', '...')などとしても(現時点では)クラスは変更されないので注意してください。

今後ライフサイクルコールバックメソッドに相当する機能は作りたいと考えていますが、事前に登録を済ませておいたほうが安全なのは変わらないと思います。

おわりに

長くなってしまいましたが、お読みいただきありがとうございました。

説明が必要な独自機能を中心に書いたので、あまりDOMで規定されている機能については触れませんでしたが、基本的な機能は実装されています。 DOM関係の実装状況はこちらをご参照ください。 他にも開発に便利な機能が少しあったりするのですが、それは別記事で紹介したいと思います。

当面はCustom Elementの実装と正式なドキュメントの整備をすすめていきたいと考えています。 あと、個別のHTML要素のクラスもHTML〇〇Elementの形で(主要なものは)実装したいですね。 イベント関係も、ドラッグ&ドロップとかはまだ実装できていないので実装しないと・・・

もちろんバグが見つかればできるだけ早く修正します。 もう少し落ち着いたらPyPIに登録します。