Move basic auth handler into exposition. Update docstring.

Author: rossigee

README.md

@@ -328,7 +328,7 @@ you can use a special handler to set the Authorization header.
 
 ```python
 from prometheus_client import CollectorRegistry, Gauge, push_to_gateway
-from prometheus_client.handlers.basic_auth import handler as basic_auth_handler
+from prometheus_client.exposition import basic_auth_handler
 
 def my_auth_handler(url, method, timeout, headers, data):
     username = 'foobar'

prometheus_client/exposition.py

@@ -8,6 +8,7 @@
 import threading
 from contextlib import closing
 from wsgiref.simple_server import make_server
+import base64
 
 from . import core
 try:
@@ -119,8 +120,10 @@ def write_to_textfile(path, registry):
 
 
 def default_handler(url, method, timeout, headers, data):
+    '''Default handler that implements HTTP/HTTPS connections.
+
+    Used by the push_to_gateway functions. Can be re-used by other handlers.'''
     def handle():
-        '''Default handler that implements HTTP/HTTPS connections.'''
         request = Request(url, data=data)
         request.get_method = lambda: method
         for k, v in headers:
@@ -133,6 +136,23 @@ def handle():
     return handle
 
 
+def basic_auth_handler(url, method, timeout, headers, data, username=None, password=None):
+    '''Handler that implements HTTP/HTTPS connections with Basic Auth.
+
+    Sets auth headers using supplied 'username' and 'password', if set.
+    Used by the push_to_gateway functions. Can be re-used by other handlers.'''
+    def handle():
+        '''Handler that implements HTTP Basic Auth.
+        '''
+        if username is not None and password is not None:
+            auth_value = "{0}:{1}".format(username, password)
+            auth_header = "Basic {0}".format(base64.b64encode(bytes(auth_value)))
+            headers.append(['Authorization', auth_header])
+        default_handler(url, method, timeout, headers, data)()
+
+    return handle
+
+
 def push_to_gateway(gateway, job, registry, grouping_key=None, timeout=None, handler=default_handler):
     '''Push metrics to the given pushgateway.
 

prometheus_client/handlers/__init__.py

@@ -11,7 +11,7 @@
     license = "Apache Software License 2.0",
     keywords = "prometheus monitoring instrumentation client",
     url = "https://github.com/prometheus/client_python",
-    packages=['prometheus_client', 'prometheus_client.bridge', 'prometheus_client.twisted', 'prometheus_client.handlers'],
+    packages=['prometheus_client', 'prometheus_client.bridge', 'prometheus_client.twisted'],
     extras_require={
         'twisted': ['twisted'],
     },

prometheus_client/handlers/basic_auth.py

@@ -13,8 +13,7 @@
 from prometheus_client import CollectorRegistry, generate_latest
 from prometheus_client import push_to_gateway, pushadd_to_gateway, delete_from_gateway
 from prometheus_client import CONTENT_TYPE_LATEST, instance_ip_grouping_key
-from prometheus_client.exposition import default_handler
-from prometheus_client.handlers.basic_auth import handler as basic_auth_handler
+from prometheus_client.exposition import default_handler, basic_auth_handler
 
 try:
     from BaseHTTPServer import BaseHTTPRequestHandler