本文翻譯自UserManual
僅作交流和分享之用,未經許可,禁止轉載!
模塊介紹
Pyh 是一個強大且簡約的python模塊,你可以使用它在python程序中生成HTML內容。在python代碼中手寫HTML代碼非常乏味并且使代碼可讀性變得非常糟糕。而且,當你嘗試要去看一下HTML源碼的時候,可讀性同樣很差。PyH為這一切提供了非常不錯的解決方案。它讓你像編寫GUI一樣,編寫你的網頁!
功能特性
- 自動格式化HTML標簽
- 高度可定制
- 完全識別CSS和Javascript
- 自動閉合標簽
- 面向對象的HTML編寫方式
如何安裝PyH
從這個下載頁面下載(譯注:原鏈接需要代理,可以在本人托管的GitHub地址下載)或者直接下載 PyH-0.1.tar.gz(譯注:同樣需要代理)解壓到你的工作目錄或是python目錄,通常是 /usr/lib/pythonX.X/site-packages
或者是其他任意能夠被 $PYTHONPATH
識別的路徑:
$ wget http://pyh.googlecode.com/files/PyH-0.1.tar.gz
$ tar xvzf PyH-0.1.tar.gz
$ cd PyH-0.1
$ sudo python setup.py install
如果你沒有root權限,可以把 PyH-0.1/pyh.py
文件拷貝到你的項目目錄下。如果你正在使用一個基于RPM的發行版系統,你可以使用rpm二進制包,并通過如下命令來安裝:
$ wget http://pyh.googlecode.com/files/PyH-0.1-1.noarch.rpm
$ sudo rpm -ivh PyH-0.1-1.noarch.rpm
快速例程
下面這段python代碼:
from pyh import *
page = PyH('My wonderful PyH page')
page.addCSS('myStylesheet1.css', 'myStylesheet2.css')
page.addJS('myJavascript1.js', 'myJavascript2.js')
page << h1('My big title', cl='center')
page << div(cl='myCSSclass1 myCSSclass2', id='myDiv1') << p('I love PyH!', id='myP1')
mydiv2 = page << div(id='myDiv2')
mydiv2 << h2('A smaller title') + p('Followed by a paragraph.')
page << div(id='myDiv3')
page.myDiv3.attributes['cl'] = 'myCSSclass3'
page.myDiv3 << p('Another paragraph')
page.printOut()
會生成這段html代碼:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>My wonderful PyH page</title>
<link href="myStylesheet1.css" type="text/css" rel="stylesheet" />
<link href="myStylesheet2.css" type="text/css" rel="stylesheet" />
<script src="myJavascript1.js" type="text/javascript"></script>
<script src="myJavascript2.js" type="text/javascript"></script>
</head>
<body>
<h1 class="center">My big title</h1>
<div id="myDiv1" class="myCSSclass1 myCSSclass2">
<p id="myP1">I love PyH!</p>
</div>
<div id="myDiv2">
<h2>A smaller title</h2>
<p>Followed by a paragraph.</p>
</div>
<div id="myDiv3" class="myCSSclass3">
<p>Another paragraph</p>
</div>
</body>
</html>
基礎手冊
pyh.py可以通過如下方式導入:
>>> from pyh import *
Tag
對象
HTML 標簽可以通過調用同名函數來生成。HTML 標簽
<tag>
可以通過 tag()
生成:
>>> mydiv = div()
>>> mydiv.render()
'<div></div>'
標簽的屬性,通過函數的關鍵字參數傳入,關鍵字和標簽的屬性是同名的,除了class
這個屬性被替換成了 cl
. 標簽的內容或是子標簽可以通過非關鍵字參數傳入:
>>> mydiv = div('My content', cl='myCSSclass1 myCSSclass2', id='myCSSid1')
>>> mydiv.render()
'<div class="myCSSclass1 myCSSclass2" id="myCSSid1">
My content
</div>'
其他的標簽同樣可以作為內容傳入:
>>> mydiv = div(p('My paragraph.'), cl='myCSSclass1 myCSSclass2', id='myCSSid1')
>>> mydiv.render()
'<div class="myCSSclass1 myCSSclass2" id="myCSSid1">
<p>My paragraph</p>
</div>'
當一個標簽對象被創建后,HTML屬性可以通過它的屬性
成員來修改,它是一個字典:
>>> mydiv = div()
>>> mydiv.attributes['id'] = 'myCSSid'
>>> mydiv.render()
'<div id="myCSSid"></div>\n'
標簽可以通過+
號進行連接:
>>> twoDivs = div() + div()
>>> twoDivs.render()
'<div></div>
<div></div>'
標簽可以被包含進更高一層的標簽中,可以把它作為非關鍵字參數傳入(就像上面介紹的那樣),也可以通過<<
操作符來完成。這個操作符會返回最后被包含的標簽:
>>> myDiv = div(id='myTopLevelDiv')
>>> myPar = myDiv << div(id='myInnerDiv') << p(id='myPar') #注意此處返回的是p標簽
>>> myPar << span('My first span') + span('My second span')
>>> myDiv.render()
'<div id="myTopLevelDiv">
<div id="myInnerDiv">
<p id="myPar">
<span>My first span</span><span>My second span</span>
</p>
</div>
</div>'
當一個標簽被包含進另一個標簽之后,可以把它作為上級標簽的成員來進行訪問,它的名字就是其id
屬性的值,如果沒有指定該值,則tag_001
就是該類第一個標簽的名字,以此類推:
>>> myDiv = div()
>>> myDiv << span(id='myspan')
>>> myDiv.myspan << 'content1'
>>> myDiv << span()
>>> myDiv.span << 'content2'
>>> myDiv << span()
>>> myDiv.span_001 << 'content3'
>>> myDiv.render()
'<div>
<span id="myspan">content1</span>
<span>content2</span>
<span>content3</span>
</div>'
創建網頁
最高層的對象,是PyH
對象。它創建一個包含CSS和javascript元素的HTML頁面。創建一個網頁的第一件事是實例化一個PyH
對象:
from pyh import *
page = PyH('My wonderful PyH page')
隨后你可以添加你的CSS表盒javascript文件,例如:
page.addCSS('myStylesheet1.css', 'myStylesheet2.css')
page.addJS('myJavascript1.js', 'myJavascript2.js')
注意,它們可以在任意時刻通過python腳本添加(例如,根據你的內容,僅添加被用到的腳本和樣式表)。你現在可以開始創建你的頁面了:
page << h1('My big title!', cl='myCSSclass')
page << div(id='mySubtitleDiv') << h2('My sub-title')
maindiv = page << div(id='myMainDiv')
maindiv << h3('A smaller title') + p('followed by a small paragraph')
maindiv << p('Main paragraph ', style='color:red;') << a('a link', href='http://alink')
maindiv << span('hehe', onclick='myJavaScriptFcn(); return false;')
maindiv << br()
maindiv << img(src='mypicture.jpg')
page << div(id='myFooter') << span('My footer')
之后,你可以把HTML頁面輸出到文件,或是輸出到瀏覽器,如果你的腳本是在服務器上運行的話。
page.printOut()
輸出的結果是:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>My wonderful PyH page</title>
<link href="myStylesheet1.css" type="text/css" rel="stylesheet" />
<link href="myStylesheet2.css" type="text/css" rel="stylesheet" />
<script src="myJavascript1.js" type="text/javascript"></script>
<script src="myJavascript2.js" type="text/javascript"></script>
</head>
<body>
<h1 class="myCSSclass">My big title!</h1>
<div id="mySubtitleDiv"><h2>My sub-title</h2></div>
<div id="myMainDiv">
<h3>A smaller title</h3>
<p>followed by a small paragraph</p>
<p style="color:red;">Main paragraph <a href="http://alink">a link</a>
<span onclick="myJavaScriptFcn(); return false;">hehe</span><br />
<img src="mypicture.jpg" />
</div>
<div id="myFooter"><span>My footer</span>
</div>
</body>
</html>
創建表格
你可以充分利用python和pyh的能力來高校的生成HTML表格,創建一個4乘4的表格非常輕松:
page = PyH('My wonderful PyH page')
page << h2('Most compact way to build a 4 by 4 table')
page << table() << tr(td('1') + td('2')) + tr(td('3') + td('4'))
page << h2('Another way to build a 4 by 4 table')
mytab = page << table()
tr1 = mytab << tr()
tr1 << td('1') + td('2')
tr2 = mytab << tr()
tr2 << td('3') + td('4')
page.printOut()
上面的代碼會生成如下HTML代碼(為了簡潔,表頭被去掉了)
<h2>Most compact way to build a 4 by 4 table</h2>
<table>
<tr>
<td>1</td><td>2</td>
</tr><tr>
<td>3</td><td>4</td>
</tr>
</table>
<h2>Another way to build a 4 by 4 table</h2>
<table>
<tr>
<td>1</td><td>2</td>
</tr><tr>
<td>3</td><td>4</td>
</tr>
</table>
現在,如果你想要自動的創建一個大型表格,比如從數據庫中創建,你可以這樣做:
mytab = page << table()
for i in range(nrows):
mytr = mytab << tr()
for j in range(ncols):
mytr << td('Row %i, column %j' % (i, j))
這樣可以生成一個i乘j的表格。