Merge branch 'release/v2.0.0'

wolph · wolph · commit 117881681a31 · 2016-05-10T14:32:43.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -1,24 +1,25 @@
+sudo: false
 language: python
-
 python:
     - "2.6"
     - "2.7"
-    - "3.2"
-    - "3.3"
     - "3.4"
+    - "3.5"
     - "pypy"
     - "pypy3"
 
 # command to install dependencies
 install:
-    - pip install . --use-mirrors
-    - pip install coveralls --use-mirrors
+    - pip install .
+    - pip install coveralls flake8
 
 # command to run tests
 script:
     - python setup.py nosetests --cover-erase --with-coverage
     - nosetests --with-coverage --cover-min-percentage=100
 
+before_script: flake8 --ignore=W391 statsd tests
+
 after_success:
     - coveralls
 
diff --git a/README.rst b/README.rst
@@ -16,12 +16,16 @@ Introduction
 `statsd` is a client for Etsy's statsd server, a front end/proxy for the
 Graphite stats collection and graphing server.
 
-* Graphite
-    - http://graphite.wikidot.com
-* Statsd
-    - code: https://github.com/etsy/statsd
-    - blog post: http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/
+Links
+-----
 
+ - The source: https://github.com/WoLpH/python-statsd
+ - Project page: https://pypi.python.org/pypi/python-statsd
+ - Reporting bugs: https://github.com/WoLpH/python-statsd/issues
+ - Documentation: http://python-statsd.readthedocs.io/en/latest/
+ - My blog: http://w.wol.ph/
+ - Statsd: https://github.com/etsy/statsd
+ - Graphite: http://graphite.wikidot.com
 
 Install
 -------
diff --git a/docs/conf.py b/docs/conf.py
@@ -63,6 +63,23 @@
 # The full version, including alpha/beta/rc tags.
 release = statsd.__version__
 
+# Monkey patch to disable nonlocal image warning
+import sphinx
+original_warn_mode = sphinx.environment.BuildEnvironment.warn_node
+
+
+def allow_nonlocal_image_warn_node(self, msg, node):
+    if not msg.startswith('nonlocal image URI found:'):
+        original_warn_mode(self, msg, node)
+
+sphinx.environment.BuildEnvironment.warn_node = allow_nonlocal_image_warn_node
+
+suppress_warnings = [
+    'image.nonlocal_uri',
+]
+
+needs_sphinx = '1.4'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
@@ -134,7 +151,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,13 +1,26 @@
 Python Statsd Client
 =========================================
 
+`statsd` is a client for Etsy's statsd server, a front end/proxy for the
+Graphite stats collection and graphing server.
+
+Links
+-----
+
+ - The source: https://github.com/WoLpH/python-statsd
+ - Project page: https://pypi.python.org/pypi/python-statsd
+ - Reporting bugs: https://github.com/WoLpH/python-statsd/issues
+ - Documentation: http://python-statsd.readthedocs.io/en/latest/
+ - My blog: http://w.wol.ph/
+ - Statsd: https://github.com/etsy/statsd
+ - Graphite: http://graphite.wikidot.com
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
    usage
-
    statsd
 
 Indices and tables
diff --git a/setup.cfg b/setup.cfg
@@ -19,3 +19,9 @@ all_files  = 1
 [upload_sphinx]
 upload-dir = docs/_build/html
 
+[bdist_wheel]
+universal = 1
+
+[flake8]
+ignore = W391
+exclude = docs/*,statsd/compat.py
diff --git a/statsd/__init__.py b/statsd/__init__.py
@@ -19,7 +19,7 @@
 ]
 
 __package_name__ = 'python-statsd'
-__version__ = '1.7.2'
+__version__ = '2.0.0'
 __author__ = 'Rick van Hattem'
 __author_email__ = 'Wolph@wol.ph'
 __description__ = (
@@ -28,8 +28,8 @@
 __url__ = 'https://github.com/WoLpH/python-statsd'
 
 
-# The doctests in this package, when run, will try to send data on the wire.  To
-# keep this from happening, we hook into nose's machinery to mock out
+# The doctests in this package, when run, will try to send data on the wire.
+# To keep this from happening, we hook into nose's machinery to mock out
 # `Connection.send` at the beginning of testing this package, and reset it at
 # the end.
 _connection_patch = None
diff --git a/statsd/client.py b/statsd/client.py
@@ -5,12 +5,13 @@
 
 
 class Client(object):
+
     '''Statsd Client Object
 
     :keyword name: The name for this client
     :type name: str
-    :keyword connection: The connection to use, will be automatically created if
-        not given
+    :keyword connection: The connection to use, will be automatically created
+        if not given
     :type connection: :class:`~statsd.connection.Connection`
 
     >>> client = Client('test')
diff --git a/statsd/compat.py b/statsd/compat.py
@@ -1,11 +1,12 @@
-"""
-Compatability library for python2 and python3 support.
-"""
+'''
+Compatibility library for python2 and python3 support.
+'''
 import sys
 import decimal
 
 PY3K = sys.version_info >= (3, 0)
 
+
 def iter_dict(dict_):  # pragma: no cover
     if PY3K:
         return dict_.items()
diff --git a/statsd/gauge.py b/statsd/gauge.py
@@ -4,9 +4,8 @@
 
 
 class Gauge(statsd.Client):
-    '''Class to implement a statsd gauge
 
-    '''
+    'Class to implement a statsd gauge'
 
     def _send(self, subname, value):
         '''Send the data to statsd via self.connection
@@ -98,20 +97,22 @@ def __sub__(self, delta):
         return self
 
     def set(self, subname, value):
-        '''Set the data ignoring the sign, ie set("test", -1) will
-         set "test" exactly to -1 (not decrement it by 1)
-        
-        See
-        https://github.com/etsy/statsd/blob/master/docs/metric_types.md
+        '''
+        Set the data ignoring the sign, ie set("test", -1) will set "test"
+        exactly to -1 (not decrement it by 1)
+
+        See https://github.com/etsy/statsd/blob/master/docs/metric_types.md
         "Adding a sign to the gauge value will change the value, rather
-         than setting it.
-                gaugor:-10|g
-                gaugor:+4|g
-        So if gaugor was 333, those commands would set it to 333 - 10 + 4,
-         or 327.
-        Note:
-        This implies you can't explicitly set a gauge to a negative number
-         without first setting it to zero."
+        than setting it.
+
+            gaugor:-10|g
+            gaugor:+4|g
+
+        So if gaugor was 333, those commands would set it to 333 - 10 + 4, or
+        327.
+
+        Note: This implies you can't explicitly set a gauge to a negative
+        number without first setting it to zero."
 
         :keyword subname: The subname to report the data to (appended to the
             client name)
diff --git a/statsd/timer.py b/statsd/timer.py
@@ -1,11 +1,12 @@
 import contextlib
 import time
-from functools import wraps
+from functools import wraps, partial
 
 import statsd
 
 
 class Timer(statsd.Client):
+
     '''
     Statsd Timer Object
 
@@ -14,11 +15,11 @@ class Timer(statsd.Client):
 
     :keyword name: The name for this timer
     :type name: str
-    :keyword connection: The connection to use, will be automatically created if
-        not given
+    :keyword connection: The connection to use, will be automatically created
+        if not given
     :type connection: :class:`~statsd.connection.Connection`
-    :keyword min_send_threshold: Timings smaller than this will not be sent so -1
-        can be used for all.
+    :keyword min_send_threshold: Timings smaller than this will not be sent so
+        -1 can be used for all.
     :type min_send_threshold: int
 
     >>> timer = Timer('application_name').start()
@@ -127,7 +128,7 @@ def decorate(self, function_or_name):
         if callable(function_or_name):
             return self._decorate(function_or_name.__name__, function_or_name)
         else:
-            return lambda f: self._decorate(function_or_name, f)
+            return partial(self._decorate, function_or_name)
 
     @contextlib.contextmanager
     def time(self, subname=None, class_=None):
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -1,7 +1,9 @@
 import statsd
 from unittest import TestCase
 
+
 class TestClient(TestCase):
+
     def test_average_shortcut(self):
         average = statsd.Client('average').get_average()
         assert isinstance(average, statsd.Average)
diff --git a/tests/test_connection.py b/tests/test_connection.py
@@ -2,10 +2,14 @@
 import statsd
 import unittest
 
+
 class ConnectionException(Exception):
+
     pass
 
+
 class TestConnection(unittest.TestCase):
+
     def test_set_disabled_to_false_by_default(self):
         result = statsd.connection.Connection()
         assert result._disabled is False
diff --git a/tests/test_gauge.py b/tests/test_gauge.py
@@ -13,17 +13,20 @@ def setUp(self):
     def test_send_float(self):
         with mock.patch('statsd.Client') as mock_client:
             self.gauge.send('', 10.5)
-            mock_client._send.assert_called_with(mock.ANY, {'testing': '10.5|g'})
+            mock_client._send.assert_called_with(mock.ANY,
+                                                 {'testing': '10.5|g'})
 
     def test_send_decimal(self):
         with mock.patch('statsd.Client') as mock_client:
             self.gauge.send('', Decimal('6.576'))
-            mock_client._send.assert_called_with(mock.ANY, {'testing': '6.576|g'})
+            mock_client._send.assert_called_with(mock.ANY,
+                                                 {'testing': '6.576|g'})
 
     def test_send_integer(self):
         with mock.patch('statsd.Client') as mock_client:
             self.gauge.send('', 1)
-            mock_client._send.assert_called_with(mock.ANY, {'testing': '1|g'})
+            mock_client._send.assert_called_with(mock.ANY,
+                                                 {'testing': '1|g'})
 
     def test_set(self):
         with mock.patch('statsd.Client') as mock_client:
diff --git a/tests/test_timer.py b/tests/test_timer.py
@@ -5,6 +5,7 @@
 
 
 class TestTimerBase(TestCase):
+
     def tearDown(self):
         self._time_patch.stop()
 
@@ -16,6 +17,7 @@ def get_arg(self, mock_client, key):
 
 
 class TestTimerDecorator(TestTimerBase):
+
     def setUp(self):
         self.timer = statsd.Timer('timer')
 
@@ -149,6 +151,7 @@ def test_timer_intermediate(self, mock_client):
 
 
 class TestTimerZero(TestTimerBase):
+
     def setUp(self):
         # get time.time() to always return the same value so that this test
         # isn't system load dependant.
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,6 @@
 [tox]
-envlist = py26, py27, py34, pypy, pypy3
+envlist = py26, py27, py34, py35, pypy, pypy3, flake8, docs
+skip_missing_interpreters = True
 
 [testenv]
 deps =
@@ -11,3 +12,14 @@ commands =
     python setup.py nosetests --cover-erase --with-coverage
     nosetests --with-coverage --cover-min-percentage=100
 
+[testenv:flake8]
+deps = flake8
+commands = flake8 --ignore=W391 statsd
+
+[testenv:docs]
+deps = sphinx
+basepython=python
+changedir=docs
+commands=
+    sphinx-build -W -b html -d {envtmpdir}/doctrees .  {envtmpdir}/html
+
