openstack/deb-python-websocket-client
Code Issues Proposed changes

refactoring. move logging code to _logging.py

Browse Source
This commit is contained in:
Hiroki Ohtani
2015-03-16 11:49:43 +09:00
parent ee60d90e6f
commit 98892297ac
2 changed files with 97 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
websocket/_core.py
View File

@@ -53,7 +53,6 @@ import struct
import uuid import uuid
import hashlib import hashlib
import threading import threading
import logging
# websocket modules # websocket modules
from ._exceptions import * from ._exceptions import *
@@ -61,6 +60,7 @@ from ._abnf import *
from ._socket import * from ._socket import *
from ._utils import * from ._utils import *
from ._url import * from ._url import *
from ._logging import *
""" """
websocket python client. websocket python client.
@@ -75,41 +75,14 @@ Please see http://tools.ietf.org/html/rfc6455 for protocol.
VERSION = 13 VERSION = 13
logger = logging.getLogger()
traceEnabled = False
def enableTrace(tracable):
"""
turn on/off the tracability.
tracable: boolean value. if set True, tracability is enabled.
"""
global traceEnabled
traceEnabled = tracable
if tracable:
if not logger.handlers:
logger.addHandler(logging.StreamHandler())
logger.setLevel(logging.DEBUG)
def _dump(title, message):
if traceEnabled:
logger.debug("--- " + title + " ---")
logger.debug(message)
logger.debug("-----------------------")
def create_connection(url, timeout=None, **options): def create_connection(url, timeout=None, **options):
""" """
connect to url and return websocket object. connect to url and return websocket object.
Connect to url and return the WebSocket object. Connect to url and return the WebSocket object.
Passing optional timeout parameter will set the timeout on the socket. Passing optional timeout parameter will set the timeout on the socket.
If no timeout is supplied, the global default timeout setting returned by getdefauttimeout() is used. If no timeout is supplied,
the global default timeout setting returned by getdefauttimeout() is used.
You can customize using 'options'. You can customize using 'options'.
If you set "header" list object, you can set your own custom header. If you set "header" list object, you can set your own custom header.
@@ -119,7 +92,8 @@ def create_connection(url, timeout=None, **options):
timeout: socket timeout time. This value is integer. timeout: socket timeout time. This value is integer.
if you set None for this value, it means "use default_timeout value" if you set None for this value,
it means "use default_timeout value"
options: "header" -> custom http header list. options: "header" -> custom http header list.
@@ -127,12 +101,14 @@ def create_connection(url, timeout=None, **options):
"http_proxy_host" - http proxy host name. "http_proxy_host" - http proxy host name.
"http_proxy_port" - http proxy port. If not set, set to 80. "http_proxy_port" - http proxy port. If not set, set to 80.
"http_no_proxy" - host names, which doesn't use proxy. "http_no_proxy" - host names, which doesn't use proxy.
"http_proxy_auth" - http proxy auth infomation. tuple of username and password. "http_proxy_auth" - http proxy auth infomation.
tuple of username and password.
defualt is None defualt is None
"enable_multithread" -> enable lock for multithread. "enable_multithread" -> enable lock for multithread.
"sockopt" -> socket options "sockopt" -> socket options
"sslopt" -> ssl option "sslopt" -> ssl option
"subprotocols" - array of available sub protocols. default is None. "subprotocols" - array of available sub protocols.
default is None.
"skip_utf8_validation" - skip utf8 validation. "skip_utf8_validation" - skip utf8 validation.
""" """
sockopt = options.get("sockopt", []) sockopt = options.get("sockopt", [])
@@ -141,7 +117,8 @@ def create_connection(url, timeout=None, **options):
enable_multithread = options.get("enable_multithread", False) enable_multithread = options.get("enable_multithread", False)
skip_utf8_validation = options.get("skip_utf8_validation", False) skip_utf8_validation = options.get("skip_utf8_validation", False)
websock = WebSocket(sockopt=sockopt, sslopt=sslopt, websock = WebSocket(sockopt=sockopt, sslopt=sslopt,
fire_cont_frame = fire_cont_frame, enable_multithread=enable_multithread, fire_cont_frame=fire_cont_frame,
enable_multithread=enable_multithread,
skip_utf8_validation=skip_utf8_validation) skip_utf8_validation=skip_utf8_validation)
websock.settimeout(timeout if timeout is not None else getdefaulttimeout()) websock.settimeout(timeout if timeout is not None else getdefaulttimeout())
websock.connect(url, **options) websock.connect(url, **options)
@@ -188,7 +165,8 @@ class WebSocket(object):
""" """
def __init__(self, get_mask_key=None, sockopt=None, sslopt=None, def __init__(self, get_mask_key=None, sockopt=None, sslopt=None,
fire_cont_frame=False, enable_multithread=False, skip_utf8_validation=False): fire_cont_frame=False, enable_multithread=False,
skip_utf8_validation=False):
""" """
Initalize WebSocket object. Initalize WebSocket object.
""" """
@@ -253,7 +231,8 @@ class WebSocket(object):
def connect(self, url, **options): def connect(self, url, **options):
""" """
Connect to url. url is websocket url scheme. ie. ws://host:port/resource Connect to url. url is websocket url scheme.
ie. ws://host:port/resource
You can customize using 'options'. You can customize using 'options'.
If you set "header" list object, you can set your own custom header. If you set "header" list object, you can set your own custom header.
@@ -271,9 +250,11 @@ class WebSocket(object):
"http_proxy_host" - http proxy host name. "http_proxy_host" - http proxy host name.
"http_proxy_port" - http proxy port. If not set, set to 80. "http_proxy_port" - http proxy port. If not set, set to 80.
"http_no_proxy" - host names, which doesn't use proxy. "http_no_proxy" - host names, which doesn't use proxy.
"http_proxy_auth" - http proxy auth infomation. tuple of username and password. "http_proxy_auth" - http proxy auth infomation.
tuple of username and password.
defualt is None defualt is None
"subprotocols" - array of available sub protocols. default is None. "subprotocols" - array of available sub protocols.
default is None.
""" """
@@ -335,7 +316,7 @@ class WebSocket(object):
self._handshake(hostname, port, resource, **options) self._handshake(hostname, port, resource, **options)
def _tunnel(self, host, port, auth): def _tunnel(self, host, port, auth):
logger.debug("Connecting proxy...") debug("Connecting proxy...")
connect_header = "CONNECT %s:%d HTTP/1.0\r\n" % (host, port) connect_header = "CONNECT %s:%d HTTP/1.0\r\n" % (host, port)
# TODO: support digest auth. # TODO: support digest auth.
if auth and auth[0]: if auth and auth[0]:
@@ -345,7 +326,7 @@ class WebSocket(object):
encoded_str = base64encode(auth_str.encode()).strip().decode() encoded_str = base64encode(auth_str.encode()).strip().decode()
connect_header += "Proxy-Authorization: Basic %s\r\n" % encoded_str connect_header += "Proxy-Authorization: Basic %s\r\n" % encoded_str
connect_header += "\r\n" connect_header += "\r\n"
_dump("request header", connect_header) dump("request header", connect_header)
self._send(connect_header) self._send(connect_header)
@@ -406,7 +387,7 @@ class WebSocket(object):
header_str = "\r\n".join(headers) header_str = "\r\n".join(headers)
self._send(header_str) self._send(header_str)
_dump("request header", header_str) dump("request header", header_str)
resp_headers = self._get_resp_headers() resp_headers = self._get_resp_headers()
success = self._validate_header(resp_headers, key, options.get("subprotocols")) success = self._validate_header(resp_headers, key, options.get("subprotocols"))
@@ -428,11 +409,10 @@ class WebSocket(object):
if subprotocols: if subprotocols:
subproto = headers.get("sec-websocket-protocol", None) subproto = headers.get("sec-websocket-protocol", None)
if not subproto or subproto not in subprotocols: if not subproto or subproto not in subprotocols:
logger.error("Invalid subprotocol: " + str(subprotocols)) error("Invalid subprotocol: " + str(subprotocols))
return False return False
self.subprotocol = subproto self.subprotocol = subproto
result = headers.get("sec-websocket-accept", None) result = headers.get("sec-websocket-accept", None)
if not result: if not result:
return False return False
@@ -448,17 +428,14 @@ class WebSocket(object):
def _read_headers(self): def _read_headers(self):
status = None status = None
headers = {} headers = {}
if traceEnabled: trace("--- response header ---")
logger.debug("--- response header ---")
while True: while True:
line = self._recv_line() line = self._recv_line()
line = line.decode('utf-8').strip() line = line.decode('utf-8').strip()
if not line: if not line:
break break
trace(line)
if traceEnabled:
logger.debug(line)
if not status: if not status:
status_info = line.split(" ", 2) status_info = line.split(" ", 2)
@@ -471,8 +448,7 @@ class WebSocket(object):
else: else:
raise WebSocketException("Invalid header") raise WebSocketException("Invalid header")
if traceEnabled: trace("-----------------------")
logger.debug("-----------------------")
return status, headers return status, headers
@@ -509,8 +485,7 @@ class WebSocket(object):
frame.get_mask_key = self.get_mask_key frame.get_mask_key = self.get_mask_key
data = frame.format() data = frame.format()
length = len(data) length = len(data)
if traceEnabled: trace("send: " + repr(data))
logger.debug("send: " + repr(data))
with self.lock: with self.lock:
while data: while data:
@@ -519,7 +494,6 @@ class WebSocket(object):
return length return length
def send_binary(self, payload): def send_binary(self, payload):
return self.send(payload, ABNF.OPCODE_BINARY) return self.send(payload, ABNF.OPCODE_BINARY)
@@ -657,7 +631,6 @@ class WebSocket(object):
return frame return frame
def send_close(self, status=STATUS_NORMAL, reason=six.b("")): def send_close(self, status=STATUS_NORMAL, reason=six.b("")):
""" """
send close data to the server. send close data to the server.
@@ -690,10 +663,10 @@ class WebSocket(object):
self.sock.settimeout(3) self.sock.settimeout(3)
try: try:
frame = self.recv_frame() frame = self.recv_frame()
if logger.isEnabledFor(logging.ERROR): if isEnableForError():
recv_status = struct.unpack("!H", frame.data)[0] recv_status = struct.unpack("!H", frame.data)[0]
if recv_status != STATUS_NORMAL: if recv_status != STATUS_NORMAL:
logger.error("close status: " + repr(recv_status)) error("close status: " + repr(recv_status))
except: except:
pass pass
self.sock.settimeout(timeout) self.sock.settimeout(timeout)
@@ -748,7 +721,6 @@ class WebSocket(object):
self._recv_buffer = [unified[bufsize:]] self._recv_buffer = [unified[bufsize:]]
return unified[:bufsize] return unified[:bufsize]
def _recv_line(self): def _recv_line(self):
try: try:
return recv_line(self.sock) return recv_line(self.sock)
@@ -760,17 +732,3 @@ class WebSocket(object):
raise raise
except: except:
raise raise
if __name__ == "__main__":
enableTrace(True)
ws = create_connection("ws://echo.websocket.org/")
print("Sending 'Hello, World'...")
ws.send("Hello, World")
print("Sent")
print("Receiving...")
result = ws.recv()
print("Received '%s'" % result)
ws.close()

64
websocket/_logging.py Normal file
View File

@@ -0,0 +1,64 @@
"""
websocket - WebSocket client library for Python
Copyright (C) 2010 Hiroki Ohtani(liris)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1335 USA
"""
import logging
logger = logging.getLogger()
_traceEnabled = False
def enableTrace(tracable):
"""
turn on/off the tracability.
tracable: boolean value. if set True, tracability is enabled.
"""
global _traceEnabled
_traceEnabled = tracable
if tracable:
if not logger.handlers:
logger.addHandler(logging.StreamHandler())
logger.setLevel(logging.DEBUG)
def dump(title, message):
if _traceEnabled:
logger.debug("--- " + title + " ---")
logger.debug(message)
logger.debug("-----------------------")
def error(msg):
logger.error(msg)
def debug(msg):
logger.debug(msg)
def trace(msg):
if _traceEnabled:
logger.debug(msg)
def isEnableForError():
return logger.isEnableFor(logging.ERROR)