api change: rename more methods and attributes (mostly internal)
diff --git a/serial/urlhandler/protocol_socket.py b/serial/urlhandler/protocol_socket.py
index c0e3dfb..99e532f 100644
--- a/serial/urlhandler/protocol_socket.py
+++ b/serial/urlhandler/protocol_socket.py
@@ -29,7 +29,7 @@
from serial.serialutil import *
-# map log level names to constants. used in fromURL()
+# map log level names to constants. used in from_url()
LOGGER_LEVELS = {
'debug': logging.DEBUG,
'info': logging.INFO,
@@ -53,10 +53,10 @@
self.logger = None
if self._port is None:
raise SerialException("Port must be configured before it can be used.")
- if self._isOpen:
+ if self.is_open:
raise SerialException("Port is already open.")
try:
- self._socket = socket.create_connection(self.fromURL(self.portstr))
+ self._socket = socket.create_connection(self.from_url(self.portstr))
except Exception as msg:
self._socket = None
raise SerialException("Could not open port %s: %s" % (self.portstr, msg))
@@ -64,17 +64,17 @@
self._socket.settimeout(POLL_TIMEOUT) # used for write timeout support :/
# not that there anything to configure...
- self._reconfigurePort()
+ self._reconfigure_port()
# all things set up get, now a clean start
- self._isOpen = True
- if not self.dsrdtr:
+ self.is_open = True
+ if not self._dsrdtr:
self._update_dtr_state()
if not self._rtscts:
self._update_rts_state()
self.reset_input_buffer()
self.reset_output_buffer()
- def _reconfigurePort(self):
+ def _reconfigure_port(self):
"""\
Set communication parameters on opened port. For the socket://
protocol all settings are ignored!
@@ -86,7 +86,7 @@
def close(self):
"""Close port"""
- if self._isOpen:
+ if self.is_open:
if self._socket:
try:
self._socket.shutdown(socket.SHUT_RDWR)
@@ -95,14 +95,11 @@
# ignore errors.
pass
self._socket = None
- self._isOpen = False
+ self.is_open = False
# in case of quick reconnects, give the server some time
time.sleep(0.3)
- def makeDeviceName(self, port):
- raise SerialException("there is no sensible way to turn numbers into URLs")
-
- def fromURL(self, url):
+ def from_url(self, url):
"""extract host and port from an URL string"""
parts = urlparse.urlsplit(url)
if parts.scheme != "socket":
@@ -128,8 +125,8 @@
@property
def in_waiting(self):
- """Return the number of characters currently in the input buffer."""
- if not self._isOpen: raise portNotOpenError
+ """Return the number of bytes currently in the input buffer."""
+ if not self.is_open: raise portNotOpenError
# Poll the socket to see if it is ready for reading.
# If ready, at least one byte will be to read.
lr, lw, lx = select.select([self._socket], [], [], 0)
@@ -141,7 +138,7 @@
return less characters as requested. With no timeout it will block
until the requested number of bytes is read.
"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
data = bytearray()
if self._timeout is not None:
timeout = time.time() + self._timeout
@@ -170,11 +167,11 @@
def write(self, data):
"""\
- Output the given string over the serial port. Can block if the
+ Output the given byte string over the serial port. Can block if the
connection is blocked. May raise SerialException if the connection is
closed.
"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
try:
self._socket.sendall(to_bytes(data))
except socket.error as e:
@@ -184,7 +181,7 @@
def reset_input_buffer(self):
"""Clear input buffer, discarding all that is in the buffer."""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
if self.logger:
self.logger.info('ignored reset_input_buffer')
@@ -193,7 +190,7 @@
Clear output buffer, aborting the current output and
discarding all that is in the buffer.
"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
if self.logger:
self.logger.info('ignored reset_output_buffer')
@@ -202,7 +199,7 @@
Send break condition. Timed, returns to idle state after given
duration.
"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
if self.logger:
self.logger.info('ignored send_break(%r)' % (duration,))
@@ -225,7 +222,7 @@
@property
def cts(self):
"""Read terminal status line: Clear To Send"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
if self.logger:
self.logger.info('returning dummy for cts')
return True
@@ -233,7 +230,7 @@
@property
def dsr(self):
"""Read terminal status line: Data Set Ready"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
if self.logger:
self.logger.info('returning dummy for dsr')
return True
@@ -241,7 +238,7 @@
@property
def ri(self):
"""Read terminal status line: Ring Indicator"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
if self.logger:
self.logger.info('returning dummy for ri')
return False
@@ -249,7 +246,7 @@
@property
def cd(self):
"""Read terminal status line: Carrier Detect"""
- if not self._isOpen: raise portNotOpenError
+ if not self.is_open: raise portNotOpenError
if self.logger:
self.logger.info('returning dummy for cd)')
return True