synapseclient 4.4.0__tar.gz → 4.4.2__tar.gz

{synapseclient-4.4.0/synapseclient.egg-info → synapseclient-4.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: synapseclient
-Version: 4.4.0
+Version: 4.4.2
 Summary: A client for Synapse, a collaborative, open-source research platform that allows teams to share data, track analyses, and collaborate.
 Home-page: https://www.synapse.org
 Author: The Synapse Engineering Team
@@ -13,7 +13,6 @@ Project-URL: Changelog, https://python-docs.synapse.org/build/html/index.html#re
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -27,10 +26,10 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Requires-Dist: requests<3.0,>=2.22.0
-Requires-Dist: urllib3<2,>=1.26.18
+Requires-Dist: urllib3>=2.6.3
 Requires-Dist: deprecated<2.0,>=1.2.4
 Requires-Dist: opentelemetry-api~=1.21.0
 Requires-Dist: opentelemetry-sdk~=1.21.0
@@ -41,6 +40,7 @@ Requires-Dist: httpx~=0.27.0
 Requires-Dist: tqdm<5.0,>=4.66.2
 Requires-Dist: async-lru~=2.0.4
 Requires-Dist: psutil~=5.9.8
+Requires-Dist: setuptools>=80.10.1
 Provides-Extra: dev
 Requires-Dist: pytest<8.0,>=7.0.0; extra == "dev"
 Requires-Dist: pytest-mock<4.0,>=3.0; extra == "dev"

{synapseclient-4.4.0 → synapseclient-4.4.2}/setup.cfg

@@ -17,7 +17,6 @@ platforms = any
 classifiers = 
 	Development Status :: 5 - Production/Stable
 	Programming Language :: Python
-	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
@@ -36,10 +35,10 @@ classifiers =
 zip_safe = False
 include_package_data = True
 packages = find:
-python_requires = >=3.8
+python_requires = >=3.9
 install_requires = 
 	requests>=2.22.0,<3.0
-	urllib3>=1.26.18,<2
+	urllib3>=2.6.3
 	deprecated>=1.2.4,<2.0
 	opentelemetry-api~=1.21.0
 	opentelemetry-sdk~=1.21.0
@@ -50,6 +49,7 @@ install_requires =
 	tqdm>=4.66.2,<5.0
 	async-lru~=2.0.4
 	psutil~=5.9.8
+	setuptools>=80.10.1
 tests_require = 
 	pytest>=7.0.0,<8.0
 	pytest-mock>=3.0,<4.0

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient/client.py

@@ -277,6 +277,7 @@ class Synapse(object):
         requests_session_async_synapse: httpx.AsyncClient = None,
         requests_session_storage: httpx.Client = None,
         asyncio_event_loop: asyncio.AbstractEventLoop = None,
+        cache_client: bool = True,
     ) -> "Synapse":
         """
         Initialize Synapse object
@@ -300,6 +301,9 @@ class Synapse(object):
             asyncio_event_loop: The event loop that is going to be used while executing
                 this code. This is optional and only used when you are manually
                 specifying an async HTTPX client.
+            cache_client: Whether to cache the Synapse client object in the Synapse module. Defaults to True.
+                             When set to True anywhere a `Synapse` object is optional you do not need to pass an
+                             instance of `Synapse` to that function, method, or class.
 
         Raises:
             ValueError: Warn for non-boolean debug value.
@@ -411,6 +415,8 @@ class Synapse(object):
         self._parallel_file_transfer_semaphore = {}
         self.use_boto_sts_transfers = transfer_config["use_boto_sts"]
         self._parts_transfered_counter = 0
+        if cache_client:
+            Synapse.set_client(synapse_client=self)
 
     def _get_requests_session_async_synapse(
         self, asyncio_event_loop: asyncio.AbstractEventLoop
@@ -708,7 +714,6 @@ class Synapse(object):
         email: str = None,
         silent: bool = False,
         authToken: str = None,
-        cache_client: bool = True,
     ) -> None:
         """
         Valid combinations of login() arguments:
@@ -729,9 +734,6 @@ class Synapse(object):
             authToken:    A bearer authorization token, e.g. a
                 [personal access token](https://python-docs.synapse.org/tutorials/authentication/).
             silent:       Defaults to False.  Suppresses the "Welcome ...!" message.
-            cache_client: Whether to cache the Synapse client object in the Synapse module. Defaults to True.
-                             When set to True anywhere a `Synapse` object is optional you do not need to pass an
-                             instance of `Synapse` to that function, method, or class.
 
         Example: Logging in
             Using an auth token:
@@ -770,17 +772,9 @@ class Synapse(object):
             raise SynapseNoCredentialsError("No credentials provided.")
 
         if not silent:
-            profile = self.getUserProfile()
-            display_name = (
-                profile["displayName"]
-                if "displayName" in profile
-                else self.credentials.username
-            )
+            display_name = self.credentials.displayname or self.credentials.username
             self.logger.info(f"Welcome, {display_name}!\n")
 
-        if cache_client:
-            Synapse.set_client(self)
-
     @deprecated(
         version="4.4.0",
         reason="To be removed in 5.0.0. "
@@ -4935,6 +4929,7 @@ class Synapse(object):
                     destination=os.path.join(
                         cache_dir, str(wiki.markdownFileHandleId) + ".md"
                     ),
+                    synapse_client=self,
                 ),
                 syn=self,
             )
@@ -5603,6 +5598,7 @@ class Synapse(object):
                 synapse_id=extract_synapse_id_from_query(query),
                 entity_type="TableEntity",
                 destination=os.path.join(download_dir, filename),
+                synapse_client=self,
             ),
             syn=self,
         )

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient/core/credentials/cred_data.py

@@ -61,11 +61,14 @@ class SynapseAuthTokenCredentials(SynapseCredentials):
             # ValueError if the split string is not base64 encoded or if the decoded base64 is not json
             pass
 
-    def __init__(self, token, username=None):
+    def __init__(
+        self, token: str, username: str = None, displayname: str = None
+    ) -> None:
         self._validate_token(token)
 
         self._token = token
         self.username = username
+        self.displayname = displayname
 
     @property
     def username(self) -> str:
@@ -76,6 +79,15 @@ class SynapseAuthTokenCredentials(SynapseCredentials):
     def username(self, username: str) -> None:
         self._username = username
 
+    @property
+    def displayname(self) -> str:
+        """The displayname associated with this token."""
+        return self._displayname
+
+    @displayname.setter
+    def displayname(self, displayname: str) -> None:
+        self._displayname = displayname
+
     @property
     def secret(self) -> str:
         """The bearer token."""
@@ -86,7 +98,12 @@ class SynapseAuthTokenCredentials(SynapseCredentials):
         return r
 
     def __repr__(self):
-        return f"SynapseAuthTokenCredentials(username='{self.username}', token='{self.secret}')"
+        return (
+            f"SynapseAuthTokenCredentials("
+            f"username='{self.username}', "
+            f"displayname='{self.displayname}', "
+            f"token='{self.secret}')"
+        )
 
 
 # a class that just contains args passed form synapse client login

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient/core/credentials/credential_provider.py

@@ -77,6 +77,7 @@ class SynapseCredentialsProvider(metaclass=abc.ABCMeta):
             profile = syn.restGET("/userProfile", auth=credentials)
             profile_username = profile.get("userName")
             profile_emails = profile.get("emails", [])
+            profile_displayname = profile.get("displayName")
 
             if username and (
                 username != profile_username and username not in profile_emails
@@ -88,8 +89,9 @@ class SynapseCredentialsProvider(metaclass=abc.ABCMeta):
                     "username/email and auth_token both provided but username does not "
                     "match token profile"
                 )
-
             credentials.username = profile_username
+            credentials.displayname = profile_displayname
+
             return credentials
 
         return None

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient/core/download/download_async.py

@@ -314,7 +314,9 @@ class _MultithreadedDownloader:
             syn=self._syn, url=url_info.url, debug=self._download_request.debug
         )
         self._progress_bar = get_or_create_download_progress_bar(
-            file_size=file_size, postfix=self._download_request.object_id
+            file_size=file_size,
+            postfix=self._download_request.object_id,
+            synapse_client=self._syn,
         )
         self._prep_file()
 

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient/core/download/download_functions.py

@@ -166,6 +166,7 @@ async def download_file_entity(
                 synapse_id=object_id,
                 entity_type=object_type,
                 destination=download_path,
+                synapse_client=client,
             )
 
         if download_path is None or not os.path.exists(download_path):
@@ -274,6 +275,7 @@ async def download_file_entity_model(
                 synapse_id=object_id,
                 entity_type=object_type,
                 destination=download_path,
+                synapse_client=client,
             )
 
         if download_path is None or not os.path.exists(download_path):
@@ -416,7 +418,7 @@ async def download_by_file_handle(
                 )
 
                 progress_bar = get_or_create_download_progress_bar(
-                    file_size=1, postfix=synapse_id
+                    file_size=1, postfix=synapse_id, synapse_client=syn
                 )
                 loop = asyncio.get_running_loop()
                 downloaded_path = await loop.run_in_executor(
@@ -440,7 +442,7 @@ async def download_by_file_handle(
                 and concrete_type == concrete_types.S3_FILE_HANDLE
             ):
                 progress_bar = get_or_create_download_progress_bar(
-                    file_size=1, postfix=synapse_id
+                    file_size=1, postfix=synapse_id, synapse_client=syn
                 )
 
                 def download_fn(
@@ -496,7 +498,7 @@ async def download_by_file_handle(
             else:
                 loop = asyncio.get_running_loop()
                 progress_bar = get_or_create_download_progress_bar(
-                    file_size=1, postfix=synapse_id
+                    file_size=1, postfix=synapse_id, synapse_client=syn
                 )
                 downloaded_path = await loop.run_in_executor(
                     syn._get_thread_pool_executor(asyncio_event_loop=loop),

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient/core/transfer_bar.py

@@ -85,7 +85,7 @@ def shared_download_progress_bar(
 
     syn = Synapse.get_client(synapse_client=synapse_client)
     with logging_redirect_tqdm(loggers=[syn.logger]):
-        get_or_create_download_progress_bar(file_size=file_size)
+        get_or_create_download_progress_bar(file_size=file_size, synapse_client=syn)
         try:
             yield
         finally:

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient/synapsePythonClient

@@ -1,6 +1,6 @@
 {
   "client": "synapsePythonClient",
-  "latestVersion":"4.4.0",
+  "latestVersion":"4.4.2",
   "blacklist": [
     "0.0.0",
     "0.4.1",

{synapseclient-4.4.0 → synapseclient-4.4.2/synapseclient.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: synapseclient
-Version: 4.4.0
+Version: 4.4.2
 Summary: A client for Synapse, a collaborative, open-source research platform that allows teams to share data, track analyses, and collaborate.
 Home-page: https://www.synapse.org
 Author: The Synapse Engineering Team
@@ -13,7 +13,6 @@ Project-URL: Changelog, https://python-docs.synapse.org/build/html/index.html#re
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -27,10 +26,10 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Requires-Dist: requests<3.0,>=2.22.0
-Requires-Dist: urllib3<2,>=1.26.18
+Requires-Dist: urllib3>=2.6.3
 Requires-Dist: deprecated<2.0,>=1.2.4
 Requires-Dist: opentelemetry-api~=1.21.0
 Requires-Dist: opentelemetry-sdk~=1.21.0
@@ -41,6 +40,7 @@ Requires-Dist: httpx~=0.27.0
 Requires-Dist: tqdm<5.0,>=4.66.2
 Requires-Dist: async-lru~=2.0.4
 Requires-Dist: psutil~=5.9.8
+Requires-Dist: setuptools>=80.10.1
 Provides-Extra: dev
 Requires-Dist: pytest<8.0,>=7.0.0; extra == "dev"
 Requires-Dist: pytest-mock<4.0,>=3.0; extra == "dev"

{synapseclient-4.4.0 → synapseclient-4.4.2}/synapseclient.egg-info/requires.txt

@@ -1,5 +1,5 @@
 requests<3.0,>=2.22.0
-urllib3<2,>=1.26.18
+urllib3>=2.6.3
 deprecated<2.0,>=1.2.4
 opentelemetry-api~=1.21.0
 opentelemetry-sdk~=1.21.0
@@ -10,6 +10,7 @@ httpx~=0.27.0
 tqdm<5.0,>=4.66.2
 async-lru~=2.0.4
 psutil~=5.9.8
+setuptools>=80.10.1
 
 [boto3]
 boto3<2.0,>=1.7.0