diff options
| author | Lance Stout <lancestout@gmail.com> | 2011-11-22 16:33:38 -0800 |
|---|---|---|
| committer | Lance Stout <lancestout@gmail.com> | 2011-11-22 16:33:38 -0800 |
| commit | 5f44c0e678d784d3f67ef1c5d32e1561853cf9ed (patch) | |
| tree | fa5d8660628cceb2bf35dd486879ddc93e8651c8 | |
| parent | b87c4d786d1c093af3368b8bcfb9c3754fc1ba7a (diff) | |
| download | slixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.tar.gz slixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.tar.bz2 slixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.tar.xz slixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.zip | |
Add docs for filesocket
| -rw-r--r-- | docs/api/xmlstream/filesocket.rst | 12 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | sleekxmpp/xmlstream/filesocket.py | 24 |
3 files changed, 27 insertions, 10 deletions
diff --git a/docs/api/xmlstream/filesocket.rst b/docs/api/xmlstream/filesocket.rst new file mode 100644 index 00000000..35f44019 --- /dev/null +++ b/docs/api/xmlstream/filesocket.rst @@ -0,0 +1,12 @@ +.. module:: sleekxmpp.xmlstream.filesocket + +.. _filesocket: + +Python 2.6 File Socket Shims +============================ + +.. autoclass:: FileSocket + :members: + +.. autoclass:: Socket26 + :members: diff --git a/docs/index.rst b/docs/index.rst index cb5b327e..d5b83cbe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -114,6 +114,7 @@ API Reference api/basexmpp api/xmlstream/stanzabase api/xmlstream/tostring + api/xmlstream/filesocket Additional Info --------------- diff --git a/sleekxmpp/xmlstream/filesocket.py b/sleekxmpp/xmlstream/filesocket.py index fd81864b..56554c73 100644 --- a/sleekxmpp/xmlstream/filesocket.py +++ b/sleekxmpp/xmlstream/filesocket.py @@ -1,9 +1,15 @@ +# -*- coding: utf-8 -*- """ - SleekXMPP: The Sleek XMPP Library - Copyright (C) 2010 Nathanael C. Fritz - This file is part of SleekXMPP. + sleekxmpp.xmlstream.filesocket + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - See the file LICENSE for copying permission. + This module is a shim for correcting deficiencies in the file + socket implementation of Python2.6. + + Part of SleekXMPP: The Sleek XMPP Library + + :copyright: (c) 2011 Nathanael C. Fritz + :license: MIT, see LICENSE for more details """ from socket import _fileobject @@ -12,12 +18,11 @@ import socket class FileSocket(_fileobject): - """ - Create a file object wrapper for a socket to work around + """Create a file object wrapper for a socket to work around issues present in Python 2.6 when using sockets as file objects. - The parser for xml.etree.cElementTree requires a file, but we will - be reading from the XMPP connection socket instead. + The parser for :class:`~xml.etree.cElementTree` requires a file, but + we will be reading from the XMPP connection socket instead. """ def read(self, size=4096): @@ -31,8 +36,7 @@ class FileSocket(_fileobject): class Socket26(socket._socketobject): - """ - A custom socket implementation that uses our own FileSocket class + """A custom socket implementation that uses our own FileSocket class to work around issues in Python 2.6 when using sockets as files. """ |