[Twisted-Python] general documentation question
I am trying to get use to the documentation in twisted, as I am new to python as well. I am using a LineReceiver class for a client I am building. There are some attributes like “connected, delimiter, transport”. I am having a tough time finding them within the twisted documentation. I’ve looked at all subclasses that I can see that are related to LineReceiver and can’t seem to find where they are defined. I did find a twistedmatrix user that has these listed, but how do I find this in official documentation? Here is the link I am referring too. HYPERLINK "http://twistedmatrix.com/users/jh/teud/Twisted/twisted.protocols.protocol.h tml#Protocol"http://twistedmatrix.com/users/jh/teud/Twisted/twisted.protocol s.protocol.html#Protocol -Lee -- No virus found in this outgoing message. Checked by AVG Free Edition. Version: 7.5.441 / Virus Database: 268.17.35/680 - Release Date: 2/10/2007 9:15 PM
On 2/11/07, Lee Connell <lee.a.connell@gmail.com> wrote:
I am trying to get use to the documentation in twisted, as I am new to python as well. I am using a LineReceiver class for a client I am building. There are some attributes like "connected, delimiter, transport". I am having a tough time finding them within the twisted documentation. I've looked at all subclasses that I can see that are related to LineReceiver and can't seem to find where they are defined. I did find a twistedmatrix user that has these listed, but how do I find this in official documentation?
Here is the link I am referring too. http://twistedmatrix.com/users/jh/teud/Twisted/twisted.protocols.protocol.ht...
Yuck. That stuff is super old and I'm surprised it's still even there. Anyway, it appears 'transport' is unfortunately not actually mentioned anywhere where it should be in the API docs (which is the Protocol class, probably). 'delimiter' is fortunately documented in the LineReceiver class. I'm not sure 'connected' is actually public, but even if it is it is a pretty useless attribute. http://twistedmatrix.com/documents/current/api/twisted.protocols.basic.LineR... -- Christopher Armstrong International Man of Twistery http://radix.twistedmatrix.com/ http://twistedmatrix.com/ http://canonical.com/
Hi Christopher, Thanks for response, yeah connected is public and it's useable, I use it to check the connection state before sending any data through my wx GUI. I could just as easily create my own from the connectionMade member. I was just more curious of the documentation layout, because I'm going to be using it a lot. -----Original Message----- From: twisted-python-bounces@twistedmatrix.com [mailto:twisted-python-bounces@twistedmatrix.com] On Behalf Of Christopher Armstrong Sent: Sunday, February 11, 2007 10:59 AM To: Twisted general discussion Subject: Re: [Twisted-Python] general documentation question On 2/11/07, Lee Connell <lee.a.connell@gmail.com> wrote:
I am trying to get use to the documentation in twisted, as I am new to python as well. I am using a LineReceiver class for a client I am building. There are some attributes like "connected, delimiter, transport". I am having a tough time finding them within the twisted documentation. I've looked at all subclasses that I can see that are related to LineReceiver and can't seem to find where they are defined. I did find a twistedmatrix user that has these listed, but how do I find this in official documentation?
Here is the link I am referring too.
http://twistedmatrix.com/users/jh/teud/Twisted/twisted.protocols.protocol.ht ml#Protocol Yuck. That stuff is super old and I'm surprised it's still even there. Anyway, it appears 'transport' is unfortunately not actually mentioned anywhere where it should be in the API docs (which is the Protocol class, probably). 'delimiter' is fortunately documented in the LineReceiver class. I'm not sure 'connected' is actually public, but even if it is it is a pretty useless attribute. http://twistedmatrix.com/documents/current/api/twisted.protocols.basic.LineR eceiver.html -- Christopher Armstrong International Man of Twistery http://radix.twistedmatrix.com/ http://twistedmatrix.com/ http://canonical.com/ _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python -- No virus found in this incoming message. Checked by AVG Free Edition. Version: 7.5.441 / Virus Database: 268.17.35/680 - Release Date: 2/10/2007 9:15 PM -- No virus found in this outgoing message. Checked by AVG Free Edition. Version: 7.5.441 / Virus Database: 268.17.35/680 - Release Date: 2/10/2007 9:15 PM
participants (2)
-
Christopher Armstrong -
Lee Connell