~certify-web-dev/twisted/certify-staging

<div class="toc"><ol><li><a href="#auto0">Checkout</a></li><li><a href="#auto1">Alternate tree names</a></li><li><a href="#auto2">Combinator</a></li><li><a href="#auto3">Compiling C extensions</a></li><li><a href="#auto4">Running tests</a></li><li><a href="#auto5">Building docs</a></li><li><a href="#auto6">Emacs</a></li><li><a href="#auto7">Building Debian packages</a></li></ol></div>

<span/>

<p>If you're going to be doing development on Twisted itself, or if you want

to take advantage of bleeding-edge features (or bug fixes) that are not yet

available in a numbered release, you'll probably want to check out a tree from

the Twisted Subversion repository. The Trunk is where all current development

takes place.</p>

<p>This document lists some useful tips for working on this cutting

edge.</p>

<h2>Checkout<a name="auto0"/></h2>

<p>Subversion tutorials can be found elsewhere, see in particular <a href="http://subversion.tigris.org/" shape="rect">the Subversion homepage</a>. The relevant

data you need to check out a copy of the Twisted tree is available on the <a href="http://twistedmatrix.com/trac/wiki/TwistedDevelopment" shape="rect">development page

</a>, and is as follows:</p>

$ svn co svn://svn.twistedmatrix.com/svn/Twisted/trunk Twisted

</pre>

<h2>Alternate tree names<a name="auto1"/></h2>

<p>By using <code>svn co svn://svn.twistedmatrix.com/svn/Twisted/trunk

otherdir</code>, you can put the workspace tree in a directory other than

<q>Twisted</q>. I do this (with a name like <q>Twisted-Subversion</q>) to

remind myself that this tree comes from Subversion and not from a released

version (like <q>Twisted-1.0.5</q>). This practice can cause a few problems,

because there are a few places in the Twisted tree that need to know where

the tree starts, so they can add it to <code>sys.path</code> without

requiring the user manually set their PYTHONPATH. These functions walk the

current directory up to the root, looking for a directory named

<q>Twisted</q> (sometimes exactly that, sometimes with a

<code>.startswith</code> test). Generally these are test scripts or other

administrative tools which expect to be launched from somewhere inside the

tree (but not necessarily from the top).</p>

<p>If you rename the tree to something other than <code>Twisted</code>, these

tools may wind up trying to use Twisted source files from /usr/lib/python2.5

or elsewhere on the default <code>sys.path</code>. Normally this won't

matter, but it is good to be aware of the issue in case you run into

problems.</p>

<p><code>twisted/test/process_twisted.py</code> is one of these programs.</p>

<h2>Combinator<a name="auto2"/></h2>

<p>In order to simplify the use of Subversion, we typically use

<a href="http://divmod.org/trac/wiki/DivmodCombinator" shape="rect">Divmod Combinator</a>.

You may find it to be useful, too. In particular, because Twisted uses

branches for almost all feature development, if you plan to contribute to

Twisted you will probably find Combinator very useful. For more details,

see the Combinator website, as well as the

UQDS</a> page.</p>

<h2>Compiling C extensions<a name="auto3"/></h2>

<p>

There are currently several C extension modules in Twisted:

twisted.protocols._c_urlarg, twisted.internet.cfsupport,

twisted.internet.iocpreactor._iocp, and twisted.python._epoll. These modules

are optional, but you'll have to compile them if you want to experience their

features, performance improvements, or bugs. There are two approaches.

</p>

<p>The first is to do a regular distutils <code>./setup.py build</code>, which

will create a directory under <code>build/</code> to hold both the generated

<code>.so</code> files as well as a copy of the 600-odd <code>.py</code> files

that make up Twisted. If you do this, you will need to set your PYTHONPATH to

something like <code>MyDir/Twisted/build/lib.linux-i686-2.5</code> in order to

run code against the Subversion twisted (as opposed to whatever's installed in

<code>/usr/lib/python2.5</code> or wherever python usually looks). In

addition, you will need to re-run the <code>build</code> command <em>every

time</em> you change a <code>.py</code> file. The <code>build/lib.foo</code>

directory is a copy of the main tree, and that copy is only updated when you

re-run <code>setup.py build</code>. It is easy to forget this and then wonder

why your code changes aren't being expressed.</p>

<p>The second technique is to build the C modules in place, and point your

PYTHONPATH at the top of the tree, like <code>MyDir/Twisted</code>. This way

you're using the .py files in place too, removing the confusion a forgotten

rebuild could cause with the separate build/ directory above. To build the C

modules in place, do <code>./setup.py build_ext -i</code>. You only need to

re-run this command when you change the C files. Note that

100

<code>setup.py</code> is not Make, it does not always get the dependencies

101

right (<code>.h</code> files in particular), so if you are hacking on the

102

cReactor you may need to manually delete the <code>.o</code> files before

103

doing a rebuild. Also note that doing a <code>setup.py clean</code> will

104

remove the <code>.o</code> files but not the final <code>.so</code> files,

105

they must be deleted by hand.</p>

106

107

108

<h2>Running tests<a name="auto4"/></h2>

109

110

<p>To run the full unit-test suite, do:</p>

111

112

<pre class="shell" xml:space="preserve">./bin/trial twisted</pre>

113

114

<p>To run a single test file (like <code>twisted/test/test_defer.py</code>),

115

do one of:</p>

116

117

<pre class="shell" xml:space="preserve">./bin/trial twisted.test.test_defer</pre>

118

119

120

121

<pre class="shell" xml:space="preserve">./bin/trial twisted/test/test_defer.py</pre>

122

123

<p>To run any tests that are related to a code file, like

124

<code>twisted/protocols/imap4.py</code>, do:</p>

125

126

<pre class="shell" xml:space="preserve">./bin/trial --testmodule twisted/mail/imap4.py</pre>

127

128

<p>This depends upon the <code>.py</code> file having an appropriate

129

<q>test-case-name</q> tag that indicates which test cases provide coverage.

130

See the <a href="test-standard.html" shape="rect">Test Standards</a> document for

131

details about using <q>test-case-name</q>. In this example, the

132

<code>twisted.mail.test.test_imap</code> test will be run.</p>

133

134

<p>Many tests create temporary files in /tmp or ./_trial_temp, but

135

everything in /tmp should be deleted when the test finishes. Sometimes these

136

cleanup calls are commented out by mistake, so if you see a stray

137

/tmp/@12345.1 directory, it is probably from test_dirdbm or test_popsicle.

138

Look for an <code>rmtree</code> that has been commented out and complain to

139

the last developer who touched that file.</p>

140

141

<h2>Building docs<a name="auto5"/></h2>

142

143

<p>Twisted documentation (not including the automatically-generated API docs)

144

is in <a href="http://twistedmatrix.com/trac/wiki/TwistedLore" shape="rect">Lore Format</a>.

145

These <code>.xhtml</code> files are translated into <code>.html</code> files by

146

the <q>bin/lore/lore</q> script, which can check the files for syntax problems

147

(hlint), process multiple files at once, insert the files into a template

148

before processing, and can also translate the files into LaTeX or PostScript

149

instead.</p>

150

151

<p>To build the HTML form of the howto/ docs, do the following. Note that

152

the index file will be placed in <code>doc/howto/index.html</code>.</p>

153

154

155

./bin/lore/lore -p --config template=doc/howto/template.tpl doc/howto/*.xhtml

156

</pre>

157

158

<p>To run hlint over a single Lore document, such as

159

<code>doc/development/policy/svn-dev.xhtml</code>, do the following. This is

160

useful because the HTML conversion may bail without a useful explanation if

161

it sees mismatched tags.</p>

162

163

164

./bin/lore/lore -n --output lint doc/development/policy/svn-dev.xhtml

165

</pre>

166

167

<p>To convert it to HTML (including markup, interpolation of examples,

168

footnote processing, etc), do the following. The results will be placed in

169

<code>doc/development/policy/svn-dev.html</code>:</p>

170

171

172

./bin/lore/lore -p --config template=doc/howto/template.tpl \

173

doc/development/policy/svn-dev.xhtml

174

</pre>

175

176

<p>Note that hyperlinks to other documents may not be quite right unless you

177

include a <q>-l</q> argument to <code>bin/lore/lore</code>. Links in the

178

.xhtml file are to .xhtml targets: when the .xhtml is turned into .html, the

179

link targets are supposed to be turned into .html also. In addition to this,

180

Lore markup of the form <code class="API"> is supposed to

181

turn into a link to the corresponding API reference page. These links will

182

probably be wrong unless the correct base URL is provided to Lore.</p>

183

184

<h2>Emacs<a name="auto6"/></h2>

185

186

<p>A minor mode for development with Twisted using Emacs is available. See

187

<code>emacs/twisted-dev.el</code> for several utility functions which make

188

it easier to grep for methods, run test cases, etc.</p>

189

190

<h2>Building Debian packages<a name="auto7"/></h2>

191

192

<p>Our support for building Debian packages has fallen into disrepair. We

193

would very much like to restore this functionality, but until we do so, if

194

you are interested in this, you are on your own. See

195

<a href="http://stdeb.python-hosting.com/" shape="rect">stdeb</a> for one possible approach

196

to this.</p>

197

198

</div>

199

200

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

201

<span class="version">Version: 9.0.0</span>

202

</body>

203

</html>

b'\\ No newline at end of file'

Older »