Merge pull request python-hyper#42 from jeamland/prospector

Prospector

Author: jeamland

Diff for: .prospector.yml

@@ -0,0 +1,6 @@
+pylint:
+  disable:
+    - unused-argument
+
+  options:
+    max-args: 6

Diff for: .travis.yml

@@ -31,7 +31,7 @@ matrix:
   - python: 3.6
     env: MODE=docs
   - python: 3.6
-    env: MODE=flake8
+    env: MODE=prospector
 
 cache: pip
 

Diff for: .travis/run.sh

@@ -40,7 +40,7 @@ install_wsproto() {
 }
 
 case "$MODE" in
-    flake8)
+    prospector)
         pip install flake8
         flake8 --max-complexity 12 wsproto
         ;;

Diff for: Pipfile

@@ -7,7 +7,7 @@ pytest = "*"
 pytest-cov = "*"
 coverage = "*"
 tox = "*"
-flake8 = "*"
+prospector = "*"
 
 [packages]
 h11 = "*"

Diff for: compliance/run-autobahn-tests.py

@@ -90,11 +90,11 @@ def wait_for_listener(port):
 def coverage(command, coverage_settings):
     if not coverage_settings["enabled"]:
         return [sys.executable] + command
-    else:
-        return ([sys.executable, "-m", "coverage", "run",
-                 "--include", coverage_settings["wsproto-path"],
-                 "--rcfile", coverage_settings["coveragerc"]]
-                + command)
+
+    return ([sys.executable, "-m", "coverage", "run",
+             "--include", coverage_settings["wsproto-path"],
+             "--rcfile", coverage_settings["coveragerc"]]
+            + command)
 
 def summarize(report_path):
     with open(os.path.join(report_path, "index.json")) as f:

Diff for: tox.ini

@@ -6,10 +6,10 @@ deps = -r{toxinidir}/test_requirements.txt
 passenv = COVERAGE_FILE
 commands = pytest --cov {envsitepackagesdir}/wsproto --cov-report term-missing --cov-config {toxinidir}/.coveragerc {toxinidir}/test/
 
-[testenv:lint]
+[testenv:prospector]
 basepython = python3.6
-deps = flake8==3.4.1
-commands = flake8 --max-complexity 12 wsproto test
+deps = prospector
+commands = prospector
 
 [testenv:docs]
 basepython = python3.6

Diff for: wsproto/connection.py

@@ -100,13 +100,13 @@ class WSConnection(object):
     """
 
     def __init__(self, conn_type, host=None, resource=None, extensions=None,
-                 subprotocols=[]):
+                 subprotocols=None):
         self.client = conn_type is ConnectionType.CLIENT
 
         self.host = host
         self.resource = resource
 
-        self.subprotocols = subprotocols
+        self.subprotocols = subprotocols or []
         self.extensions = extensions or []
 
         self.version = b'13'
@@ -393,6 +393,34 @@ def _process_connection_request(self, event):
 
         return ConnectionRequested(proposed_subprotocols, event)
 
+    def _extension_accept(self, extensions_header):
+        accepts = {}
+        offers = _split_comma_header(extensions_header)
+
+        for offer in offers:
+            name = offer.split(';', 1)[0].strip()
+            for extension in self.extensions:
+                if extension.name == name:
+                    accept = extension.accept(self, offer)
+                    if accept is True:
+                        accepts[extension.name] = True
+                    elif accept is not False and accept is not None:
+                        accepts[extension.name] = accept.encode('ascii')
+
+        if accepts:
+            extensions = []
+            for name, params in accepts.items():
+                if params is True:
+                    extensions.append(name.encode('ascii'))
+                else:
+                    # py34 annoyance: doesn't support bytestring formatting
+                    params = params.decode("ascii")
+                    extensions.append(('%s; %s' % (name, params))
+                                      .encode("ascii"))
+            return b', '.join(extensions)
+
+        return None
+
     def accept(self, event, subprotocol=None):
         request = event.h11request
         request_headers = _normed_header_dict(request.headers)
@@ -413,31 +441,10 @@ def accept(self, event, subprotocol=None):
             headers[b'Sec-WebSocket-Protocol'] = subprotocol
 
         extensions = request_headers.get(b'sec-websocket-extensions', None)
-        accepts = {}
-        if extensions is not None:
-            offers = _split_comma_header(extensions)
-
-            for offer in offers:
-                name = offer.split(';', 1)[0].strip()
-                for extension in self.extensions:
-                    if extension.name == name:
-                        accept = extension.accept(self, offer)
-                        if accept is True:
-                            accepts[extension.name] = True
-                        elif accept is not False and accept is not None:
-                            accepts[extension.name] = accept.encode('ascii')
-
-        if accepts:
-            extensions = []
-            for name, params in accepts.items():
-                if params is True:
-                    extensions.append(name.encode('ascii'))
-                else:
-                    # py34 annoyance: doesn't support bytestring formatting
-                    params = params.decode("ascii")
-                    extensions.append(('%s; %s' % (name, params))
-                                      .encode("ascii"))
-            headers[b"Sec-WebSocket-Extensions"] = b', '.join(extensions)
+        if extensions:
+            accepts = self._extension_accept(extensions)
+            if accepts:
+                headers[b"Sec-WebSocket-Extensions"] = accepts
 
         response = h11.InformationalResponse(status_code=101,
                                              headers=headers.items())

Diff for: wsproto/extensions.py

@@ -18,13 +18,13 @@ def enabled(self):
         return False
 
     def offer(self, connection):
-        return None
+        pass
 
     def accept(self, connection, offer):
-        return None
+        pass
 
     def finalize(self, connection, offer):
-        return None
+        pass
 
     def frame_inbound_header(self, proto, opcode, rsv, payload_length):
         return RsvBits(False, False, False)
@@ -33,7 +33,7 @@ def frame_inbound_payload_data(self, proto, data):
         return data
 
     def frame_inbound_complete(self, proto, fin):
-        return None
+        pass
 
     def frame_outbound(self, proto, opcode, rsv, data, fin):
         return (rsv, data)
@@ -164,7 +164,7 @@ def frame_inbound_header(self, proto, opcode, rsv, payload_length):
                 else:
                     bits = self.client_max_window_bits
                 if self._decompressor is None:
-                    self._decompressor = zlib.decompressobj(-bits)
+                    self._decompressor = zlib.decompressobj(-int(bits))
 
         return RsvBits(True, False, False)
 
@@ -217,7 +217,7 @@ def frame_outbound(self, proto, opcode, rsv, data, fin):
             else:
                 bits = self.server_max_window_bits
             self._compressor = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION,
-                                                zlib.DEFLATED, -bits)
+                                                zlib.DEFLATED, -int(bits))
 
         data = self._compressor.compress(bytes(data))
 

Diff for: wsproto/frame_protocol.py

@@ -131,17 +131,17 @@ def __init__(self, msg, code=CloseReason.PROTOCOL_ERROR):
 def _truncate_utf8(data, nbytes):
     if len(data) <= nbytes:
         return data
-    else:
-        # Truncate
-        data = data[:nbytes]
-        # But we might have cut a codepoint in half, in which case we want to
-        # discard the partial character so the data is at least
-        # well-formed. This is a little inefficient since it processes the
-        # whole message twice when in theory we could just peek at the last
-        # few characters, but since this is only used for close messages (max
-        # length = 125 bytes) it really doesn't matter.
-        data = data.decode("utf-8", errors="ignore").encode("utf-8")
-        return data
+
+    # Truncate
+    data = data[:nbytes]
+    # But we might have cut a codepoint in half, in which case we want to
+    # discard the partial character so the data is at least
+    # well-formed. This is a little inefficient since it processes the
+    # whole message twice when in theory we could just peek at the last
+    # few characters, but since this is only used for close messages (max
+    # length = 125 bytes) it really doesn't matter.
+    data = data.decode("utf-8", errors="ignore").encode("utf-8")
+    return data
 
 
 class Buffer(object):
@@ -231,9 +231,9 @@ def decode_payload(self, data, finished):
 
 
 class FrameDecoder(object):
-    def __init__(self, client, extensions=[]):
+    def __init__(self, client, extensions=None):
         self.client = client
-        self.extensions = extensions
+        self.extensions = extensions or []
 
         self.buffer = Buffer()
 
@@ -406,7 +406,7 @@ def __init__(self, client, extensions):
     def _process_close(self, frame):
         data = frame.payload
 
-        if len(data) == 0:
+        if not data:
             # "If this Close control frame contains no status code, _The
             # WebSocket Connection Close Code_ is considered to be 1005"
             data = (CloseReason.NO_STATUS_RCVD, "")
@@ -519,18 +519,21 @@ def send_data(self, payload=b'', fin=True):
 
         return self._serialize_frame(opcode, payload, fin)
 
+    def _make_fin_rsv_opcode(self, fin, rsv, opcode):
+        fin = int(fin) << 7
+        rsv = (int(rsv.rsv1) << 6) + (int(rsv.rsv2) << 5) + \
+            (int(rsv.rsv3) << 4)
+        opcode = int(opcode)
+
+        return fin | rsv | opcode
+
     def _serialize_frame(self, opcode, payload=b'', fin=True):
         rsv = RsvBits(False, False, False)
         for extension in reversed(self.extensions):
             rsv, payload = extension.frame_outbound(self, opcode, rsv, payload,
                                                     fin)
 
-        fin_rsv = 0
-        for bit in rsv:
-            fin_rsv <<= 1
-            fin_rsv |= int(bit)
-        fin_rsv |= (int(fin) << 3)
-        fin_rsv_opcode = fin_rsv << 4 | opcode
+        fin_rsv_opcode = self._make_fin_rsv_opcode(fin, rsv, opcode)
 
         payload_length = len(payload)
         quad_payload = False
@@ -572,5 +575,5 @@ def _serialize_frame(self, opcode, payload=b'', fin=True):
             masking_key = os.urandom(4)
             masker = XorMaskerSimple(masking_key)
             return header + masking_key + masker.process(payload)
-        else:
-            return header + payload
+
+        return header + payload