WIP: Add lint stage to CI (#586)

* Add lint and test stage
* Add E731 to skip do not assign a lambda expression, use a def in flake8
* Fix indentations
* Fix flake8 W504 line break after binary operator
* Remove unused imports and reorder with isort
* Remove deprecated key sudo
* Add os to remove info warn in travis-ci
* Add isort to tox and CI
* Move flake8 and isort to lint stage with name

Signed-off-by: yzdann <[email protected]>
Co-authored-by: yzdann <[email protected]>

Author: yzdann

.travis.yml

@@ -1,38 +1,54 @@
+os: linux
 dist: xenial
-sudo: false
 cache:
   directories:
     - $HOME/.cache/pip
 
 language: python
 
-matrix:
+jobs:
   include:
-    - python: "2.6"
+    - stage: lint
+      name: flake8_lint
+      script: 
+        - tox -e flake8 
+    - stage: lint
+      name: isort_lint
+      script: 
+        - tox -e isort
+    - stage: test
+      python: "2.6"
       env: TOXENV=py26
       dist: trusty
-    - python: "2.7"
+    - stage: test
+      python: "2.7"
       env: TOXENV=py27
-    - python: "2.7"
+    - stage: test
+      python: "2.7"
       env: TOXENV=py27-nooptionals
-    - python: "3.4"
+    - stage: test
+      python: "3.4"
       env: TOXENV=py34
-    - python: "3.5"
+    - stage: test
+      python: "3.5"
       env: TOXENV=py35
-    - python: "3.6"
+    - stage: test
+      python: "3.6"
       env: TOXENV=py36
-    - python: "3.7"
+    - stage: test
+      python: "3.7"
       env: TOXENV=py37
-      sudo: true
-    - python: "3.8"
+    - stage: test
+      python: "3.8"
       env: TOXENV=py38
-      sudo: true
-    - python: "3.8"
+    - stage: test
+      python: "3.8"
       env: TOXENV=py38-nooptionals
-      sudo: true
-    - python: "pypy"
+    - stage: test
+      python: "pypy"
       env: TOXENV=pypy
-    - python: "pypy3"
+    - stage: test
+      python: "pypy3"
       env: TOXENV=pypy3
 
 install:

prometheus_client/__init__.py

@@ -1,12 +1,9 @@
 #!/usr/bin/python
 
-from . import exposition
-from . import gc_collector
-from . import metrics
-from . import metrics_core
-from . import platform_collector
-from . import process_collector
-from . import registry
+from . import (
+    exposition, gc_collector, metrics, metrics_core, platform_collector,
+    process_collector, registry,
+)
 
 __all__ = ['Counter', 'Gauge', 'Summary', 'Histogram', 'Info', 'Enum']
 

prometheus_client/core.py

@@ -2,8 +2,10 @@
 
 from .metrics import Counter, Enum, Gauge, Histogram, Info, Summary
 from .metrics_core import (
-    CounterMetricFamily, GaugeHistogramMetricFamily, GaugeMetricFamily, HistogramMetricFamily, InfoMetricFamily,
-    Metric, StateSetMetricFamily, SummaryMetricFamily, UnknownMetricFamily, UntypedMetricFamily)
+    CounterMetricFamily, GaugeHistogramMetricFamily, GaugeMetricFamily,
+    HistogramMetricFamily, InfoMetricFamily, Metric, StateSetMetricFamily,
+    SummaryMetricFamily, UnknownMetricFamily, UntypedMetricFamily,
+)
 from .registry import CollectorRegistry, REGISTRY
 from .samples import Exemplar, Sample, Timestamp
 

prometheus_client/exposition.py

@@ -6,24 +6,25 @@
 import socket
 import sys
 import threading
-from wsgiref.simple_server import make_server, WSGIServer, WSGIRequestHandler
+from wsgiref.simple_server import make_server, WSGIRequestHandler, WSGIServer
 
 from .openmetrics import exposition as openmetrics
 from .registry import REGISTRY
 from .utils import floatToGoString
 
 try:
-    from BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
-    from SocketServer import ThreadingMixIn
-    from urllib2 import build_opener, Request, HTTPHandler
     from urllib import quote_plus
+
+    from BaseHTTPServer import BaseHTTPRequestHandler
+    from SocketServer import ThreadingMixIn
+    from urllib2 import build_opener, HTTPHandler, Request
     from urlparse import parse_qs, urlparse
 except ImportError:
     # Python 3
-    from http.server import BaseHTTPRequestHandler, HTTPServer
+    from http.server import BaseHTTPRequestHandler
     from socketserver import ThreadingMixIn
-    from urllib.request import build_opener, Request, HTTPHandler
-    from urllib.parse import quote_plus, parse_qs, urlparse
+    from urllib.parse import parse_qs, quote_plus, urlparse
+    from urllib.request import build_opener, HTTPHandler, Request
 
 CONTENT_TYPE_LATEST = str('text/plain; version=0.0.4; charset=utf-8')
 """Content type of the latest text format"""
@@ -362,7 +363,7 @@ def _use_gateway(method, gateway, job, registry, grouping_key, timeout, handler)
 
 
 def _escape_grouping_key(k, v):
-    if v == "" :
+    if v == "":
         # Per https://github.com/prometheus/pushgateway/pull/346.
         return k + "@base64", "="
     elif '/' in v:
@@ -381,6 +382,6 @@ def instance_ip_grouping_key():
 
 try:
     # Python >3.5 only
-    from .asgi import make_asgi_app
+    from .asgi import make_asgi_app  # noqa
 except:
     pass

prometheus_client/metrics_core.py

@@ -42,12 +42,12 @@ def add_sample(self, name, labels, value, timestamp=None, exemplar=None):
         self.samples.append(Sample(name, labels, value, timestamp, exemplar))
 
     def __eq__(self, other):
-        return (isinstance(other, Metric) and
-                self.name == other.name and
-                self.documentation == other.documentation and
-                self.type == other.type and
-                self.unit == other.unit and
-                self.samples == other.samples)
+        return (isinstance(other, Metric)
+                and self.name == other.name 
+                and self.documentation == other.documentation
+                and self.type == other.type
+                and self.unit == other.unit
+                and self.samples == other.samples)
 
     def __repr__(self):
         return "Metric(%s, %s, %s, %s, %s)" % (
@@ -218,11 +218,11 @@ def add_metric(self, labels, buckets, sum_value, timestamp=None):
             ))
         # +Inf is last and provides the count value.
         self.samples.append(
-                Sample(self.name + '_count', dict(zip(self._labelnames, labels)), buckets[-1][1], timestamp))
+            Sample(self.name + '_count', dict(zip(self._labelnames, labels)), buckets[-1][1], timestamp))
         # Don't iunclude sum if there's negative buckets.
         if float(buckets[0][0]) >= 0 and sum_value is not None:
             self.samples.append(
-                    Sample(self.name + '_sum', dict(zip(self._labelnames, labels)), sum_value, timestamp))
+                Sample(self.name + '_sum', dict(zip(self._labelnames, labels)), sum_value, timestamp))
 
 
 

prometheus_client/mmap_dict.py

@@ -37,7 +37,7 @@ def _read_all_values(data, used=0):
         if encoded_len + pos > used:
             raise RuntimeError('Read beyond file size detected, file is corrupted.')
         pos += 4
-        encoded_key = data[pos : pos + encoded_len]
+        encoded_key = data[pos:pos + encoded_len]
         padded_len = encoded_len + (8 - (encoded_len + 4) % 8)
         pos += padded_len
         value = _unpack_double(data, pos)[0]

prometheus_client/openmetrics/parser.py

@@ -15,6 +15,7 @@
     # Python 3
     import io as StringIO
 
+
 def text_string_to_metric_families(text):
     """Parse Openmetrics text format from a unicode string.
 
@@ -113,8 +114,8 @@ def _parse_timestamp(timestamp):
 
 def _is_character_escaped(s, charpos):
     num_bslashes = 0
-    while (charpos > num_bslashes and
-           s[charpos - 1 - num_bslashes] == '\\'):
+    while (charpos > num_bslashes
+           and s[charpos - 1 - num_bslashes] == '\\'):
         num_bslashes += 1
     return num_bslashes % 2 == 1
 
@@ -560,7 +561,7 @@ def build_metric(name, documentation, typ, unit, samples):
                 raise ValueError("Invalid le label: " + line)
             if (typ == 'summary' and name == sample.name
                     and (not (0 <= float(sample.labels.get('quantile', -1)) <= 1)
-                          or _isUncanonicalNumber(sample.labels['quantile']))):
+                         or _isUncanonicalNumber(sample.labels['quantile']))):
                 raise ValueError("Invalid quantile label: " + line)
 
             g = tuple(sorted(_group_for_sample(sample, name, typ).items()))

prometheus_client/parser.py

@@ -46,8 +46,8 @@ def _replace_escaping(s):
 
 def _is_character_escaped(s, charpos):
     num_bslashes = 0
-    while (charpos > num_bslashes and
-           s[charpos - 1 - num_bslashes] == '\\'):
+    while (charpos > num_bslashes
+           and s[charpos - 1 - num_bslashes] == '\\'):
         num_bslashes += 1
     return num_bslashes % 2 == 1
 
@@ -112,7 +112,7 @@ def _parse_value_and_timestamp(s):
     if not values:
         return float(s), None
     value = float(values[0])
-    timestamp = (float(values[-1])/1000) if len(values) > 1 else None
+    timestamp = (float(values[-1]) / 1000) if len(values) > 1 else None
     return value, timestamp
 
 

prometheus_client/twisted/_exposition.py

@@ -1,7 +1,7 @@
 from __future__ import absolute_import, unicode_literals
 
-from twisted.web.wsgi import WSGIResource
 from twisted.internet import reactor
+from twisted.web.wsgi import WSGIResource
 
 from .. import exposition, REGISTRY
 

setup.py

@@ -1,11 +1,12 @@
-from setuptools import setup
-import sys
 from os import path
+import sys
+
+from setuptools import setup
 
 if sys.version_info >= (2, 7):
     with open(path.join(path.abspath(path.dirname(__file__)), 'README.md')) as f:
         long_description = f.read()
-else: # Assuming we don't run setup in order to publish under python 2.6
+else:  # Assuming we don't run setup in order to publish under python 2.6
     long_description = "NA"