本文翻譯自UserManual
僅作交流和分享之用空另,未經(jīng)許可黄鳍,禁止轉(zhuǎn)載!
模塊介紹
Pyh 是一個(gè)強(qiáng)大且簡(jiǎn)約的python模塊,你可以使用它在python程序中生成HTML內(nèi)容手蝎。在python代碼中手寫HTML代碼非常乏味并且使代碼可讀性變得非常糟糕活喊。而且搜囱,當(dāng)你嘗試要去看一下HTML源碼的時(shí)候以舒,可讀性同樣很差。PyH為這一切提供了非常不錯(cuò)的解決方案擎颖。它讓你像編寫GUI一樣榛斯,編寫你的網(wǎng)頁!
功能特性
- 自動(dòng)格式化HTML標(biāo)簽
- 高度可定制
- 完全識(shí)別CSS和Javascript
- 自動(dòng)閉合標(biāo)簽
- 面向?qū)ο蟮腍TML編寫方式
如何安裝PyH
從這個(gè)下載頁面下載(譯注:原鏈接需要代理搂捧,可以在本人托管的GitHub地址下載)或者直接下載 PyH-0.1.tar.gz(譯注:同樣需要代理)解壓到你的工作目錄或是python目錄驮俗,通常是 /usr/lib/pythonX.X/site-packages
或者是其他任意能夠被 $PYTHONPATH
識(shí)別的路徑:
$ 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權(quán)限,可以把 PyH-0.1/pyh.py
文件拷貝到你的項(xiàng)目目錄下允跑。如果你正在使用一個(gè)基于RPM的發(fā)行版系統(tǒng)王凑,你可以使用rpm二進(jìn)制包搪柑,并通過如下命令來安裝:
$ 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()
會(huì)生成這段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>
基礎(chǔ)手冊(cè)
pyh.py可以通過如下方式導(dǎo)入:
>>> from pyh import *
Tag
對(duì)象
HTML 標(biāo)簽可以通過調(diào)用同名函數(shù)來生成。HTML 標(biāo)簽
<tag>
可以通過 tag()
生成:
>>> mydiv = div()
>>> mydiv.render()
'<div></div>'
標(biāo)簽的屬性索烹,通過函數(shù)的關(guān)鍵字參數(shù)傳入工碾,關(guān)鍵字和標(biāo)簽的屬性是同名的,除了class
這個(gè)屬性被替換成了 cl
. 標(biāo)簽的內(nèi)容或是子標(biāo)簽可以通過非關(guān)鍵字參數(shù)傳入:
>>> mydiv = div('My content', cl='myCSSclass1 myCSSclass2', id='myCSSid1')
>>> mydiv.render()
'<div class="myCSSclass1 myCSSclass2" id="myCSSid1">
My content
</div>'
其他的標(biāo)簽同樣可以作為內(nèi)容傳入:
>>> mydiv = div(p('My paragraph.'), cl='myCSSclass1 myCSSclass2', id='myCSSid1')
>>> mydiv.render()
'<div class="myCSSclass1 myCSSclass2" id="myCSSid1">
<p>My paragraph</p>
</div>'
當(dāng)一個(gè)標(biāo)簽對(duì)象被創(chuàng)建后百姓,HTML屬性可以通過它的屬性
成員來修改渊额,它是一個(gè)字典:
>>> mydiv = div()
>>> mydiv.attributes['id'] = 'myCSSid'
>>> mydiv.render()
'<div id="myCSSid"></div>\n'
標(biāo)簽可以通過+
號(hào)進(jìn)行連接:
>>> twoDivs = div() + div()
>>> twoDivs.render()
'<div></div>
<div></div>'
標(biāo)簽可以被包含進(jìn)更高一層的標(biāo)簽中,可以把它作為非關(guān)鍵字參數(shù)傳入(就像上面介紹的那樣)垒拢,也可以通過<<
操作符來完成旬迹。這個(gè)操作符會(huì)返回最后被包含的標(biāo)簽:
>>> myDiv = div(id='myTopLevelDiv')
>>> myPar = myDiv << div(id='myInnerDiv') << p(id='myPar') #注意此處返回的是p標(biāo)簽
>>> 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>'
當(dāng)一個(gè)標(biāo)簽被包含進(jìn)另一個(gè)標(biāo)簽之后,可以把它作為上級(jí)標(biāo)簽的成員來進(jìn)行訪問求类,它的名字就是其id
屬性的值奔垦,如果沒有指定該值,則tag_001
就是該類第一個(gè)標(biāo)簽的名字仑嗅,以此類推:
>>> 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>'
創(chuàng)建網(wǎng)頁
最高層的對(duì)象宴倍,是PyH
對(duì)象张症。它創(chuàng)建一個(gè)包含CSS和javascript元素的HTML頁面仓技。創(chuàng)建一個(gè)網(wǎng)頁的第一件事是實(shí)例化一個(gè)PyH
對(duì)象:
from pyh import *
page = PyH('My wonderful PyH page')
隨后你可以添加你的CSS表盒javascript文件,例如:
page.addCSS('myStylesheet1.css', 'myStylesheet2.css')
page.addJS('myJavascript1.js', 'myJavascript2.js')
注意俗他,它們可以在任意時(shí)刻通過python腳本添加(例如脖捻,根據(jù)你的內(nèi)容,僅添加被用到的腳本和樣式表)兆衅。你現(xiàn)在可以開始創(chuàng)建你的頁面了:
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頁面輸出到文件,或是輸出到瀏覽器羡亩,如果你的腳本是在服務(wù)器上運(yùn)行的話摩疑。
page.printOut()
輸出的結(jié)果是:
<!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>
創(chuàng)建表格
你可以充分利用python和pyh的能力來高校的生成HTML表格,創(chuàng)建一個(gè)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()
上面的代碼會(huì)生成如下HTML代碼(為了簡(jiǎn)潔畏铆,表頭被去掉了)
<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>
現(xiàn)在雷袋,如果你想要自動(dòng)的創(chuàng)建一個(gè)大型表格,比如從數(shù)據(jù)庫中創(chuàng)建辞居,你可以這樣做:
mytab = page << table()
for i in range(nrows):
mytr = mytab << tr()
for j in range(ncols):
mytr << td('Row %i, column %j' % (i, j))
這樣可以生成一個(gè)i乘j的表格楷怒。