Fix docs and deprecate Logger.

Author: tillahoffmann

.gitignore

@@ -44,6 +44,7 @@ nosetests.xml
 coverage.xml
 *,cover
 .hypothesis/
+.pytest_cache/
 
 # Translations
 *.mo

docs/guide.rst

@@ -395,30 +395,6 @@ To make the definition of graphs less verbose, you can also specify the return v
    AssertionError: height must be positive but got -1.800000
 
 
-Logging
--------
-
-No software is complete without the ability to log information for later analysis or monitoring. Pythonflow supports logging through the standard python `logging module <https://docs.python.org/3/library/logging.html>`_ like so.
-
-
-.. testcode::
-
-   import logging
-   import sys
-   logging.basicConfig(stream=sys.stdout)
-
-   with pf.Graph() as graph:
-       logger = pf.Logger()
-       tea_temperature = pf.placeholder('tea_temperature')
-       with pf.control_dependencies([pf.conditional(tea_temperature > 80, logger.warning('the tea is too hot'))]):
-           tea_temperature = pf.identity(tea_temperature)
-
-.. doctest::
-
-   >>> graph(tea_temperature, tea_temperature=85)  # doctest: +SKIP
-   WARNING:root:the tea is too hot
-   85
-
 Profiling and callbacks
 -----------------------
 

pythonflow/operations.py

@@ -20,7 +20,7 @@
 import sys
 
 from .core import opmethod, Operation, func_op
-from .util import _noop_callback
+from .util import _noop_callback, deprecated
 
 
 class placeholder(Operation):  # pylint: disable=C0103,R0903
@@ -220,7 +220,8 @@ def str_format(format_string, *args, **kwargs):
     return format_string.format(*args, **kwargs)
 
 
-class Logger:
+@deprecated
+class Logger:  # pragma: no cover
     """
     Wrapper for a standard python logging channel with the specified `logger_name`.
 

pythonflow/util.py

@@ -16,10 +16,14 @@
 
 import collections
 import contextlib
+import logging
 import math
 import time
 
 
+LOGGER = logging.getLogger(__name__)
+
+
 class lazy_import:  # pylint: disable=invalid-name, too-few-public-methods
     """
     Lazily import the given module.
@@ -116,3 +120,13 @@ def __str__(self):
 @contextlib.contextmanager
 def _noop_callback(*_):
     yield
+
+
+def deprecated(func):  # pragma: no cover
+    """
+    Mark a callable as deprecated.
+    """
+    def _wrapper(*args, **kwargs):
+        LOGGER.warning("%s is deprecated", func)
+        return func(*args, **kwargs)
+    return _wrapper

requirements.txt

@@ -1,7 +1,12 @@
 twine>=1.9.1
-sphinx>=1.7.2
-sphinx_rtd_theme>=0.3.0
 pytest>=3.2.1
 pytest-cov>=2.5.1
 pylint>=1.8.4
 pyzmq>=17.0.0
+
+# Requirements for documentation
+matplotlib>=2.0.0
+scipy
+imageio
+sphinx>=1.7.2
+sphinx_rtd_theme>=0.3.0

setup.py

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 import sys
+import json
 from setuptools import setup, find_packages
 
 if sys.version_info[0] < 3:
@@ -23,21 +24,12 @@
 with open('README.md') as fp:
     long_description = fp.read()
 
+with open('version.json') as fp:
+    kwargs = json.load(fp)
+
 setup(
-    name="pythonflow",
-    description="Dataflow programming for python",
-    version="0.2.0",
-    author="Till Hoffmann",
-    author_email="till@spotify.com",
-    license="License :: OSI Approved :: Apache Software License",
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Programming Language :: Python :: 3",
-        "Topic :: Scientific/Engineering :: Artificial Intelligence",
-        "Topic :: Utilities"
-    ],
-    url="https://github.com/spotify/pythonflow",
     packages=find_packages(),
     long_description=long_description,
     long_description_content_type="text/markdown",
+    **kwargs
 )

tests/test_pythonflow.py

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import io
-import logging
 import os
 import pickle
 import random
@@ -244,21 +242,6 @@ def test_assert_with_value():
         graph(assertion, x=11)
 
 
-@pytest.mark.parametrize('level', ['debug', 'info', 'warning', 'error', 'critical'])
-def test_logger(level):
-    with pf.Graph() as graph:
-        logger = pf.Logger(uuid.uuid4().hex)
-        log1 = logger.log(level, "this is a %s message", "test")
-        log2 = getattr(logger, level)("this is another %s message", "test")
-
-    # Add a handler to the logger
-    stream = io.StringIO()
-    logger.logger.setLevel(logging.DEBUG)
-    logger.logger.addHandler(logging.StreamHandler(stream))
-    graph([log1, log2])
-    assert stream.getvalue() == "this is a test message\nthis is another test message\n"
-
-
 @pytest.mark.parametrize('format_string, args, kwargs', [
     ("hello {}", ["world"], {}),
     ("hello {world}", [], {"world": "universe"}),

version.json

@@ -0,0 +1,15 @@
+{
+    "name": "pythonflow",
+    "description": "Dataflow programming for python",
+    "version": "0.2.0",
+    "author": "Till Hoffmann",
+    "author_email": "till@spotify.com",
+    "license": "License :: OSI Approved :: Apache Software License",
+    "classifiers": [
+        "Development Status :: 3 - Alpha",
+        "Programming Language :: Python :: 3",
+        "Topic :: Scientific/Engineering :: Artificial Intelligence",
+        "Topic :: Utilities"
+    ],
+    "url": "https://github.com/spotify/pythonflow"
+}