From 05338ec8f65485c916f99d6f853efe8f2f344d00 Mon Sep 17 00:00:00 2001
From: Per Cederqvist <ceder@lysator.liu.se>
Date: Sun, 26 Oct 2003 19:12:16 +0000
Subject: [PATCH] Documentation added.
---
pcl_expect/telnet.py | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/pcl_expect/telnet.py b/pcl_expect/telnet.py
index 17fc386..0c128d4 100644
--- a/pcl_expect/telnet.py
+++ b/pcl_expect/telnet.py
@@ -1,3 +1,6 @@
+"""Connect to a telnet server via the telnetlib.Telnet class.
+"""
+
import telnetlib
import pcl_expect
@@ -8,6 +11,12 @@ __all__ = [
class Telnet(pcl_expect.Expectable):
def __init__(self, host, port):
+ """Establish a telnet session.
+
+ The host and port argument are passed to telnetlib.Telnet.
+
+ """
+
self.telnet = telnetlib.Telnet(host, port)
pcl_expect.Expectable.__init__(self, self.telnet.fileno())
@@ -19,9 +28,11 @@ class Telnet(pcl_expect.Expectable):
return s, False
def send(self, s):
+ """Send a string to the remote telnet server."""
self.telnet.write(s)
def close(self):
+ """Close the telnet session."""
pcl_expect.Expectable.close(self)
self.telnet.close()
--
GitLab