export singer.state functions from main module (#190)

* export singer.state functions from main module

* - export singer.state functions from main module
- bump singer-python version and add changelog entry
- rename singer.state.write_bookmark to singer.state.set_bookmark
- add test cases for set_bookmark, clear_bookmark, set_offset, clear_offset, set_version, and clear_version

-----------------------------

Co-authored-by: Ben Allred <ben.allred@qlik.com>

* update changelog description to include rename of singer.state.write_bookmark to singer.state.set_bookmark

-----------------------------

Co-authored-by: Ben Allred <ben.allred@qlik.com>

* disable pylint warning

-----------------------------

Co-authored-by: Ben Allred <ben.allred@qlik.com>

* disable pylint warning for reimported

-----------------------------

Co-authored-by: Ben Allred <ben.allred@qlik.com>

---------

Co-authored-by: Leslie VanDeMark <lvandemark@talend.com>

Author: skuttleman

.circleci/config.yml

@@ -26,7 +26,7 @@ jobs:
           command: |
             source ~/.virtualenvs/singer-python/bin/activate
             pip install pylint
-            pylint singer --extension-pkg-whitelist=ciso8601 -d missing-docstring,broad-exception-raised,broad-exception-caught,bare-except,too-many-return-statements,too-many-branches,too-many-arguments,no-else-return,too-few-public-methods,fixme,protected-access,consider-using-f-string
+            pylint singer --extension-pkg-whitelist=ciso8601 -d missing-docstring,broad-exception-raised,broad-exception-caught,bare-except,too-many-return-statements,too-many-branches,too-many-arguments,no-else-return,too-few-public-methods,fixme,protected-access,consider-using-f-string,reimported
       - run:
           name: 'Run Tests'
           command: |

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 6.6.0
+  * Export singer.state functions from singer
+  * Rename singer.state.write_bookmark to singer.state.set_bookmark
+  * [#190](https://github.com/singer-io/singer-python/pull/190)
+
 ## 6.5.0
   * Add `activate_versions` state functions [#188](https://github.com/singer-io/singer-python/pull/188)
   * Deprecates bookmarks.py, functions are moved to state.py

setup.py

@@ -4,7 +4,7 @@
 import subprocess
 
 setup(name="singer-python",
-      version='6.5.0',
+      version='6.6.0',
       description="Singer.io utility library",
       author="Stitch",
       classifiers=['Programming Language :: Python :: 3 :: Only'],

singer/__init__.py

@@ -61,8 +61,10 @@
 )
 from singer.schema import Schema
 
-from singer.bookmarks import (
-    write_bookmark,
+from singer.state import (
+    set_bookmark,
+    # for backwards compatibility, use set_bookmark instead
+    set_bookmark as write_bookmark,
     get_bookmark,
     clear_bookmark,
     reset_stream,
@@ -71,6 +73,9 @@
     get_offset,
     set_currently_syncing,
     get_currently_syncing,
+    set_version,
+    clear_version,
+    get_version,
 )
 
 from singer.exceptions import (

singer/bookmarks.py

@@ -6,7 +6,7 @@ def ensure_bookmark_path(state, path):
     return st.ensure_state_path(state, path)
 
 def write_bookmark(state, tap_stream_id, key, val):
-    return st.write_bookmark(state, tap_stream_id, key, val)
+    return st.set_bookmark(state, tap_stream_id, key, val)
 
 def clear_bookmark(state, tap_stream_id, key):
     return st.clear_bookmark(state, tap_stream_id, key)

singer/state.py

@@ -7,7 +7,7 @@ def ensure_state_path(state, path):
         submap = submap[path_component]
     return state
 
-def write_bookmark(state, tap_stream_id, key, val):
+def set_bookmark(state, tap_stream_id, key, val):
     state = ensure_state_path(state, ['bookmarks', tap_stream_id])
     state['bookmarks'][tap_stream_id][key] = val
     return state
@@ -46,7 +46,7 @@ def set_currently_syncing(state, tap_stream_id):
 def get_currently_syncing(state, default=None):
     return state.get('currently_syncing', default)
 
-def write_version(state, tap_stream_id, key, val):
+def set_version(state, tap_stream_id, key, val):
     state = ensure_state_path(state, ['activate_versions', tap_stream_id])
     state['activate_versions'][tap_stream_id][key] = val
     return state

tests/test_state.py

@@ -1,7 +1,7 @@
 import unittest
 from singer import state as st
 
-class TestGetBookmark(unittest.TestCase):
+class TestBookmark(unittest.TestCase):
     def test_empty_state(self):
         empty_state = {}
 
@@ -69,8 +69,24 @@ def test_non_empty_state(self):
         self.assertEqual(st.get_bookmark(non_empty_state, stream_id_1, bookmark_key_1, 'default_value'),
                          bookmark_val_1)
 
+    def test_set_bookmark(self):
+        stream_id_1 = 'customers'
+        bookmark_key_1 = 'datetime'
+        bookmark_val_1 = 123456789
+
+        result = st.set_bookmark({'bookmarks': {stream_id_1: {bookmark_key_1: 'old-value'}}}, stream_id_1, bookmark_key_1, bookmark_val_1)
+        self.assertEqual(result, {'bookmarks': {stream_id_1: {bookmark_key_1: bookmark_val_1}}})
 
-class TestGetOffset(unittest.TestCase):
+    def test_clear_bookmark(self):
+        stream_id_1 = 'customers'
+        bookmark_key_1 = 'datetime'
+        bookmark_val_1 = 123456789
+
+        result = st.clear_bookmark({'bookmarks': {stream_id_1: {bookmark_key_1: bookmark_val_1}}}, stream_id_1, bookmark_key_1)
+        self.assertEqual(result, {'bookmarks': {stream_id_1: {}}})
+
+
+class TestOffset(unittest.TestCase):
     def test_empty_state(self):
         empty_state = {}
 
@@ -129,8 +145,24 @@ def test_non_empty_state(self):
         self.assertEqual(st.get_offset(non_empty_state, stream_id_1, 'default_value'),
                          offset_val)
 
+    def test_set_offset(self):
+        stream_id_1 = 'customers'
+        offset_key_1 = 'datetime'
+        offset_val_1 = 123456789
+
+        result = st.set_offset({'bookmarks': {stream_id_1: {'offset': {offset_key_1: 'old-value'}}}}, stream_id_1, offset_key_1, offset_val_1)
+        self.assertEqual(result, {'bookmarks': {stream_id_1: {'offset': {offset_key_1: offset_val_1}}}})
 
-class TestGetCurrentlySyncing(unittest.TestCase):
+    def test_clear_offset(self):
+        stream_id_1 = 'customers'
+        offset_key_1 = 'datetime'
+        offset_val_1 = 123456789
+
+        result = st.clear_offset({'bookmarks': {stream_id_1: {'offset': {offset_key_1: offset_val_1}}}}, stream_id_1)
+        self.assertEqual(result, {'bookmarks': {stream_id_1: {}}})
+
+
+class TestCurrentlySyncing(unittest.TestCase):
     def test_empty_state(self):
         empty_state = {}
 
@@ -165,6 +197,10 @@ def test_non_empty_state(self):
         self.assertEqual(st.get_currently_syncing(non_empty_state, 'default_value'),
                          stream_id_1)
 
+    def test_set_currently_syncing(self):
+        result = st.set_currently_syncing({'currently_syncing': 'foo'}, 'bar')
+        self.assertEqual(result, {'currently_syncing': 'bar'})
+
 
 class TestActivateVersion(unittest.TestCase):
     def test_empty_state(self):
@@ -233,3 +269,19 @@ def test_non_empty_state(self):
         # Good stream, good key
         self.assertEqual(st.get_version(non_empty_state, stream_id_1, version_key_1, 'default_value'),
                          version_val_1)
+
+    def test_set_version(self):
+        stream_id_1 = 'customers'
+        version_key_1 = 'datetime'
+        version_val_1 = 123456789
+
+        result = st.set_version({'activate_versions': {stream_id_1: {version_key_1: 'old-value'}}}, stream_id_1, version_key_1, version_val_1)
+        self.assertEqual(result, {'activate_versions': {stream_id_1: {version_key_1: version_val_1}}})
+
+    def test_clear_version(self):
+        stream_id_1 = 'customers'
+        version_key_1 = 'datetime'
+        version_val_1 = 123456789
+
+        result = st.clear_version({'activate_versions': {stream_id_1: {version_key_1: version_val_1}}}, stream_id_1, version_key_1)
+        self.assertEqual(result, {'activate_versions': {stream_id_1: {}}})