Document public functions with __all__

Also, add missing revision sniffer for version-info.txt

TODO.rst

@@ -0,0 +1,4 @@
+
+* expose @private request decorator to users
+* raven integration
+* pipeline statsd per request

talisker/endpoints.py

@@ -32,6 +32,9 @@
 from talisker import revision
 
 
+__all__ = []
+
+
 class TestException(Exception):
     pass
 

talisker/gunicorn.py

@@ -36,7 +36,11 @@
 from . import statsd
 
 
-__all__ = ['access_log_format', 'logger_class']
+__all__ = [
+    'access_log_format',
+    'logger_class',
+    'run',
+]
 
 # settings for gunicorn when in development
 DEVEL_SETTINGS = {

talisker/logs.py

@@ -31,6 +31,12 @@
 
 from .request_context import request_context
 
+__all__ = [
+    'configure',
+    'configure_logging',
+    'configure_test_logging',
+    'extra_logging',
+]
 
 _logging_configured = False
 

talisker/request_id.py

@@ -30,6 +30,15 @@
 from .request_context import request_context, cleanup
 from .logs import set_logging_context
 
+
+__all__ = [
+    'HEADER',
+    'get',
+    'set',
+    'context',
+    'decorator',
+    ]
+
 HEADER = 'X-Request-Id'
 
 

talisker/requests.py

@@ -33,6 +33,12 @@
 from .util import parse_url
 from . import request_id
 
+__all__ = [
+    'HEADER'
+    'get_session',
+    'configure',
+    'enable_requests_logging',
+    ]
 
 HEADER = to_native_string(request_id.HEADER)
 storage = threading.local()

talisker/revision.py

@@ -20,11 +20,21 @@
 revision = None
 http_safe_revision = None
 
+__all__ = [
+    'get',
+    'set',
+    'header',
+    ]
 
 def _run(args):
     return subprocess.check_output(args, stderr=subprocess.PIPE)
 
 
+def version_info_txt():
+    with open('version-info.txt', 'rb') as f:
+        return f.read()
+
+
 def git():
     return _run(['git', 'rev-parse', 'HEAD'])
 
@@ -47,6 +57,7 @@ def setup_py():
 
 
 revision_funcs = [
+    version_info_txt,
     git,
     bzr,
     bzr_version_info,

talisker/statsd.py

@@ -27,6 +27,7 @@
 from urllib.parse import urlparse, parse_qs
 from statsd import StatsClient, defaults
 
+__all__ = ['get_client']
 
 _client = None
 

talisker/wsgi.py

@@ -31,6 +31,12 @@
 from . import revision
 
 
+__all__ = [
+    'set_environ',
+    'set_headers',
+    'wrap'
+    ]
+
 def set_environ(app, **kwargs):
     def middleware(environ, start_response):
         for key, value in kwargs.items():

tests/test_revision.py

@@ -97,5 +97,14 @@ def test_bzr_version_info_py2(monkeypatch):
     vinfo = run(['bzr', 'version-info', '--format=python'])
     with open('versioninfo.py', 'wb') as f:
         f.write(vinfo)
-    rev = revision.bzr_version_info()
-    assert rev.strip() == '1'
+    rev = revision.load_revision()
+    assert rev == '1'
+
+
+def test_version_info(monkeypatch):
+    dir = tempfile.mkdtemp()
+    monkeypatch.chdir(dir)
+    with open('version-info.txt', 'wb') as f:
+        f.write(b'1\n')
+    rev = revision.load_revision()
+    assert rev == '1'