~justin-fathomdb/nova/justinsb-openstack-api-volumes

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">

<head>

<title>Twisted Documentation: Setting up the TwistedQuotes application</title>

</head>

<h1 class="title">Setting up the TwistedQuotes application</h1>

<div class="toc"><ol><li><a href="#auto0">Goal</a></li><li><a href="#auto1">Setting up the TwistedQuotes project directory</a></li></ol></div>

This document describes how to set up the TwistedQuotes application used in

a number of other documents, such as <a href="design.html" shape="rect">designing Twisted applications</a>.

<h2>Setting up the TwistedQuotes project directory<a name="auto1"/></h2>

In order to run the Twisted Quotes example, you will need to do the

following:

<ol>

<li>Make a <code>TwistedQuotes</code> directory on your system</li>

<li>Place the following files in the <code>TwistedQuotes</code> directory:

<ul>

<li><div class="py-listing"><pre>1

"""

Twisted Quotes

"""

</pre><div class="caption">Source listing - <a href="listings/TwistedQuotes/__init__.py">listings/TwistedQuotes/__init__.py</a></div></div> (this

file marks it as a package, see <a href="http://docs.python.org/tutorial/modules.html#packages" shape="rect">this section</a> of the Python tutorial for more on packages);</li>

<li><div class="py-listing"><pre> 1

from random import choice

from zope.interface import implements

from TwistedQuotes import quoteproto

class StaticQuoter:

"""

Return a static quote.

"""

implements(quoteproto.IQuoter)

def __init__(self, quote):

self.quote = quote

def getQuote(self):

return self.quote

class FortuneQuoter:

100

"""

101

Load quotes from a fortune-format file.

102

"""

103

implements(quoteproto.IQuoter)

104

105

def __init__(self, filenames):

106

self.filenames = filenames

107

108

109

def getQuote(self):

110

quoteFile = file(choice(self.filenames))

111

quotes = quoteFile.read().split('\n%\n')

112

quoteFile.close()

113

return choice(quotes)

114

</pre><div class="caption">Source listing - <a href="listings/TwistedQuotes/quoters.py">listings/TwistedQuotes/quoters.py</a></div></div>;</li>

115

<li><div class="py-listing"><pre> 1

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

from zope.interface import Interface

152

153

from twisted.internet.protocol import Factory, Protocol

154

155

156

157

class IQuoter(Interface):

158

"""

159

An object that returns quotes.

160

"""

161

def getQuote():

162

"""

163

Return a quote.

164

"""

165

166

167

168

class QOTD(Protocol):

169

def connectionMade(self):

170

self.transport.write(self.factory.quoter.getQuote()+'\r\n')

171

self.transport.loseConnection()

172

173

174

175

class QOTDFactory(Factory):

176

"""

177

A factory for the Quote of the Day protocol.

178

179

@type quoter: L{IQuoter} provider

180

@ivar quoter: An object which provides L{IQuoter} which will be used by

181

the L{QOTD} protocol to get quotes to emit.

182

"""

183

protocol = QOTD

184

185

def __init__(self, quoter):

186

self.quoter = quoter

187

</pre><div class="caption">Source listing - <a href="listings/TwistedQuotes/quoteproto.py">listings/TwistedQuotes/quoteproto.py</a></div></div>;</li>

188

</ul>

189

</li>

190

<li>Add the <code>TwistedQuotes</code> directory's parent to your Python

191

path. For example, if the TwistedQuotes directory's path is

192

<code>/tmp/TwistedQuotes</code>

193

add <code>/tmp</code> to your Python path. On UNIX this would be <code class="shell">export PYTHONPATH=/my/stuff:$PYTHONPATH</code>, on Microsoft

194

Windows change the <code class="shell">PYTHONPATH</code> variable through the

195

Systems Properites dialog to add <code class="shell">/my/stuff;</code> at the

196

beginning.</li>

197

<li>

198

Test your package by trying to import it in the Python interpreter:

199

200

Python 2.1.3 (#1, Apr 20 2002, 22:45:31)

201

[GCC 2.95.4 20011002 (Debian prerelease)] on linux2

202

Type "copyright", "credits" or "license" for more information.

203

>>> import TwistedQuotes

204

>>> # No traceback means you're fine.

205

</pre>

206

</li>

207

</ol>

208

209

</div>

210

211

<a href="index.html">Index</a>

212

Version: 10.0.0

213

</body>

214

</html>

b'\\ No newline at end of file'

Older »