Skip to content

Commit

Permalink
Merge ref-split-code-3713: remove reference to split code
Browse files Browse the repository at this point in the history 
Author: thijs
Reviewer: exarkun
Fixes: twisted#3713


git-svn-id: svn://svn.twistedmatrix.com/svn/Twisted/trunk@26647 bbbe8e31-12d6-0310-92fd-ac37d47ddeeb
  • Loading branch information
@thijstriemstra
thijstriemstra committed Apr 5, 2009
1 parent 500a158 commit 7f9fd81
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 176 deletions.
92 changes: 4 additions & 88 deletions doc/core/upgrades/2.0/components.xhtml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ class="API">twisted.python.components</code> package has been updated to use <a
href="http://www.zope.org/Wikis/Interfaces/FrontPage">Zope Interfaces</a> in
the 2.0 release.</p>

<p>New code developed using the 2.0 release of Twisted Core should use Zope
<p>New code developed starting with the 2.0 release of Twisted Core should use Zope
Interfaces directly rather than using the twisted.python.components
package.</p>

<h2>FAQ</h2>

<h3>Why is Twisted switching to Zope Interfaces?</h3>
<h3>Why did Twisted switch to Zope Interfaces?</h3>

<p>
The twisted.python.components package is a large amount of on-going
maintainence. Using the Zope Interface package also provides a greater level of
maintenance. Using the Zope Interface package also provides a greater level of
compatibility between Twisted interfaces and Zope interfaces.
</p>

<h3>Why is Twisted switching to Zope Interfaces rather than PyProtocols?</h3>
<h3>Why did Twisted switch to Zope Interfaces rather than PyProtocols?</h3>

<p>
The Zope Interface package was chosen over PyProtocols because of its greater
Expand Down Expand Up @@ -103,90 +103,6 @@ style of implements declarations.
<p>This document is the work of Jason A. Mobarak, with contributions from Mary
Gardiner.</p>

<!--
<h3>Will my code break?</h3>
<p>
No. Please see insert slyphon's z.i tutorial
</p>
Stuff below may be redundant if slyphon has finished his tutorial.
Otherwise it might be a good idea for me to finish?
-->

<!--
However, there are some differences between t.p.c and Zope interfaces.
Classes originally written in this manner:
<code>
class C:
__implements__ = IFoo,
</code>
Should be changed to:
<code>
class C:
zope.interface.implements(IFoo)
</code>
<h3>
What about third party classes dependant on the old style of implements
declarations?
</h3>
From twisted.python.components, backwardsCompatImplements will fix this, for
example:
<code>
twisted.python.components.backwardsCompatImplements(C)
</code>
</p>
<h3>What about using third party classes?</h3>
<p>
If you are using third party libraries that only declare __implements__, these
objects should be made compatible with fixClassImplements from
twisted.python.components, for example:
<code>
twisted.python.componets.fixClassImplements(o.__class__)
</code>
This will make sure that __implements__ declarations get converted to the new
style of implements declarations.
</p>
<h3>Where can I get Zope Interfaces</h3>
<p>
Individually packaged release can be found from the <a
href="http://zope.org/Products/ZopeInterface/">Zope Interface</a> project
website. Releases of <a href="splitfaq">Twiste-core</a> will also include the
Zope Interface package.
</p>
-->
</body>
</html>

Expand Down
53 changes: 11 additions & 42 deletions doc/core/upgrades/2.0/split.xhtml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@
<p>
<a href="http://twistedmatrix.com/">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 are
breaking it into several smaller packages before the 2.0 release.
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 is Twisted being split?</h2>
<h2>Why was Twisted being split?</h2>

<p>
The biggest reason is to make our release process more
agile. Currently it is very slow. 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.
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 will give every
where it is hidden inside Twisted. The Twisted split gave every
sub-project its own web site and thus more visibility.
</p>

Expand Down Expand Up @@ -117,11 +117,8 @@ and, ahem, FTP.</p>

<p>
No existing code should <em>break</em>, however, many modules were
moved. Backwards compatibility support <em>does exist</em>; you will
get a DeprecationWarning if you try to import, e.g.,
twisted.protocols.http notifying you that it has been moved to
twisted.web.http.
</p>
moved. Backwards compatibility support <em>does exist</em> in older versions of
Twisted, but was removed in Twisted 9.0.</p>

<h2>What about my deployments? What will I have to do to have the new packages?</h2>

Expand All @@ -146,37 +143,9 @@ sub-project.
<p>
This is controversial. While this does mean that there is a
mashed-together namespace under <code>twisted.</code>, it's also the
simplest thing to do, and means less breakage for user-code, so we're
doing that.
</p>


<h2>When will 2.0 be released?</h2>

<p>
That's hard to tell. I (Christopher Armstrong) am doing most of the
work of the split, but I'm in the middle of a move to Australia and a
new full-time job. Unfortunately doing this split requires a lot of
specific knowledge of how things work, but if you are willing to help,
please see the next question.
</p>

<h2>Where can I see a progress report?</h2>

<p>
<a href="http://twistedmatrix.com/bugs/issue567">http://twistedmatrix.com/bugs/issue567</a>.
simplest thing to do, and means less breakage for user-code, so we did that.
</p>


<h2>Can I help?</h2>

<p>
Really, there's not a whole lot to be delegated, unless your name is
Fred Drake. However, talk to <a
href="http://radix.twistedmatrix.com/">Christopher Armstrong</a> via
<a href="mailto:radix@twistedmatrix.com">email</a> or IRC ('radix' on
irc.freenode.net) if you're interested. </p>

<h2>What does this mean for existing Twisted developers?</h2>

<p>
Expand Down
7 changes: 1 addition & 6 deletions twisted/protocols/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# Copyright (c) 2001-2008 Twisted Matrix Laboratories.
# Copyright (c) 2001-2009 Twisted Matrix Laboratories.
# See LICENSE for details.


"""
Twisted Protocols: a collection of internet protocol implementations.
Many of the protocols found in this package have been moved after the
package split in Twisted 2.0. This means you will get a C{DeprecationWarning}
if you try to import, e.g., L{twisted.protocols.http} notifying you
that it has been moved to L{twisted.web.http}.
"""
5 changes: 0 additions & 5 deletions twisted/protocols/xmlstream.py
View file

This file was deleted.

35 changes: 0 additions & 35 deletions twisted/test/test_split_compat.py
View file

This file was deleted.

0 comments on commit 7f9fd81

Please sign in to comment.