Compare commits
25 Commits
master
...
travis-tes
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
eb5c4ddd08 | ||
|
|
d7f9156ddc | ||
|
|
e15a8636ff | ||
|
|
45e4b38ac3 | ||
|
|
9b0e6d75c6 | ||
|
|
b13450e22a | ||
|
|
f5c34eb03c | ||
|
|
bf8164fb1f | ||
|
|
48301deac9 | ||
|
|
afa79f263a | ||
|
|
bdaad9197d | ||
|
|
3bf0036560 | ||
|
|
7df7c56a23 | ||
|
|
fca2006060 | ||
|
|
36d8327b39 | ||
|
|
203da2cd71 | ||
|
|
6f3ba24e92 | ||
|
|
be7d7f6a1c | ||
|
|
5cb3a19cd3 | ||
|
|
d2a46ac897 | ||
|
|
d30a415f12 | ||
|
|
cab2d55c51 | ||
|
|
0614e07eb9 | ||
|
|
b7a3decad9 | ||
|
|
bd390a36ae |
52
.travis.yml
52
.travis.yml
@ -1,8 +1,5 @@
|
||||
language: python
|
||||
|
||||
python:
|
||||
- 2.7
|
||||
|
||||
addons:
|
||||
apt:
|
||||
sources:
|
||||
@ -11,26 +8,45 @@ addons:
|
||||
- python2.4
|
||||
- python2.5
|
||||
- python2.6
|
||||
- pypy
|
||||
- python3.2
|
||||
- python3.3
|
||||
|
||||
env:
|
||||
- TOXENV=py24
|
||||
- TOXENV=py25
|
||||
- TOXENV=py26
|
||||
- TOXENV=py27
|
||||
- TOXENV=py32
|
||||
- TOXENV=py33
|
||||
- TOXENV=py34
|
||||
- TOXENV=py35
|
||||
- TOXENV=pypy
|
||||
- TOXENV=flake8
|
||||
matrix:
|
||||
include:
|
||||
- python: 2.7
|
||||
env: TOXENV=flake8
|
||||
- python: 2.7
|
||||
env: TOXENV=py24
|
||||
- python: 2.7
|
||||
env: TOXENV=py25
|
||||
- python: 2.7
|
||||
env: TOXENV=py26
|
||||
- python: 2.7
|
||||
env: TOXENV=py27
|
||||
- python: 2.7
|
||||
env: TOXENV=py32
|
||||
- python: 2.7
|
||||
env: TOXENV=py33
|
||||
- python: 3.4
|
||||
env: TOXENV=py34
|
||||
- python: 3.5
|
||||
env: TOXENV=py35
|
||||
- python: 3.6
|
||||
env: TOXENV=py36
|
||||
- python: pypy
|
||||
env: TOXENV=pypy
|
||||
|
||||
before_install:
|
||||
- pyenv versions
|
||||
- if [[ $(echo "$TOXENV" | egrep -c "py35") != 0 ]]; then pyenv global system 3.5; fi;
|
||||
|
||||
install:
|
||||
- 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 "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;
|
||||
|
||||
script:
|
||||
- tox
|
||||
- tox
|
||||
|
||||
notifications:
|
||||
email:
|
||||
|
||||
@ -17,7 +17,7 @@ speedtest.net
|
||||
Versions
|
||||
--------
|
||||
|
||||
speedtest-cli works with Python 2.4-3.5
|
||||
speedtest-cli works with Python 2.4-3.6
|
||||
|
||||
.. image:: https://img.shields.io/pypi/pyversions/speedtest-cli.svg
|
||||
:target: https://pypi.python.org/pypi/speedtest-cli/
|
||||
|
||||
1
setup.py
1
setup.py
@ -90,5 +90,6 @@ setup(
|
||||
'Programming Language :: Python :: 3.3',
|
||||
'Programming Language :: Python :: 3.4',
|
||||
'Programming Language :: Python :: 3.5',
|
||||
'Programming Language :: Python :: 3.6',
|
||||
]
|
||||
)
|
||||
|
||||
560
speedtest.py
560
speedtest.py
@ -36,7 +36,7 @@ except ImportError:
|
||||
gzip = None
|
||||
GZIP_BASE = object
|
||||
|
||||
__version__ = '1.0.6'
|
||||
__version__ = '2.0.0a'
|
||||
|
||||
|
||||
class FakeShutdownEvent(object):
|
||||
@ -51,14 +51,9 @@ class FakeShutdownEvent(object):
|
||||
|
||||
|
||||
# Some global variables we use
|
||||
USER_AGENT = None
|
||||
SOURCE = None
|
||||
SHUTDOWN_EVENT = FakeShutdownEvent()
|
||||
SCHEME = 'http'
|
||||
DEBUG = False
|
||||
|
||||
# Used for bound_interface
|
||||
SOCKET_SOCKET = socket.socket
|
||||
_GLOBAL_DEFAULT_TIMEOUT = object()
|
||||
|
||||
# Begin import game to handle Python 2 and Python 3
|
||||
try:
|
||||
@ -79,9 +74,15 @@ except ImportError:
|
||||
ET = None
|
||||
|
||||
try:
|
||||
from urllib2 import urlopen, Request, HTTPError, URLError
|
||||
from urllib2 import (urlopen, Request, HTTPError, URLError,
|
||||
AbstractHTTPHandler, ProxyHandler,
|
||||
HTTPDefaultErrorHandler, HTTPRedirectHandler,
|
||||
HTTPErrorProcessor, OpenerDirector)
|
||||
except ImportError:
|
||||
from urllib.request import urlopen, Request, HTTPError, URLError
|
||||
from urllib.request import (urlopen, Request, HTTPError, URLError,
|
||||
AbstractHTTPHandler, ProxyHandler,
|
||||
HTTPDefaultErrorHandler, HTTPRedirectHandler,
|
||||
HTTPErrorProcessor, OpenerDirector)
|
||||
|
||||
try:
|
||||
from httplib import HTTPConnection
|
||||
@ -124,11 +125,13 @@ try:
|
||||
from argparse import SUPPRESS as ARG_SUPPRESS
|
||||
PARSER_TYPE_INT = int
|
||||
PARSER_TYPE_STR = str
|
||||
PARSER_TYPE_FLOAT = float
|
||||
except ImportError:
|
||||
from optparse import OptionParser as ArgParser
|
||||
from optparse import SUPPRESS_HELP as ARG_SUPPRESS
|
||||
PARSER_TYPE_INT = 'int'
|
||||
PARSER_TYPE_STR = 'string'
|
||||
PARSER_TYPE_FLOAT = 'float'
|
||||
|
||||
try:
|
||||
from cStringIO import StringIO
|
||||
@ -146,24 +149,25 @@ except ImportError:
|
||||
import builtins
|
||||
from io import TextIOWrapper, FileIO
|
||||
|
||||
class _Py3Utf8Stdout(TextIOWrapper):
|
||||
class _Py3Utf8Output(TextIOWrapper):
|
||||
"""UTF-8 encoded wrapper around stdout for py3, to override
|
||||
ASCII stdout
|
||||
"""
|
||||
def __init__(self, **kwargs):
|
||||
buf = FileIO(sys.stdout.fileno(), 'w')
|
||||
super(_Py3Utf8Stdout, self).__init__(
|
||||
def __init__(self, f, **kwargs):
|
||||
buf = FileIO(f.fileno(), 'w')
|
||||
super(_Py3Utf8Output, self).__init__(
|
||||
buf,
|
||||
encoding='utf8',
|
||||
errors='strict'
|
||||
)
|
||||
|
||||
def write(self, s):
|
||||
super(_Py3Utf8Stdout, self).write(s)
|
||||
super(_Py3Utf8Output, self).write(s)
|
||||
self.flush()
|
||||
|
||||
_py3_print = getattr(builtins, 'print')
|
||||
_py3_utf8_stdout = _Py3Utf8Stdout()
|
||||
_py3_utf8_stdout = _Py3Utf8Output(sys.stdout)
|
||||
_py3_utf8_stderr = _Py3Utf8Output(sys.stderr)
|
||||
|
||||
def to_utf8(v):
|
||||
"""No-op encode to utf-8 for py3"""
|
||||
@ -171,7 +175,10 @@ except ImportError:
|
||||
|
||||
def print_(*args, **kwargs):
|
||||
"""Wrapper function for py3 to print, with a utf-8 encoded stdout"""
|
||||
kwargs['file'] = _py3_utf8_stdout
|
||||
if kwargs.get('file') == sys.stderr:
|
||||
kwargs['file'] = _py3_utf8_stderr
|
||||
else:
|
||||
kwargs['file'] = kwargs.get('file', _py3_utf8_stdout)
|
||||
_py3_print(*args, **kwargs)
|
||||
else:
|
||||
del __builtin__
|
||||
@ -188,7 +195,7 @@ else:
|
||||
|
||||
Taken from https://pypi.python.org/pypi/six/
|
||||
|
||||
Modified to set encoding to UTF-8 always
|
||||
Modified to set encoding to UTF-8 always, and to flush after write
|
||||
"""
|
||||
fp = kwargs.pop("file", sys.stdout)
|
||||
if fp is None:
|
||||
@ -207,6 +214,7 @@ else:
|
||||
errors = "strict"
|
||||
data = data.encode(encoding, errors)
|
||||
fp.write(data)
|
||||
fp.flush()
|
||||
want_unicode = False
|
||||
sep = kwargs.pop("sep", None)
|
||||
if sep is not None:
|
||||
@ -320,6 +328,201 @@ class SpeedtestBestServerFailure(SpeedtestException):
|
||||
"""Unable to determine best server"""
|
||||
|
||||
|
||||
class SpeedtestMissingBestServer(SpeedtestException):
|
||||
"""get_best_server not called or not able to determine best server"""
|
||||
|
||||
|
||||
def create_connection(address, timeout=_GLOBAL_DEFAULT_TIMEOUT,
|
||||
source_address=None):
|
||||
"""Connect to *address* and return the socket object.
|
||||
|
||||
Convenience function. Connect to *address* (a 2-tuple ``(host,
|
||||
port)``) and return the socket object. Passing the optional
|
||||
*timeout* parameter will set the timeout on the socket instance
|
||||
before attempting to connect. If no *timeout* is supplied, the
|
||||
global default timeout setting returned by :func:`getdefaulttimeout`
|
||||
is used. If *source_address* is set it must be a tuple of (host, port)
|
||||
for the socket to bind as a source address before making the connection.
|
||||
An host of '' or port 0 tells the OS to use the default.
|
||||
|
||||
Largely vendored from Python 2.7, modified to work with Python 2.4
|
||||
"""
|
||||
|
||||
host, port = address
|
||||
err = None
|
||||
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
|
||||
af, socktype, proto, canonname, sa = res
|
||||
sock = None
|
||||
try:
|
||||
sock = socket.socket(af, socktype, proto)
|
||||
if timeout is not _GLOBAL_DEFAULT_TIMEOUT:
|
||||
sock.settimeout(float(timeout))
|
||||
if source_address:
|
||||
sock.bind(source_address)
|
||||
sock.connect(sa)
|
||||
return sock
|
||||
|
||||
except socket.error:
|
||||
err = get_exception()
|
||||
if sock is not None:
|
||||
sock.close()
|
||||
|
||||
if err is not None:
|
||||
raise err
|
||||
else:
|
||||
raise socket.error("getaddrinfo returns an empty list")
|
||||
|
||||
|
||||
class SpeedtestHTTPConnection(HTTPConnection):
|
||||
"""Custom HTTPConnection to support source_address across
|
||||
Python 2.4 - Python 3
|
||||
"""
|
||||
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):
|
||||
"""Connect to the host and port specified in __init__."""
|
||||
try:
|
||||
self.sock = socket.create_connection(
|
||||
(self.host, self.port),
|
||||
self.timeout,
|
||||
self.source_address
|
||||
)
|
||||
except (AttributeError, TypeError):
|
||||
self.sock = create_connection(
|
||||
(self.host, self.port),
|
||||
self.timeout,
|
||||
self.source_address
|
||||
)
|
||||
|
||||
|
||||
if HTTPSConnection:
|
||||
class SpeedtestHTTPSConnection(HTTPSConnection,
|
||||
SpeedtestHTTPConnection):
|
||||
"""Custom HTTPSConnection to support source_address across
|
||||
Python 2.4 - Python 3
|
||||
"""
|
||||
def connect(self):
|
||||
"Connect to a host on a given (SSL) port."
|
||||
|
||||
SpeedtestHTTPConnection.connect(self)
|
||||
|
||||
kwargs = {}
|
||||
if hasattr(ssl, 'SSLContext'):
|
||||
kwargs['server_hostname'] = self.host
|
||||
|
||||
self.sock = self._context.wrap_socket(self.sock, **kwargs)
|
||||
|
||||
|
||||
def _build_connection(connection, source_address, timeout, context=None):
|
||||
"""Cross Python 2.4 - Python 3 callable to build an ``HTTPConnection`` or
|
||||
``HTTPSConnection`` with the args we need
|
||||
|
||||
Called from ``http(s)_open`` methods of ``SpeedtestHTTPHandler`` or
|
||||
``SpeedtestHTTPSHandler``
|
||||
"""
|
||||
def inner(host, **kwargs):
|
||||
kwargs.update({
|
||||
'source_address': source_address,
|
||||
'timeout': timeout
|
||||
})
|
||||
if context:
|
||||
kwargs['context'] = context
|
||||
return connection(host, **kwargs)
|
||||
return inner
|
||||
|
||||
|
||||
class SpeedtestHTTPHandler(AbstractHTTPHandler):
|
||||
"""Custom ``HTTPHandler`` that can build a ``HTTPConnection`` with the
|
||||
args we need for ``source_address`` and ``timeout``
|
||||
"""
|
||||
def __init__(self, debuglevel=0, source_address=None, timeout=10):
|
||||
AbstractHTTPHandler.__init__(self, debuglevel)
|
||||
self.source_address = source_address
|
||||
self.timeout = timeout
|
||||
|
||||
def http_open(self, req):
|
||||
return self.do_open(
|
||||
_build_connection(
|
||||
SpeedtestHTTPConnection,
|
||||
self.source_address,
|
||||
self.timeout
|
||||
),
|
||||
req
|
||||
)
|
||||
|
||||
http_request = AbstractHTTPHandler.do_request_
|
||||
|
||||
|
||||
class SpeedtestHTTPSHandler(AbstractHTTPHandler):
|
||||
"""Custom ``HTTPSHandler`` that can build a ``HTTPSConnection`` with the
|
||||
args we need for ``source_address`` and ``timeout``
|
||||
"""
|
||||
def __init__(self, debuglevel=0, context=None, source_address=None,
|
||||
timeout=10):
|
||||
AbstractHTTPHandler.__init__(self, debuglevel)
|
||||
self._context = context
|
||||
self.source_address = source_address
|
||||
self.timeout = timeout
|
||||
|
||||
def https_open(self, req):
|
||||
return self.do_open(
|
||||
_build_connection(
|
||||
SpeedtestHTTPSConnection,
|
||||
self.source_address,
|
||||
self.timeout,
|
||||
context=self._context,
|
||||
),
|
||||
req
|
||||
)
|
||||
|
||||
https_request = AbstractHTTPHandler.do_request_
|
||||
|
||||
|
||||
def build_opener(source_address=None, timeout=10):
|
||||
"""Function similar to ``urllib2.build_opener`` that will build
|
||||
an ``OpenerDirector`` with the explicit handlers we want,
|
||||
``source_address`` for binding, ``timeout`` and our custom
|
||||
`User-Agent`
|
||||
"""
|
||||
|
||||
printer('Timeout set to %d' % timeout, debug=True)
|
||||
|
||||
if source_address:
|
||||
source_address_tuple = (source_address, 0)
|
||||
printer('Binding to source address: %r' % (source_address_tuple,),
|
||||
debug=True)
|
||||
else:
|
||||
source_address_tuple = None
|
||||
|
||||
handlers = [
|
||||
ProxyHandler(),
|
||||
SpeedtestHTTPHandler(source_address=source_address_tuple,
|
||||
timeout=timeout),
|
||||
SpeedtestHTTPSHandler(source_address=source_address_tuple,
|
||||
timeout=timeout),
|
||||
HTTPDefaultErrorHandler(),
|
||||
HTTPRedirectHandler(),
|
||||
HTTPErrorProcessor()
|
||||
]
|
||||
|
||||
opener = OpenerDirector()
|
||||
opener.addheaders = [('User-agent', build_user_agent())]
|
||||
|
||||
for handler in handlers:
|
||||
opener.add_handler(handler)
|
||||
|
||||
return opener
|
||||
|
||||
|
||||
class GzipDecodedResponse(GZIP_BASE):
|
||||
"""A file-like object to decode a response encoded with the gzip
|
||||
method, as described in RFC 1952.
|
||||
@ -357,14 +560,6 @@ def get_exception():
|
||||
return sys.exc_info()[1]
|
||||
|
||||
|
||||
def bound_socket(*args, **kwargs):
|
||||
"""Bind socket to a specified source IP address"""
|
||||
|
||||
sock = SOCKET_SOCKET(*args, **kwargs)
|
||||
sock.bind((SOURCE, 0))
|
||||
return sock
|
||||
|
||||
|
||||
def distance(origin, destination):
|
||||
"""Determine distance between 2 sets of [lat,lon] in km"""
|
||||
|
||||
@ -387,10 +582,6 @@ def distance(origin, destination):
|
||||
def build_user_agent():
|
||||
"""Build a Mozilla/5.0 compatible User-Agent string"""
|
||||
|
||||
global USER_AGENT
|
||||
if USER_AGENT:
|
||||
return USER_AGENT
|
||||
|
||||
ua_tuple = (
|
||||
'Mozilla/5.0',
|
||||
'(%s; U; %s; en-us)' % (platform.system(), platform.architecture()[0]),
|
||||
@ -398,26 +589,24 @@ def build_user_agent():
|
||||
'(KHTML, like Gecko)',
|
||||
'speedtest-cli/%s' % __version__
|
||||
)
|
||||
USER_AGENT = ' '.join(ua_tuple)
|
||||
printer(USER_AGENT, debug=True)
|
||||
return USER_AGENT
|
||||
user_agent = ' '.join(ua_tuple)
|
||||
printer('User-Agent: %s' % user_agent, debug=True)
|
||||
return user_agent
|
||||
|
||||
|
||||
def build_request(url, data=None, headers=None, bump=''):
|
||||
def build_request(url, data=None, headers=None, bump='0', secure=False):
|
||||
"""Build a urllib2 request object
|
||||
|
||||
This function automatically adds a User-Agent header to all requests
|
||||
|
||||
"""
|
||||
|
||||
if not USER_AGENT:
|
||||
build_user_agent()
|
||||
|
||||
if not headers:
|
||||
headers = {}
|
||||
|
||||
if url[0] == ':':
|
||||
schemed_url = '%s%s' % (SCHEME, url)
|
||||
scheme = ('http', 'https')[bool(secure)]
|
||||
schemed_url = '%s%s' % (scheme, url)
|
||||
else:
|
||||
schemed_url = url
|
||||
|
||||
@ -432,7 +621,6 @@ def build_request(url, data=None, headers=None, bump=''):
|
||||
bump)
|
||||
|
||||
headers.update({
|
||||
'User-Agent': USER_AGENT,
|
||||
'Cache-Control': 'no-cache',
|
||||
})
|
||||
|
||||
@ -442,14 +630,19 @@ def build_request(url, data=None, headers=None, bump=''):
|
||||
return Request(final_url, data=data, headers=headers)
|
||||
|
||||
|
||||
def catch_request(request):
|
||||
def catch_request(request, opener=None):
|
||||
"""Helper function to catch common exceptions encountered when
|
||||
establishing a connection with a HTTP/HTTPS request
|
||||
|
||||
"""
|
||||
|
||||
if opener:
|
||||
_open = opener.open
|
||||
else:
|
||||
_open = urlopen
|
||||
|
||||
try:
|
||||
uh = urlopen(request)
|
||||
uh = _open(request)
|
||||
return uh, False
|
||||
except HTTP_ERRORS:
|
||||
e = get_exception()
|
||||
@ -505,18 +698,22 @@ def do_nothing(*args, **kwargs):
|
||||
class HTTPDownloader(threading.Thread):
|
||||
"""Thread class for retrieving a URL"""
|
||||
|
||||
def __init__(self, i, request, start, timeout):
|
||||
def __init__(self, i, request, start, timeout, opener=None):
|
||||
threading.Thread.__init__(self)
|
||||
self.request = request
|
||||
self.result = [0]
|
||||
self.starttime = start
|
||||
self.timeout = timeout
|
||||
self.i = i
|
||||
if opener:
|
||||
self._opener = opener.open
|
||||
else:
|
||||
self._opener = urlopen
|
||||
|
||||
def run(self):
|
||||
try:
|
||||
if (timeit.default_timer() - self.starttime) <= self.timeout:
|
||||
f = urlopen(self.request)
|
||||
f = self._opener(self.request)
|
||||
while (not SHUTDOWN_EVENT.isSet() and
|
||||
(timeit.default_timer() - self.starttime) <=
|
||||
self.timeout):
|
||||
@ -546,11 +743,17 @@ class HTTPUploaderData(object):
|
||||
chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
|
||||
multiplier = int(round(int(self.length) / 36.0))
|
||||
IO = BytesIO or StringIO
|
||||
self._data = IO(
|
||||
('content1=%s' %
|
||||
(chars * multiplier)[0:int(self.length) - 9]
|
||||
).encode()
|
||||
)
|
||||
try:
|
||||
self._data = IO(
|
||||
('content1=%s' %
|
||||
(chars * multiplier)[0:int(self.length) - 9]
|
||||
).encode()
|
||||
)
|
||||
except MemoryError:
|
||||
raise SpeedtestCLIError(
|
||||
'Insufficient memory to pre-allocate upload data. Please '
|
||||
'use --no-pre-allocate'
|
||||
)
|
||||
|
||||
@property
|
||||
def data(self):
|
||||
@ -574,7 +777,7 @@ class HTTPUploaderData(object):
|
||||
class HTTPUploader(threading.Thread):
|
||||
"""Thread class for putting a URL"""
|
||||
|
||||
def __init__(self, i, request, start, size, timeout):
|
||||
def __init__(self, i, request, start, size, timeout, opener=None):
|
||||
threading.Thread.__init__(self)
|
||||
self.request = request
|
||||
self.request.data.start = self.starttime = start
|
||||
@ -583,20 +786,25 @@ class HTTPUploader(threading.Thread):
|
||||
self.timeout = timeout
|
||||
self.i = i
|
||||
|
||||
if opener:
|
||||
self._opener = opener.open
|
||||
else:
|
||||
self._opener = urlopen
|
||||
|
||||
def run(self):
|
||||
request = self.request
|
||||
try:
|
||||
if ((timeit.default_timer() - self.starttime) <= self.timeout and
|
||||
not SHUTDOWN_EVENT.isSet()):
|
||||
try:
|
||||
f = urlopen(request)
|
||||
f = self._opener(request)
|
||||
except TypeError:
|
||||
# PY24 expects a string or buffer
|
||||
# This also causes issues with Ctrl-C, but we will concede
|
||||
# for the moment that Ctrl-C on PY24 isn't immediate
|
||||
request = build_request(self.request.get_full_url(),
|
||||
data=request.data.read(self.size))
|
||||
f = urlopen(request)
|
||||
f = self._opener(request)
|
||||
f.read(11)
|
||||
f.close()
|
||||
self.result = sum(self.request.data.total)
|
||||
@ -619,7 +827,8 @@ class SpeedtestResults(object):
|
||||
to get a share results image link.
|
||||
"""
|
||||
|
||||
def __init__(self, download=0, upload=0, ping=0, server=None):
|
||||
def __init__(self, download=0, upload=0, ping=0, server=None, client=None,
|
||||
opener=None, secure=False):
|
||||
self.download = download
|
||||
self.upload = upload
|
||||
self.ping = ping
|
||||
@ -627,11 +836,20 @@ class SpeedtestResults(object):
|
||||
self.server = {}
|
||||
else:
|
||||
self.server = server
|
||||
self.client = client or {}
|
||||
|
||||
self._share = None
|
||||
self.timestamp = '%sZ' % datetime.datetime.utcnow().isoformat()
|
||||
self.bytes_received = 0
|
||||
self.bytes_sent = 0
|
||||
|
||||
if opener:
|
||||
self._opener = opener
|
||||
else:
|
||||
self._opener = build_opener()
|
||||
|
||||
self._secure = secure
|
||||
|
||||
def __repr__(self):
|
||||
return repr(self.dict())
|
||||
|
||||
@ -673,8 +891,8 @@ class SpeedtestResults(object):
|
||||
headers = {'Referer': 'http://c.speedtest.net/flash/speedtest.swf'}
|
||||
request = build_request('://www.speedtest.net/api/api.php',
|
||||
data='&'.join(api_data).encode(),
|
||||
headers=headers)
|
||||
f, e = catch_request(request)
|
||||
headers=headers, secure=self._secure)
|
||||
f, e = catch_request(request, opener=self._opener)
|
||||
if e:
|
||||
raise ShareResultsConnectFailure(e)
|
||||
|
||||
@ -708,8 +926,20 @@ class SpeedtestResults(object):
|
||||
'bytes_sent': self.bytes_sent,
|
||||
'bytes_received': self.bytes_received,
|
||||
'share': self._share,
|
||||
'client': self.client,
|
||||
}
|
||||
|
||||
@staticmethod
|
||||
def csv_header(delimiter=','):
|
||||
"""Return CSV Headers"""
|
||||
|
||||
row = ['Server ID', 'Sponsor', 'Server Name', 'Timestamp', 'Distance',
|
||||
'Ping', 'Download', 'Upload', 'Share', 'IP Address']
|
||||
out = StringIO()
|
||||
writer = csv.writer(out, delimiter=delimiter, lineterminator='')
|
||||
writer.writerow([to_utf8(v) for v in row])
|
||||
return out.getvalue()
|
||||
|
||||
def csv(self, delimiter=','):
|
||||
"""Return data in CSV format"""
|
||||
|
||||
@ -719,7 +949,7 @@ class SpeedtestResults(object):
|
||||
row = [data['server']['id'], data['server']['sponsor'],
|
||||
data['server']['name'], data['timestamp'],
|
||||
data['server']['d'], data['ping'], data['download'],
|
||||
data['upload']]
|
||||
data['upload'], self._share or '', self.client['ip']]
|
||||
writer.writerow([to_utf8(v) for v in row])
|
||||
return out.getvalue()
|
||||
|
||||
@ -738,17 +968,38 @@ class SpeedtestResults(object):
|
||||
class Speedtest(object):
|
||||
"""Class for performing standard speedtest.net testing operations"""
|
||||
|
||||
def __init__(self, config=None):
|
||||
def __init__(self, config=None, source_address=None, timeout=10,
|
||||
secure=False):
|
||||
self.config = {}
|
||||
|
||||
self._source_address = source_address
|
||||
self._timeout = timeout
|
||||
self._opener = build_opener(source_address, timeout)
|
||||
|
||||
self._secure = secure
|
||||
|
||||
self.get_config()
|
||||
if config is not None:
|
||||
self.config.update(config)
|
||||
|
||||
self.servers = {}
|
||||
self.closest = []
|
||||
self.best = {}
|
||||
self._best = {}
|
||||
|
||||
self.results = SpeedtestResults()
|
||||
self.results = SpeedtestResults(
|
||||
client=self.config['client'],
|
||||
opener=self._opener,
|
||||
secure=secure,
|
||||
)
|
||||
|
||||
@property
|
||||
def best(self):
|
||||
if not self._best:
|
||||
raise SpeedtestMissingBestServer(
|
||||
'get_best_server not called or not able to determine best '
|
||||
'server'
|
||||
)
|
||||
return self._best
|
||||
|
||||
def get_config(self):
|
||||
"""Download the speedtest.net configuration and return only the data
|
||||
@ -759,8 +1010,8 @@ class Speedtest(object):
|
||||
if gzip:
|
||||
headers['Accept-Encoding'] = 'gzip'
|
||||
request = build_request('://www.speedtest.net/speedtest-config.php',
|
||||
headers=headers)
|
||||
uh, e = catch_request(request)
|
||||
headers=headers, secure=self._secure)
|
||||
uh, e = catch_request(request, opener=self._opener)
|
||||
if e:
|
||||
raise ConfigRetrievalError(e)
|
||||
configxml = []
|
||||
@ -777,7 +1028,7 @@ class Speedtest(object):
|
||||
if int(uh.code) != 200:
|
||||
return None
|
||||
|
||||
printer(''.encode().join(configxml), debug=True)
|
||||
printer('Config XML:\n%s' % ''.encode().join(configxml), debug=True)
|
||||
|
||||
try:
|
||||
root = ET.fromstring(''.encode().join(configxml))
|
||||
@ -839,25 +1090,30 @@ class Speedtest(object):
|
||||
|
||||
self.lat_lon = (float(client['lat']), float(client['lon']))
|
||||
|
||||
printer(self.config, debug=True)
|
||||
printer('Config:\n%r' % self.config, debug=True)
|
||||
|
||||
return self.config
|
||||
|
||||
def get_servers(self, servers=None):
|
||||
def get_servers(self, servers=None, exclude=None):
|
||||
"""Retrieve a the list of speedtest.net servers, optionally filtered
|
||||
to servers matching those specified in the ``servers`` argument
|
||||
"""
|
||||
if servers is None:
|
||||
servers = []
|
||||
|
||||
if exclude is None:
|
||||
exclude = []
|
||||
|
||||
self.servers.clear()
|
||||
|
||||
for i, s in enumerate(servers):
|
||||
try:
|
||||
servers[i] = int(s)
|
||||
except ValueError:
|
||||
raise InvalidServerIDType('%s is an invalid server type, must '
|
||||
'be int' % s)
|
||||
for server_list in (servers, exclude):
|
||||
for i, s in enumerate(server_list):
|
||||
try:
|
||||
server_list[i] = int(s)
|
||||
except ValueError:
|
||||
raise InvalidServerIDType(
|
||||
'%s is an invalid server type, must be int' % s
|
||||
)
|
||||
|
||||
urls = [
|
||||
'://www.speedtest.net/speedtest-servers-static.php',
|
||||
@ -873,11 +1129,13 @@ class Speedtest(object):
|
||||
errors = []
|
||||
for url in urls:
|
||||
try:
|
||||
request = build_request('%s?threads=%s' %
|
||||
(url,
|
||||
self.config['threads']['download']),
|
||||
headers=headers)
|
||||
uh, e = catch_request(request)
|
||||
request = build_request(
|
||||
'%s?threads=%s' % (url,
|
||||
self.config['threads']['download']),
|
||||
headers=headers,
|
||||
secure=self._secure
|
||||
)
|
||||
uh, e = catch_request(request, opener=self._opener)
|
||||
if e:
|
||||
errors.append('%s' % e)
|
||||
raise ServersRetrievalError()
|
||||
@ -896,7 +1154,8 @@ class Speedtest(object):
|
||||
if int(uh.code) != 200:
|
||||
raise ServersRetrievalError()
|
||||
|
||||
printer(''.encode().join(serversxml), debug=True)
|
||||
printer('Servers XML:\n%s' % ''.encode().join(serversxml),
|
||||
debug=True)
|
||||
|
||||
try:
|
||||
try:
|
||||
@ -917,14 +1176,15 @@ class Speedtest(object):
|
||||
if servers and int(attrib.get('id')) not in servers:
|
||||
continue
|
||||
|
||||
if int(attrib.get('id')) in self.config['ignore_servers']:
|
||||
if (int(attrib.get('id')) in self.config['ignore_servers']
|
||||
or int(attrib.get('id')) in exclude):
|
||||
continue
|
||||
|
||||
try:
|
||||
d = distance(self.lat_lon,
|
||||
(float(attrib.get('lat')),
|
||||
float(attrib.get('lon'))))
|
||||
except:
|
||||
except Exception:
|
||||
continue
|
||||
|
||||
attrib['d'] = d
|
||||
@ -934,14 +1194,12 @@ class Speedtest(object):
|
||||
except KeyError:
|
||||
self.servers[d] = [attrib]
|
||||
|
||||
printer(''.encode().join(serversxml), debug=True)
|
||||
|
||||
break
|
||||
|
||||
except ServersRetrievalError:
|
||||
continue
|
||||
|
||||
if servers and not self.servers:
|
||||
if (servers or exclude) and not self.servers:
|
||||
raise NoMatchedServers()
|
||||
|
||||
return self.servers
|
||||
@ -960,7 +1218,7 @@ class Speedtest(object):
|
||||
url = server
|
||||
|
||||
request = build_request(url)
|
||||
uh, e = catch_request(request)
|
||||
uh, e = catch_request(request, opener=self._opener)
|
||||
if e:
|
||||
raise SpeedtestMiniConnectFailure('Failed to connect to %s' %
|
||||
server)
|
||||
@ -973,8 +1231,10 @@ class Speedtest(object):
|
||||
if not extension:
|
||||
for ext in ['php', 'asp', 'aspx', 'jsp']:
|
||||
try:
|
||||
f = urlopen('%s/speedtest/upload.%s' % (url, ext))
|
||||
except:
|
||||
f = self._opener.open(
|
||||
'%s/speedtest/upload.%s' % (url, ext)
|
||||
)
|
||||
except Exception:
|
||||
pass
|
||||
else:
|
||||
data = f.read().strip().decode()
|
||||
@ -1015,7 +1275,7 @@ class Speedtest(object):
|
||||
continue
|
||||
break
|
||||
|
||||
printer(self.closest, debug=True)
|
||||
printer('Closest Servers:\n%r' % self.closest, debug=True)
|
||||
return self.closest
|
||||
|
||||
def get_best_server(self, servers=None):
|
||||
@ -1028,26 +1288,44 @@ class Speedtest(object):
|
||||
servers = self.get_closest_servers()
|
||||
servers = self.closest
|
||||
|
||||
if self._source_address:
|
||||
source_address_tuple = (self._source_address, 0)
|
||||
else:
|
||||
source_address_tuple = None
|
||||
|
||||
user_agent = build_user_agent()
|
||||
|
||||
results = {}
|
||||
for server in servers:
|
||||
cum = []
|
||||
url = os.path.dirname(server['url'])
|
||||
urlparts = urlparse('%s/latency.txt' % url)
|
||||
printer('%s %s/latency.txt' % ('GET', url), debug=True)
|
||||
for _ in range(0, 3):
|
||||
stamp = int(timeit.time.time() * 1000)
|
||||
latency_url = '%s/latency.txt?x=%s' % (url, stamp)
|
||||
for i in range(0, 3):
|
||||
this_latency_url = '%s.%s' % (latency_url, i)
|
||||
printer('%s %s' % ('GET', this_latency_url),
|
||||
debug=True)
|
||||
urlparts = urlparse(latency_url)
|
||||
try:
|
||||
if urlparts[0] == 'https':
|
||||
h = HTTPSConnection(urlparts[1])
|
||||
h = SpeedtestHTTPSConnection(
|
||||
urlparts[1],
|
||||
source_address=source_address_tuple
|
||||
)
|
||||
else:
|
||||
h = HTTPConnection(urlparts[1])
|
||||
headers = {'User-Agent': USER_AGENT}
|
||||
h = SpeedtestHTTPConnection(
|
||||
urlparts[1],
|
||||
source_address=source_address_tuple
|
||||
)
|
||||
headers = {'User-Agent': user_agent}
|
||||
path = '%s?%s' % (urlparts[2], urlparts[4])
|
||||
start = timeit.default_timer()
|
||||
h.request("GET", urlparts[2], headers=headers)
|
||||
h.request("GET", path, headers=headers)
|
||||
r = h.getresponse()
|
||||
total = (timeit.default_timer() - start)
|
||||
except HTTP_ERRORS:
|
||||
e = get_exception()
|
||||
printer('%r' % e, debug=True)
|
||||
printer('ERROR: %r' % e, debug=True)
|
||||
cum.append(3600)
|
||||
continue
|
||||
|
||||
@ -1072,8 +1350,8 @@ class Speedtest(object):
|
||||
self.results.ping = fastest
|
||||
self.results.server = best
|
||||
|
||||
self.best.update(best)
|
||||
printer(best, debug=True)
|
||||
self._best.update(best)
|
||||
printer('Best Server:\n%r' % best, debug=True)
|
||||
return best
|
||||
|
||||
def download(self, callback=do_nothing):
|
||||
@ -1088,12 +1366,15 @@ class Speedtest(object):
|
||||
request_count = len(urls)
|
||||
requests = []
|
||||
for i, url in enumerate(urls):
|
||||
requests.append(build_request(url, bump=i))
|
||||
requests.append(
|
||||
build_request(url, bump=i, secure=self._secure)
|
||||
)
|
||||
|
||||
def producer(q, requests, request_count):
|
||||
for i, request in enumerate(requests):
|
||||
thread = HTTPDownloader(i, request, start,
|
||||
self.config['length']['download'])
|
||||
self.config['length']['download'],
|
||||
opener=self._opener)
|
||||
thread.start()
|
||||
q.put(thread, True)
|
||||
callback(i, request_count, start=True)
|
||||
@ -1151,7 +1432,7 @@ class Speedtest(object):
|
||||
data.pre_allocate()
|
||||
requests.append(
|
||||
(
|
||||
build_request(self.best['url'], data),
|
||||
build_request(self.best['url'], data, secure=self._secure),
|
||||
size
|
||||
)
|
||||
)
|
||||
@ -1159,7 +1440,8 @@ class Speedtest(object):
|
||||
def producer(q, requests, request_count):
|
||||
for i, request in enumerate(requests[:request_count]):
|
||||
thread = HTTPUploader(i, request[0], start, request[1],
|
||||
self.config['length']['upload'])
|
||||
self.config['length']['upload'],
|
||||
opener=self._opener)
|
||||
thread.start()
|
||||
q.put(thread, True)
|
||||
callback(i, request_count, start=True)
|
||||
@ -1212,11 +1494,10 @@ def version():
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
def csv_header():
|
||||
def csv_header(delimiter=','):
|
||||
"""Print the CSV Headers"""
|
||||
|
||||
print_('Server ID,Sponsor,Server Name,Timestamp,Distance,Ping,Download,'
|
||||
'Upload')
|
||||
print_(SpeedtestResults.csv_header(delimiter=delimiter))
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
@ -1269,11 +1550,15 @@ def parse_args():
|
||||
parser.add_argument('--list', action='store_true',
|
||||
help='Display a list of speedtest.net servers '
|
||||
'sorted by distance')
|
||||
parser.add_argument('--server', help='Specify a server ID to test against',
|
||||
type=PARSER_TYPE_INT)
|
||||
parser.add_argument('--server', type=PARSER_TYPE_INT, action='append',
|
||||
help='Specify a server ID to test against. Can be '
|
||||
'supplied multiple times')
|
||||
parser.add_argument('--exclude', type=PARSER_TYPE_INT, action='append',
|
||||
help='Exclude a server from selection. Can be '
|
||||
'supplied multiple times')
|
||||
parser.add_argument('--mini', help='URL of the Speedtest Mini server')
|
||||
parser.add_argument('--source', help='Source IP address to bind to')
|
||||
parser.add_argument('--timeout', default=10, type=PARSER_TYPE_INT,
|
||||
parser.add_argument('--timeout', default=10, type=PARSER_TYPE_FLOAT,
|
||||
help='HTTP timeout in seconds. Default 10')
|
||||
parser.add_argument('--secure', action='store_true',
|
||||
help='Use HTTPS instead of HTTP when communicating '
|
||||
@ -1316,7 +1601,7 @@ def validate_optional_args(args):
|
||||
'unavailable' % (info[0], arg))
|
||||
|
||||
|
||||
def printer(string, quiet=False, debug=False, **kwargs):
|
||||
def printer(string, quiet=False, debug=False, error=False, **kwargs):
|
||||
"""Helper function to print a string only when not quiet"""
|
||||
|
||||
if debug and not DEBUG:
|
||||
@ -1327,6 +1612,9 @@ def printer(string, quiet=False, debug=False, **kwargs):
|
||||
else:
|
||||
out = string
|
||||
|
||||
if error:
|
||||
kwargs['file'] = sys.stderr
|
||||
|
||||
if not quiet:
|
||||
print_(out, **kwargs)
|
||||
|
||||
@ -1334,7 +1622,7 @@ def printer(string, quiet=False, debug=False, **kwargs):
|
||||
def shell():
|
||||
"""Run the full speedtest.net test"""
|
||||
|
||||
global SHUTDOWN_EVENT, SOURCE, SCHEME, DEBUG
|
||||
global SHUTDOWN_EVENT, DEBUG
|
||||
SHUTDOWN_EVENT = threading.Event()
|
||||
|
||||
signal.signal(signal.SIGINT, ctrl_c)
|
||||
@ -1349,33 +1637,20 @@ def shell():
|
||||
raise SpeedtestCLIError('Cannot supply both --no-download and '
|
||||
'--no-upload')
|
||||
|
||||
if args.csv_header:
|
||||
csv_header()
|
||||
|
||||
if len(args.csv_delimiter) != 1:
|
||||
raise SpeedtestCLIError('--csv-delimiter must be a single character')
|
||||
|
||||
if args.csv_header:
|
||||
csv_header(args.csv_delimiter)
|
||||
|
||||
validate_optional_args(args)
|
||||
|
||||
socket.setdefaulttimeout(args.timeout)
|
||||
|
||||
# If specified bind to a specific IP address
|
||||
if args.source:
|
||||
SOURCE = args.source
|
||||
socket.socket = bound_socket
|
||||
|
||||
if args.secure:
|
||||
SCHEME = 'https'
|
||||
|
||||
debug = getattr(args, 'debug', False)
|
||||
if debug == 'SUPPRESSHELP':
|
||||
debug = False
|
||||
if debug:
|
||||
DEBUG = True
|
||||
|
||||
# Pre-cache the user agent string
|
||||
build_user_agent()
|
||||
|
||||
if args.simple or args.csv or args.json:
|
||||
quiet = True
|
||||
else:
|
||||
@ -1394,16 +1669,20 @@ def shell():
|
||||
|
||||
printer('Retrieving speedtest.net configuration...', quiet)
|
||||
try:
|
||||
speedtest = Speedtest()
|
||||
except (ConfigRetrievalError, HTTP_ERRORS):
|
||||
printer('Cannot retrieve speedtest configuration')
|
||||
speedtest = Speedtest(
|
||||
source_address=args.source,
|
||||
timeout=args.timeout,
|
||||
secure=args.secure
|
||||
)
|
||||
except (ConfigRetrievalError,) + HTTP_ERRORS:
|
||||
printer('Cannot retrieve speedtest configuration', error=True)
|
||||
raise SpeedtestCLIError(get_exception())
|
||||
|
||||
if args.list:
|
||||
try:
|
||||
speedtest.get_servers()
|
||||
except (ServersRetrievalError, HTTP_ERRORS):
|
||||
print_('Cannot retrieve speedtest server list')
|
||||
except (ServersRetrievalError,) + HTTP_ERRORS:
|
||||
printer('Cannot retrieve speedtest server list', error=True)
|
||||
raise SpeedtestCLIError(get_exception())
|
||||
|
||||
for _, servers in sorted(speedtest.servers.items()):
|
||||
@ -1418,28 +1697,31 @@ def shell():
|
||||
raise
|
||||
sys.exit(0)
|
||||
|
||||
# Set a filter of servers to retrieve
|
||||
servers = []
|
||||
if args.server:
|
||||
servers.append(args.server)
|
||||
|
||||
printer('Testing from %(isp)s (%(ip)s)...' % speedtest.config['client'],
|
||||
quiet)
|
||||
|
||||
if not args.mini:
|
||||
printer('Retrieving speedtest.net server list...', quiet)
|
||||
try:
|
||||
speedtest.get_servers(servers)
|
||||
speedtest.get_servers(servers=args.server, exclude=args.exclude)
|
||||
except NoMatchedServers:
|
||||
raise SpeedtestCLIError('No matched servers: %s' % args.server)
|
||||
except (ServersRetrievalError, HTTP_ERRORS):
|
||||
print_('Cannot retrieve speedtest server list')
|
||||
raise SpeedtestCLIError(
|
||||
'No matched servers: %s' %
|
||||
', '.join('%s' % s for s in args.server)
|
||||
)
|
||||
except (ServersRetrievalError,) + HTTP_ERRORS:
|
||||
printer('Cannot retrieve speedtest server list', error=True)
|
||||
raise SpeedtestCLIError(get_exception())
|
||||
except InvalidServerIDType:
|
||||
raise SpeedtestCLIError('%s is an invalid server type, must '
|
||||
'be an int' % args.server)
|
||||
raise SpeedtestCLIError(
|
||||
'%s is an invalid server type, must '
|
||||
'be an int' % ', '.join('%s' % s for s in args.server)
|
||||
)
|
||||
|
||||
printer('Selecting best server based on ping...', quiet)
|
||||
if args.server and len(args.server) == 1:
|
||||
printer('Retrieving information for the selected server...', quiet)
|
||||
else:
|
||||
printer('Selecting best server based on ping...', quiet)
|
||||
speedtest.get_best_server()
|
||||
elif args.mini:
|
||||
speedtest.get_best_server(speedtest.set_mini_server(args.mini))
|
||||
@ -1471,6 +1753,8 @@ def shell():
|
||||
else:
|
||||
printer('Skipping upload test')
|
||||
|
||||
printer('Results:\n%r' % results.dict(), debug=True)
|
||||
|
||||
if args.simple:
|
||||
print_('Ping: %s ms\nDownload: %0.2f M%s/s\nUpload: %0.2f M%s/s' %
|
||||
(results.ping,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user