src/pyams_utils/protocol/tcp.py
branchdev-tf
changeset 427 63284c98cdc1
parent 251 b9398ca282c7
--- a/src/pyams_utils/protocol/tcp.py	Sat Nov 23 01:24:11 2019 +0100
+++ b/src/pyams_utils/protocol/tcp.py	Sat Nov 23 14:57:24 2019 +0100
@@ -10,12 +10,17 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
-__docformat__ = 'restructuredtext'
+"""PyAMS_utils.protocol.tcp module
+
+This module only provides a single function, used to know if a given TCP port is already in use
+"""
 
 import socket
 
+__docformat__ = 'restructuredtext'
+
 
 def is_port_in_use(port, hostname='localhost'):
     """Check if given port is already used locally"""
-    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
-        return s.connect_ex((hostname, port)) == 0
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+        return sock.connect_ex((hostname, port)) == 0