update the way we handle contexts so that we just have a single clien…

…t imported once in a import statement

docs/configuration.rst

@@ -25,12 +25,11 @@ Configuration From Python
 
 .. code-block:: python
 
-    from onshapepy.client import Client
+    from onshapepy.client import c
     configuration = {"creds" :{
                             "access_key" : "*******YOUR API KEY*******",
                             "secret_key" : "*******YOUR API SECRET****"}}
-    Client(configuration)
-
+    c.update(configuration)
 
 .. _configuration_options:
 

onshapepy/assembly.py

@@ -3,8 +3,8 @@
 """
 
 from onshapepy.uri import Uri
-from onshapepy.core.context import Context
 import json
+from onshapepy.core.client import c
 
 
 class Assembly:
@@ -34,6 +34,5 @@ def insert(self, part):
 
         """
         params = {k: str(v) for k,v in part.params.items()}
-        c = Context().client
         res=c.create_assembly_instance(self.uri.as_dict(), part.uri.as_dict(), params)
         return res

onshapepy/core/client.py

@@ -18,8 +18,7 @@
 
 yaml = YAML()
 
-
-class Client():
+class Client:
     '''
     Defines methods for testing the Onshape API. Comes with several methods:
 
@@ -60,10 +59,6 @@ def __init__(self, conf=None, conf_file=".onshapepy"):
         if conf:
             default_conf.update(conf)
 
-        if not default_conf['creds']:
-            raise AssertionError("Please specify your OnShape acces_key and secret_key within the onshapepy "
-                                 "configuration file, by default located at 'home/.onshapepy'.")
-
         self.conf = default_conf
 
         self._stack = default_conf['stack']
@@ -431,3 +426,7 @@ def element_list(self, uri):
 
     def get_versions(self, uri):
         return self._api.request('get', '/api/documents/d/' + uri["did"] + '/versions')
+
+
+# Start the default client. To change the client, just change this value.
+c=Client()

onshapepy/core/onshape.py

@@ -46,8 +46,12 @@ def __init__(self, stack, creds, logging):
         '''
 
         self._url = stack
-        self._access_key = creds['access_key'].encode('utf-8')
-        self._secret_key = creds['secret_key'].encode('utf-8')
+        try:
+            self._access_key = creds['access_key'].encode('utf-8')
+            self._secret_key = creds['secret_key'].encode('utf-8')
+        except TypeError as e:
+            raise UserWarning("Specify a correct access key and secret key for the client")
+
         self._logging = logging
 
         if self._logging:

onshapepy/document.py

@@ -1,7 +1,7 @@
 """Represents an Onshape document"""
-from onshapepy.core.context import Context
 from onshapepy.uri import Uri
 from onshapepy.core.utils import ElementType
+from onshapepy.core.client import c
 
 
 class Document:
@@ -16,7 +16,6 @@ def __init__(self, url, copy=False, name=None, version=None):
             - version (str): The Onshape version name of the version to be copied or referenced.
 
             """
-        c = Context().client
 
         self.json = None
         self.e_list = None
@@ -50,12 +49,10 @@ def __init__(self, url, copy=False, name=None, version=None):
 
     def delete(self):
         """Delete the Onshape document"""
-        c = Context().client
         c.del_document(self.uri.did)
 
     def update(self):
         """All client calls to update this instance with Onshape."""
-        c = Context().client
         self.json = c.get_document(self.uri.did).json()
         self.e_list = c.element_list(self.uri.as_dict()).json()
 
@@ -73,7 +70,6 @@ def find_element(self, name, type=ElementType.ANY):
         Returns:
             - onshapepy.uri of the element
         """
-        c = Context().client
 
         for e in self.e_list:
             # if a type is specified and this isn't it, move to the next loop.

onshapepy/part.py

@@ -2,8 +2,7 @@
 OnShape part that maps to a part studio
 '''
 
-from onshapepy.core.client import Client
-from onshapepy.core.context import Context
+from onshapepy.core.client import c
 from onshapepy.core.utils import parse_quantity
 import json
 from onshapepy.uri import Uri
@@ -70,10 +69,9 @@ def __init__(self, parent):
     def payload(self):
         return json.loads(self.res.content.decode("utf-8"))
 
-    def update(self, params=None):
+    def update(self, params=None, client=c):
         """Push params to OnShape and synchronize the local copy
         """
-        c = Context().client
         uri = self.parent.uri
         if not params or not self.res:
             self.get_params()
@@ -89,7 +87,7 @@ def update(self, params=None):
                 except KeyError:
                     m["value"] = str(v)
 
-        res = c.update_configuration(uri.did, uri.wvm, uri.eid, json.dumps(d))
+        res = client.update_configuration(uri.did, uri.wvm, uri.eid, json.dumps(d))
 
         # If it was a good request, update config to be consistent with online.
         if res.status_code == 200:
@@ -99,8 +97,7 @@ def get_params(self):
         """Manually pull params defined in config from OnShape and return a python representation of the params.
         Quantities are converted to pint quantities, Bools are converted to python bools and Enums are converted
         to strings. Note that Enum names are autogenerated by OnShape and do not match the name on the OnShape UI."""
-        client = Context().client
-        self.res = client.get_configuration(self.parent.uri.as_dict())
+        self.res = c.get_configuration(self.parent.uri.as_dict())
 
     @property
     def params(self):
@@ -148,7 +145,6 @@ def __init__(self, parent):
 
     def update(self):
         """ Update all local variable names to match OnShape. """
-        c = Context().client
         uri = self.parent.uri
         script = r"""
         function(context, queries) {

tests/conftest.py

@@ -2,9 +2,9 @@
 from onshapepy.part import Part
 from onshapepy.assembly import Assembly
 from onshapepy.document import Document
-from onshapepy.core.context import Context
 from onshapepy.uri import Uri
 from datetime import datetime
+from onshapepy.core.client import c
 
 
 @pytest.fixture
@@ -25,8 +25,7 @@ def assembly(document):
 
 @pytest.fixture(scope="module")
 def client():
-    return Context().client
-
+    return c
 
 @pytest.fixture(scope="module")
 def document(client, onshape_version, onshape_document):

tests/test_core.py

@@ -21,7 +21,7 @@ def test_get_configuration(client):
     assert res.status_code == 200
 
 def test_client_without_file():
-    with pytest.raises(AssertionError):
+    with pytest.raises(UserWarning):
         client = Client(conf_file="This file doesn't exist")
 
 def test_document_setup(document, client):