deprecate EventsInDatasetReader

alphatwirl · Mar 4, 2018 · c3a7d40 · c3a7d40
1 parent 8cad31d
commit c3a7d40
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/alphatwirl/loop/EventsInDatasetReader.py b/alphatwirl/loop/EventsInDatasetReader.py
@@ -2,8 +2,10 @@
 import copy
 
 from .EventLoop import EventLoop
+from alphatwirl.misc.deprecation import atdeprecated
 
 ##__________________________________________________________________||
+@atdeprecated(msg='use EventDatasetReader instead.')
 class EventsInDatasetReader(object):
     """This class manages objects involved in reading events in data sets.
 

diff --git a/tests/unit/loop/test_EventsInDatasetReader.py b/tests/unit/loop/test_EventsInDatasetReader.py
@@ -34,6 +34,19 @@ def obj(eventLoopRunner, reader, collector, split_into_build_events):
     return EventsInDatasetReader(eventLoopRunner, reader, collector,
                                  split_into_build_events)
 
+##__________________________________________________________________||
+def test_deprecated(eventLoopRunner, reader, collector, split_into_build_events, caplog):
+    with caplog.at_level(logging.WARNING):
+        obj = EventsInDatasetReader(
+            eventLoopRunner, reader, collector,
+            split_into_build_events
+        )
+
+    assert len(caplog.records) == 1
+    assert caplog.records[0].levelname == 'WARNING'
+    assert 'EventsInDatasetReader' in caplog.records[0].name
+    assert 'deprecated' in caplog.records[0].msg
+
 ##__________________________________________________________________||
 def test_repr(obj):
    repr(obj)