summaryrefslogtreecommitdiff
path: root/sleekxmpp
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-11-22 16:33:38 -0800
committerLance Stout <lancestout@gmail.com>2011-11-22 16:33:38 -0800
commit5f44c0e678d784d3f67ef1c5d32e1561853cf9ed (patch)
treefa5d8660628cceb2bf35dd486879ddc93e8651c8 /sleekxmpp
parentb87c4d786d1c093af3368b8bcfb9c3754fc1ba7a (diff)
downloadslixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.tar.gz
slixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.tar.bz2
slixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.tar.xz
slixmpp-5f44c0e678d784d3f67ef1c5d32e1561853cf9ed.zip
Add docs for filesocket
Diffstat (limited to 'sleekxmpp')
-rw-r--r--sleekxmpp/xmlstream/filesocket.py24
1 files changed, 14 insertions, 10 deletions
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.
"""