~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: The Twisted Split FAQ</title>

</head>

<h1 class="title">The Twisted Split FAQ</h1>

<div class="toc"><ol><li><a href="#auto0">What is the Twisted Split?</a></li><li><a href="#auto1">Why was Twisted being split?</a></li><li><a href="#auto2">But I liked the monolithic packages. Can I still get them?</a></li><li><a href="#auto3">Where can I find information about the individual projects?</a></li><li><a href="#auto4">What are the new packages?</a></li><li><a href="#auto5">Will I have to rewrite my code? What API changes are there?</a></li><li><a href="#auto6">What about my deployments? What will I have to do to have the new packages?</a></li><li><a href="#auto7">Why are all the packages still named twisted.subproject?</a></li><li><a href="#auto8">What does this mean for existing Twisted developers?</a></li></ol></div>

<span/>

<h2>What is the Twisted Split?<a name="auto0"/></h2>

<p>

<a href="http://twistedmatrix.com/" shape="rect">Twisted</a> is very large. At last

count, it has around 80 thousand lines of code (yes, that <em>is</em> very

large for a Python project, maybe not so for a C++ project. ;). We broke it

into several smaller packages with the 2.0 release.

</p>

<h2>Why was Twisted being split?<a name="auto1"/></h2>

<p>

The biggest reason was to make our release process more

agile. A regression in twisted.names, for example, could hold up the release

of the entire thing, when really it should only be holding up the release of

twisted.names.

</p>

<p>

The other big reason is visibility. Twisted has a ton of

functionality, but many people miss out on it because they don't know

where it is hidden inside Twisted. The Twisted split gave every

sub-project its own web site and thus more visibility.

</p>

<h2>But I liked the monolithic packages. Can I still get them?<a name="auto2"/></h2>

<p>

Yes. Tarball and Windows releases for Twisted and all of its

sub-projects will still be maintained. We encourage maintainers of

packages for OSes with automatic packaging systems to break up the

packages as well, so, for example, Debian will have

python2.3-twisted-core, python2.3-twisted-conch,

python2.3-twisted-names, and so on.

</p>

<h2>Where can I find information about the individual projects?<a name="auto3"/></h2>

<p>

A list of <a href="http://twistedmatrix.com/trac/wiki/TwistedProjects" shape="rect">Twisted

projects</a> is available on the website. The list includes maintainer

information and links to project-specific pages with more detailed

information.

</p>

<h2>What are the new packages?<a name="auto4"/></h2>

<p>

<ul>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedCore" shape="rect">Twisted

Core</a> - This contains twisted.application, twisted.cred,

twisted.enterprise, twisted.internet, twisted.manhole,

twisted.persisted, twisted.protocols<sup><a href="#protocols" shape="rect">[1]</a></sup>, twisted.python, twisted.spread,

twisted.trial</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedConch" shape="rect">Twisted

Conch</a> - This contains twisted.conch.</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedLore" shape="rect">Twisted

Lore</a> - This contains twisted.lore</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedMail" shape="rect">Twisted

Mail</a> - This contains twisted.mail; NOTE the mail protocols

that were in twisted.protocols.(imap4,pop3,smtp) were moved to

twisted.mail.</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedNames" shape="rect">Twisted

Names</a> - This contains twisted.names; NOTE

twisted.protocols.dns was moved to twisted.names.dns.</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedNews" shape="rect">Twisted

News</a> - This contains twisted.news; NOTE

twisted.protocols.nntp was moved to twisted.news.nntp</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedPair" shape="rect">Twisted

Pair</a> - This contains twisted.pair; NOTE ethernet, ip, raw,

and rawudp protocol support was moved from twisted.protocols to

twisted.pair. (deprecated)</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedRunner" shape="rect">Twisted

Runner</a> - This contains twisted.runner.</li>

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedWeb" shape="rect">Twisted

Web</a> - This contains twisted.web; NOTE that

twisted.protocols.http was moved to twisted.web.http.</li>

100

101

<li><a href="http://twistedmatrix.com/trac/wiki/TwistedWords" shape="rect">Twisted

102

Words</a> - This contains twisted.words; NOTE that twisted.im was

103

moved to twisted.words.im, twisted.xish was moved to

104

twisted.words.xish, AND the chat protocols (irc, msn, jabber, toc,

105

oscar) were moved to twisted.words.protocols.</li>

106

</ul>

107

</p>

108

109

<p><a name="protocols" shape="rect">[1]</a>: twisted.protocols is very stripped

110

down now; it only includes the protocols that didn't belong anywhere

111

else. It still contains the simple protocols, the helper utilities,

112

and, ahem, FTP.</p>

113

114

115

<h2>Will I have to rewrite my code? What API changes are there?<a name="auto5"/></h2>

116

117

<p>

118

No existing code should <em>break</em>, however, many modules were

119

moved. Backwards compatibility support <em>does exist</em> in older versions of

120

Twisted, but was removed in Twisted 9.0.</p>

121

122

<h2>What about my deployments? What will I have to do to have the new packages?<a name="auto6"/></h2>

123

124

<p>

125

It depends on your OS and how you installed Twisted originally. If

126

you're using Debian, we are planning on breaking up the Debian

127

packages to e.g. python2.3-twisted-core, python2.3-twisted-web, and so

128

on. If you're using Windows, or generally install Twisted from the

129

tarball or from an SVN checkout, monolithic options will still be

130

available.

131

</p>

132

133

<p>

134

If you try to run code that imports a sub-package when that

135

sub-package is not available on the system, an ImportError will be

136

raised directing the user to the web site for that particular

137

sub-project.

138

</p>

139

140

<h2>Why are all the packages still named twisted.<em>subproject</em>?<a name="auto7"/></h2>

141

142

<p>

143

This is controversial. While this does mean that there is a

144

mashed-together namespace under <code>twisted.</code>, it's also the

145

simplest thing to do, and means less breakage for user-code, so we did that.

146

</p>

147

148

<h2>What does this mean for existing Twisted developers?<a name="auto8"/></h2>

149

150

<p>

151

Not much. The repository is rearranged a bit; protocols have been

152

moved to their relevant packages and documentation is now stored in

153

doc/<em>subproject</em>/ instead of everything at the top-level of

154

doc/. Everything is still in the same repository and everyone still

155

has the same access levels they used to.

156

</p>

157

158

</div>

159

160

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

161

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

162

</body>

163

</html>

b'\\ No newline at end of file'

Older »