add get_client

Author: Kevin Hannegan

presalytics/client/api.py

@@ -9,6 +9,7 @@
 import json
 import environs
 import wsgi_microservice_middleware
+import functools
 import presalytics
 import presalytics.lib.exceptions
 import presalytics.lib.constants as cnst
@@ -43,11 +44,11 @@ class Client(object):
 
     *A note for server-side development*:
 
-    By default, the client class automatically caches tokens in a file called 
+    The client class can automatically cache tokens in a file called 
     "token.json", located in the python's current working directory.  This is done so
-    users running scripts do not have to acquire a new token every time an API call is
-    made. If building a client to operate in a multi-user environment, this behavior 
-    should be turned off so that user do not pull one another's tokens.
+    users running scripts accross multiple client instances do not have to acquire a new token 
+    every time an API call is made. If building a client to operate in a multi-user environment, 
+    this behavior should be turned off so that one user cannot not pull one another's tokens.
     To do this, ensure the following parameters are pass to the configuration either 
     via initialization or in a `presalytics.CONFIG` file: 
     
@@ -454,6 +455,15 @@ def __init__(self, parent: Client, **kwargs):
         self.update_configuration()
 
 
+@functools.lru_cache(maxsize=None)
+def get_client():
+    """
+    Caches a client instance for default parameters set in `presalytics.CONFIG`.
+
+    DO NOT use in server-side operation
+    """
+    client = presalytics.Client()
+    return client
 
 
 

test/__init__.py

@@ -1,7 +0,0 @@
-from functools import lru_cache
-import presalytics
-
-@lru_cache(maxsize=None)
-def get_test_client():
-    client = presalytics.Client()
-    return client

test/test_components.py

@@ -6,7 +6,7 @@
 import presalytics
 import io
 import lxml
-from test import get_test_client
+from presalytics.client.api import get_client
 if typing.TYPE_CHECKING:
     from presalytics.client.presalytics_story import Story, OoxmlDocument
     from presalytics.client.presalytics_ooxml_automation.models import ChartChartDataDTO, TableTableDataDTO
@@ -29,11 +29,11 @@ def test_xml_widget(self):
         test_file = os.path.join(os.path.dirname(__file__), "files", "star.pptx")
         tmp_filename = os.path.join(os.path.dirname(__file__), os.path.basename(test_file))
         shutil.copyfile(test_file, tmp_filename)
-        client_info = get_test_client().get_client_info()
+        client_info = get_client().get_client_info()
         story = presalytics.create_story_from_ooxml_file(tmp_filename, client_info=client_info)
         outline = presalytics.StoryOutline.load(story.outline)
         old_widget = outline.pages[0].widgets[0]
-        childs = get_test_client().ooxml_automation.documents_childobjects_get_id(old_widget.data["document_ooxml_id"])
+        childs = get_client().ooxml_automation.documents_childobjects_get_id(old_widget.data["document_ooxml_id"])
         endpoint_map = presalytics.OoxmlEndpointMap.shape() 
         object_type = endpoint_map.get_object_type()
         info = next(x for x in childs if x.object_type == object_type)
@@ -66,7 +66,7 @@ def test_xml_widget(self):
 
         presalytics.COMPONENTS.register(widget)
         story.outline = outline.dump()
-        get_test_client().story.story_id_put(story.id, story)
+        get_client().story.story_id_put(story.id, story)
         html = presalytics.Revealer(outline).package_as_standalone().decode('utf-8')
         self.assertIsInstance(html, str)
         os.remove(tmp_filename)
@@ -88,7 +88,7 @@ def test_bytesio_upload(self):
         with open(test_file, 'rb') as f:
             _bytes = io.BytesIO(f.read())
 
-        story = presalytics.story_post_file_bytes(get_test_client(), _bytes, "testfile.pptx")
+        story = presalytics.story_post_file_bytes(get_client(), _bytes, "testfile.pptx")
         from presalytics.client.presalytics_story.models.story import Story
         self.assertIsInstance(story, Story)
 
@@ -121,10 +121,10 @@ def test_chart_update(self):
         document: "OoxmlDocument"
 
         test_file = os.path.join(os.path.dirname(__file__), "files", "bubblechart.pptx")
-        story = get_test_client().story.story_post_file(file=[test_file])
-        story_detailed = get_test_client().story.story_id_get(story.id, include_relationships=True)
+        story = get_client().story.story_post_file(file=[test_file])
+        story_detailed = get_client().story.story_id_get(story.id, include_relationships=True)
         document = story_detailed.ooxml_documents[0]
-        object_tree = get_test_client().ooxml_automation.documents_childobjects_get_id(document.ooxml_automation_id)
+        object_tree = get_client().ooxml_automation.documents_childobjects_get_id(document.ooxml_automation_id)
         endpoint_map = presalytics.OoxmlEndpointMap.chart() 
         object_type = endpoint_map.get_object_type()
         chart_id = next(entity.entity_id for entity in object_tree if entity.object_type == object_type)
@@ -167,10 +167,10 @@ def test_table_update(self):
         dto: "TableTableDataDTO"
 
         test_file = os.path.join(os.path.dirname(__file__), "files", "table.pptx")
-        story = get_test_client().story.story_post_file(file=[test_file])
-        story_detailed = get_test_client().story.story_id_get(story.id, include_relationships=True)
+        story = get_client().story.story_post_file(file=[test_file])
+        story_detailed = get_client().story.story_id_get(story.id, include_relationships=True)
         document = story_detailed.ooxml_documents[0]
-        object_tree = get_test_client().ooxml_automation.documents_childobjects_get_id(document.ooxml_automation_id)
+        object_tree = get_client().ooxml_automation.documents_childobjects_get_id(document.ooxml_automation_id)
         endpoint_map = presalytics.OoxmlEndpointMap.table() 
         object_type = endpoint_map.get_object_type()
         table_id = next(entity.entity_id for entity in object_tree if entity.object_type == object_type)