PYH 用户手册中文翻译

前言

这篇文档翻译自 https://code.google.com/p/pyh/wiki/UserManual

翻译日期：2013/9/14

简介

PyH是一个非常强大和严谨的Python模块，可以让你用Python程序生成HTML文档。在Python程序中写纯HTML代码是非常无趣的，会让你的代码可读性大大降低。而且，只要你读过HTML的源代码，你就不会想读第二遍。PyH很好的解决了这个问题。PyH让你像开发GUI程序一样开发网页。

功能

自动格式化HTML标签
高自定义度
完全支持CSS和Javascript
自动结束标签
面向对象的HTML编程

安装PyH

下载最新版本的PyH(下载地址)，安装：

$ wget http://pyh.googlecode.com/files/PyH-0.1.1.tar.gz
$ tar xvzf PyH-0.1.tar.gz
$ cd PyH-0.1
$ sudo python setup.py install

如果没有root权限，那么在你的程序目录里面导入pyh.py就行了。RPM系列的Linux还可以这样：

$ wget http://pyh.googlecode.com/files/PyH-0.1-1.noarch.rpm
$ sudo rpm -ivh PyH-0.1-1.noarch.rpm

快速示例

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 *

标签对象

HTML标签可以调用同名函数生成。HTML标签 <tag> 是通过class tag()调用的：

>>> mydiv = div()
>>> mydiv.render()
'<div></div>'

标签属性是通过函数参数调用的。参数名称和属性相同除了属性类用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>'

一旦一个标签被创建了，他的属性可以通过访问字典修改：

>>> 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')
>>> 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对象是最高等级的。它可以生成一个带有Javascript和CSS的网页。首先要做的是实例化PyH对象：

from pyh import *
page = PyH('My wonderful PyH page')

然后你可以通过如下方式导入js和css文件：

page.addCSS('myStylesheet1.css', 'myStylesheet2.css')
page.addJS('myJavascript1.js', 'myJavascript2.js')

你可以通过如下方式生成页面：

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')

然后输出成文件：

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>

创建表格

你可以结合Pyh和Python的高效能力用来生成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()

上述代码会生成(简化了header)：

<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))