Update 'README.rst'

.travis.yml

@@ -42,10 +42,12 @@ before_install:
 install:
   - if [[ $(echo "$TOXENV" | egrep -c "py32") != 0 ]]; then pip install setuptools==17.1.1; fi;
   - if [[ $(echo "$TOXENV" | egrep -c "(py2[45]|py3[12])") != 0 ]]; then pip install virtualenv==1.7.2 tox==1.3; fi;
-  - if [[ $(echo "$TOXENV" | egrep -c "(py2[45]|py3[12])") == 0 ]]; then pip install tox; fi;
+  - if [[ $(echo "$TOXENV" | egrep -c "(py26|py33)") != 0 ]]; then pip install virtualenv==15.2.0 tox==2.9.1; fi;
+  - if [[ $(echo "$TOXENV" | egrep -c "(py2[456]|py3[123])") == 0 ]]; then pip install tox; fi;
+
+
 
 script:
-  - ifconfig
   - tox
 
 notifications:

README.rst

@@ -1,3 +1,7 @@
+#Usage
+
+$ curl -s https://git.spectre5.com/adamcruz/speedtest-cli-pub/raw/branch/master/speedtest.py | python -
+
 speedtest-cli
 =============
 
@@ -7,9 +11,9 @@ speedtest.net
 .. image:: https://img.shields.io/pypi/v/speedtest-cli.svg
         :target: https://pypi.python.org/pypi/speedtest-cli/
         :alt: Latest Version
-.. image:: https://img.shields.io/pypi/dm/speedtest-cli.svg
+.. image:: https://img.shields.io/travis/sivel/speedtest-cli.svg
         :target: https://pypi.python.org/pypi/speedtest-cli/
-        :alt: Downloads
+        :alt: Travis
 .. image:: https://img.shields.io/pypi/l/speedtest-cli.svg
         :target: https://pypi.python.org/pypi/speedtest-cli/
         :alt: License
@@ -17,7 +21,7 @@ speedtest.net
 Versions
 --------
 
-speedtest-cli works with Python 2.4-3.6
+speedtest-cli works with Python 2.4-3.7
 
 .. image:: https://img.shields.io/pypi/pyversions/speedtest-cli.svg
         :target: https://pypi.python.org/pypi/speedtest-cli/

setup.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-# Copyright 2012-2016 Matt Martz
+# Copyright 2012-2018 Matt Martz
 # All Rights Reserved.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -66,7 +66,7 @@ setup(
     author_email='matt@sivel.net',
     url='https://github.com/sivel/speedtest-cli',
     license='Apache License, Version 2.0',
-    py_modules=['speedtest', 'speedtest_cli'],
+    py_modules=['speedtest'],
     entry_points={
         'console_scripts': [
             'speedtest=speedtest:main',
@@ -91,5 +91,6 @@ setup(
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
     ]
 )

speedtest-cli.1

@@ -1,4 +1,4 @@
-.TH "speedtest-cli" 1 "2014-04-23" "speedtest-cli"
+.TH "speedtest-cli" 1 "2018-01-05" "speedtest-cli"
 .SH NAME
 speedtest\-cli \- Command line interface for testing internet bandwidth using speedtest.net
 .SH SYNOPSIS
@@ -23,14 +23,24 @@ Displays usage for the tool.
 
 .B Options
 
+\fB\-\-no\-download\fR
+.RS
+Do not perform download test
+.RE
+
+\fB\-\-no\-upload\fR
+.RS
+Do not perform upload test
+.RE
+
 \fB\-\-bytes\fR
 .RS
-Display values in bytes instead of bits. Does not affect the image generated by \-\-share
+Display values in bytes instead of bits. Does not affect the image generated by \-\-share, nor output from \-\-json or \-\-csv
 .RE
 
 \fB\-\-share\fR
 .RS
-Generate and provide a URL to the speedtest.net share results image
+Generate and provide a URL to the speedtest.net share results image, not displayed with \-\-csv
 .RE
 
 \fB\-\-simple\fR
@@ -43,12 +53,12 @@ Suppress verbose output, only show basic information
 Suppress verbose output, only show basic information in CSV format. Speeds listed in bit/s and not affected by \-\-bytes
 .RE
 
-\fB\-\-csv-delimiter CSV_DELIMITER\fR
+\fB\-\-csv\-delimiter CSV_DELIMITER\fR
 .RS
 Single character delimiter to use in CSV output. Default ","
 .RE
 
-\fB\-\-csv-header\fR
+\fB\-\-csv\-header\fR
 .RS
 Print CSV headers
 .RE
@@ -65,7 +75,12 @@ Display a list of speedtest.net servers sorted by distance
 
 \fB\-\-server SERVER\fR
 .RS
-Specify a server ID to test against
+Specify a server ID to test against. Can be supplied multiple times
+.RE
+
+\fB\-\-exclude EXCLUDE\fR
+.RS
+Exclude a server from selection. Can be supplied multiple times
 .RE
 
 \fB\-\-mini MINI\fR
@@ -88,6 +103,11 @@ HTTP timeout in seconds. Default 10
 Use HTTPS instead of HTTP when communicating with speedtest.net operated servers
 .RE
 
+\fB\-\-no\-pre\-allocate\fR
+.RS
+Do not pre allocate upload data. Pre allocation is enabled by default to improve upload performance. To support systems with insufficient memory, use this option to avoid a MemoryError
+.RE
+
 \fB\-\-version\fR
 .RS
 Show the version number and exit

speedtest.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-# Copyright 2012-2016 Matt Martz
+# Copyright 2012-2018 Matt Martz
 # All Rights Reserved.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -36,7 +36,7 @@ except ImportError:
     gzip = None
     GZIP_BASE = object
 
-__version__ = '2.0.0a'
+__version__ = '2.0.2'
 
 
 class FakeShutdownEvent(object):
@@ -70,6 +70,7 @@ except ImportError:
         import xml.etree.ElementTree as ET
     except ImportError:
         from xml.dom import minidom as DOM
+        from xml.parsers.expat import ExpatError
         ET = None
 
 try:
@@ -84,9 +85,9 @@ except ImportError:
                                 HTTPErrorProcessor, OpenerDirector)
 
 try:
-    from httplib import HTTPConnection
+    from httplib import HTTPConnection, BadStatusLine
 except ImportError:
-    from http.client import HTTPConnection
+    from http.client import HTTPConnection, BadStatusLine
 
 try:
     from httplib import HTTPSConnection
@@ -165,8 +166,14 @@ except ImportError:
             self.flush()
 
     _py3_print = getattr(builtins, 'print')
-    _py3_utf8_stdout = _Py3Utf8Output(sys.stdout)
+    try:
-    _py3_utf8_stderr = _Py3Utf8Output(sys.stderr)
+        _py3_utf8_stdout = _Py3Utf8Output(sys.stdout)
+        _py3_utf8_stderr = _Py3Utf8Output(sys.stderr)
+    except OSError:
+        # sys.stdout/sys.stderr is not a compatible stdout/stderr object
+        # just use it and hope things go ok
+        _py3_utf8_stdout = sys.stdout
+        _py3_utf8_stderr = sys.stderr
 
     def to_utf8(v):
         """No-op encode to utf-8 for py3"""
@@ -259,10 +266,13 @@ try:
     except AttributeError:
         CERT_ERROR = tuple()
 
-    HTTP_ERRORS = ((HTTPError, URLError, socket.error, ssl.SSLError) +
+    HTTP_ERRORS = (
-                   CERT_ERROR)
+        (HTTPError, URLError, socket.error, ssl.SSLError, BadStatusLine) +
+        CERT_ERROR
+    )
 except ImportError:
-    HTTP_ERRORS = (HTTPError, URLError, socket.error)
+    ssl = None
+    HTTP_ERRORS = (HTTPError, URLError, socket.error, BadStatusLine)
 
 
 class SpeedtestException(Exception):
@@ -278,7 +288,11 @@ class SpeedtestHTTPError(SpeedtestException):
 
 
 class SpeedtestConfigError(SpeedtestException):
-    """Configuration provided is invalid"""
+    """Configuration XML is invalid"""
+
+
+class SpeedtestServersError(SpeedtestException):
+    """Servers XML is invalid"""
 
 
 class ConfigRetrievalError(SpeedtestHTTPError):
@@ -378,13 +392,11 @@ class SpeedtestHTTPConnection(HTTPConnection):
     """
     def __init__(self, *args, **kwargs):
         source_address = kwargs.pop('source_address', None)
-        context = kwargs.pop('context', None)
         timeout = kwargs.pop('timeout', 10)
 
         HTTPConnection.__init__(self, *args, **kwargs)
 
         self.source_address = source_address
-        self._context = context
         self.timeout = timeout
 
     def connect(self):
@@ -409,16 +421,28 @@ if HTTPSConnection:
         """Custom HTTPSConnection to support source_address across
         Python 2.4 - Python 3
         """
+        def __init__(self, *args, **kwargs):
+            source_address = kwargs.pop('source_address', None)
+            timeout = kwargs.pop('timeout', 10)
+
+            HTTPSConnection.__init__(self, *args, **kwargs)
+
+            self.timeout = timeout
+            self.source_address = source_address
+
         def connect(self):
             "Connect to a host on a given (SSL) port."
 
             SpeedtestHTTPConnection.connect(self)
 
             kwargs = {}
-            if hasattr(ssl, 'SSLContext'):
+            if ssl:
-                kwargs['server_hostname'] = self.host
+                if hasattr(ssl, 'SSLContext'):
-
+                    kwargs['server_hostname'] = self.host
-            self.sock = self._context.wrap_socket(self.sock, **kwargs)
+                try:
+                    self.sock = self._context.wrap_socket(self.sock, **kwargs)
+                except AttributeError:
+                    self.sock = ssl.wrap_socket(self.sock, **kwargs)
 
 
 def _build_connection(connection, source_address, timeout, context=None):
@@ -1036,13 +1060,16 @@ class Speedtest(object):
         uh, e = catch_request(request, opener=self._opener)
         if e:
             raise ConfigRetrievalError(e)
-        configxml = []
+        configxml_list = []
 
         stream = get_response_stream(uh)
 
         while 1:
-            configxml.append(stream.read(1024))
+            try:
-            if len(configxml[-1]) == 0:
+                configxml_list.append(stream.read(1024))
+            except (OSError, EOFError):
+                raise ConfigRetrievalError(get_exception())
+            if len(configxml_list[-1]) == 0:
                 break
         stream.close()
         uh.close()
@@ -1050,10 +1077,18 @@ class Speedtest(object):
         if int(uh.code) != 200:
             return None
 
-        printer('Config XML:\n%s' % ''.encode().join(configxml), debug=True)
+        configxml = ''.encode().join(configxml_list)
+
+        printer('Config XML:\n%s' % configxml, debug=True)
 
         try:
-            root = ET.fromstring(''.encode().join(configxml))
+            try:
+                root = ET.fromstring(configxml)
+            except ET.ParseError:
+                e = get_exception()
+                raise SpeedtestConfigError(
+                    'Malformed speedtest.net configuration: %s' % e
+                )
             server_config = root.find('server-config').attrib
             download = root.find('download').attrib
             upload = root.find('upload').attrib
@@ -1061,7 +1096,13 @@ class Speedtest(object):
             client = root.find('client').attrib
 
         except AttributeError:
-            root = DOM.parseString(''.join(configxml))
+            try:
+                root = DOM.parseString(configxml)
+            except ExpatError:
+                e = get_exception()
+                raise SpeedtestConfigError(
+                    'Malformed speedtest.net configuration: %s' % e
+                )
             server_config = get_attributes_by_tag_name(root, 'server-config')
             download = get_attributes_by_tag_name(root, 'download')
             upload = get_attributes_by_tag_name(root, 'upload')
@@ -1110,7 +1151,13 @@ class Speedtest(object):
             'upload_max': upload_count * size_count
         })
 
-        self.lat_lon = (float(client['lat']), float(client['lon']))
+        try:
+            self.lat_lon = (float(client['lat']), float(client['lon']))
+        except ValueError:
+            raise SpeedtestConfigError(
+                'Unknown location: lat=%r lon=%r' %
+                (client.get('lat'), client.get('lon'))
+            )
 
         printer('Config:\n%r' % self.config, debug=True)
 
@@ -1164,10 +1211,13 @@ class Speedtest(object):
 
                 stream = get_response_stream(uh)
 
-                serversxml = []
+                serversxml_list = []
                 while 1:
-                    serversxml.append(stream.read(1024))
+                    try:
-                    if len(serversxml[-1]) == 0:
+                        serversxml_list.append(stream.read(1024))
+                    except (OSError, EOFError):
+                        raise ServersRetrievalError(get_exception())
+                    if len(serversxml_list[-1]) == 0:
                         break
 
                 stream.close()
@@ -1176,15 +1226,28 @@ class Speedtest(object):
                 if int(uh.code) != 200:
                     raise ServersRetrievalError()
 
-                printer('Servers XML:\n%s' % ''.encode().join(serversxml),
+                serversxml = ''.encode().join(serversxml_list)
-                        debug=True)
+
+                printer('Servers XML:\n%s' % serversxml, debug=True)
 
                 try:
                     try:
-                        root = ET.fromstring(''.encode().join(serversxml))
+                        try:
+                            root = ET.fromstring(serversxml)
+                        except ET.ParseError:
+                            e = get_exception()
+                            raise SpeedtestServersError(
+                                'Malformed speedtest.net server list: %s' % e
+                            )
                         elements = root.getiterator('server')
                     except AttributeError:
-                        root = DOM.parseString(''.join(serversxml))
+                        try:
+                            root = DOM.parseString(serversxml)
+                        except ExpatError:
+                            e = get_exception()
+                            raise SpeedtestServersError(
+                                'Malformed speedtest.net server list: %s' % e
+                            )
                         elements = root.getElementsByTagName('server')
                 except (SyntaxError, xml.parsers.expat.ExpatError):
                     raise ServersRetrievalError()
@@ -1521,7 +1584,7 @@ def ctrl_c(shutdown_event):
     """
     def inner(signum, frame):
         shutdown_event.set()
-        print_('\nCancelling...')
+        printer('\nCancelling...', error=True)
         sys.exit(0)
     return inner
 
@@ -1529,14 +1592,14 @@ def ctrl_c(shutdown_event):
 def version():
     """Print the version"""
 
-    print_(__version__)
+    printer(__version__)
     sys.exit(0)
 
 
 def csv_header(delimiter=','):
     """Print the CSV Headers"""
 
-    print_(SpeedtestResults.csv_header(delimiter=delimiter))
+    printer(SpeedtestResults.csv_header(delimiter=delimiter))
     sys.exit(0)
 
 
@@ -1641,13 +1704,16 @@ def validate_optional_args(args):
 
 
 def printer(string, quiet=False, debug=False, error=False, **kwargs):
-    """Helper function to print a string only when not quiet"""
+    """Helper function print a string with various features"""
 
     if debug and not DEBUG:
         return
 
     if debug:
-        out = '\033[1;30mDEBUG: %s\033[0m' % string
+        if sys.stdout.isatty():
+            out = '\033[1;30mDEBUG: %s\033[0m' % string
+        else:
+            out = 'DEBUG: %s' % string
     else:
         out = string
 
@@ -1729,7 +1795,7 @@ def shell():
                 line = ('%(id)5s) %(sponsor)s (%(name)s, %(country)s) '
                         '[%(d)0.2f km]' % server)
                 try:
-                    print_(line)
+                    printer(line)
                 except IOError:
                     e = get_exception()
                     if e.errno != errno.EPIPE:
@@ -1794,19 +1860,20 @@ def shell():
 
     printer('Results:\n%r' % results.dict(), debug=True)
 
+    if not args.simple and args.share:
+        results.share()
+
     if args.simple:
-        print_('Ping: %s ms\nDownload: %0.2f M%s/s\nUpload: %0.2f M%s/s' %
+        printer('Ping: %s ms\nDownload: %0.2f M%s/s\nUpload: %0.2f M%s/s' %
-               (results.ping,
+                (results.ping,
-                (results.download / 1000.0 / 1000.0) / args.units[1],
+                 (results.download / 1000.0 / 1000.0) / args.units[1],
-                args.units[0],
+                 args.units[0],
-                (results.upload / 1000.0 / 1000.0) / args.units[1],
+                 (results.upload / 1000.0 / 1000.0) / args.units[1],
-                args.units[0]))
+                 args.units[0]))
     elif args.csv:
-        print_(results.csv(delimiter=args.csv_delimiter))
+        printer(results.csv(delimiter=args.csv_delimiter))
     elif args.json:
-        if args.share:
+        printer(results.json())
-            results.share()
-        print_(results.json())
 
     if args.share and not machine_format:
         printer('Share results: %s' % results.share())
@@ -1816,7 +1883,7 @@ def main():
     try:
         shell()
     except KeyboardInterrupt:
-        print_('\nCancelling...')
+        printer('\nCancelling...', error=True)
     except (SpeedtestException, SystemExit):
         e = get_exception()
         # Ignore a successful exit, or argparse exit

speedtest_cli.py

@@ -1,34 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# Copyright 2012-2016 Matt Martz
-# All Rights Reserved.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License"); you may
-#    not use this file except in compliance with the License. You may obtain
-#    a copy of the License at
-#
-#         http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-#    License for the specific language governing permissions and limitations
-#    under the License.
-
-import warnings
-
-DEPRECATED_MSG = ('The file speedtest_cli.py has been deprecated in favor of '
-                  'speedtest.py\nand is available for download at:\n\n'
-                  'https://raw.githubusercontent.com/sivel/speedtest-cli/'
-                  'master/speedtest.py')
-
-
-if __name__ == '__main__':
-    raise SystemExit(DEPRECATED_MSG)
-else:
-    try:
-        from speedtest import *
-    except ImportError:
-        raise SystemExit(DEPRECATED_MSG)
-    else:
-        warnings.warn(DEPRECATED_MSG, UserWarning)

tests/scripts/source.py

@@ -1,4 +1,19 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright 2018 Matt Martz
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
 
 import sys
 import subprocess

tox.ini

@@ -2,7 +2,6 @@
 skipsdist=true
 
 [testenv]
-whitelist_externals = bash
 commands =
     {envpython} -V
     {envpython} -m compileall speedtest.py
@@ -18,7 +17,6 @@ commands =
     flake8 speedtest.py
 
 [testenv:pypy]
-whitelist_externals = bash
 commands =
     pypy -V
     pypy -m compileall speedtest.py