revert docs to 5.0

Sage-Bionetworks · Sep 25, 2024 · 04c2e0f · 04c2e0f
1 parent 9de86be
commit 04c2e0f
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 38 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -2,14 +2,14 @@
 
 [![Supported Python Versions](https://img.shields.io/pypi/pyversions/synapseclient.svg)](https://pypi.org/project/synapseclient/)
 
-### **Notice for the upcoming v6.0 release:**
+### **Notice for the upcoming v5.0 release:**
 
-- The upcoming v6.0 release will include a number of breaking changes. Take a look at
+- The upcoming v5.0 release will include a number of breaking changes. Take a look at
 this [pubpub](https://sagebionetworks.pubpub.org/pub/828a3x4k/release/1) article
 detailing some of the changes.
 - A release date has not been set. A number of these changes will be available within
 the 5.x.x versions hidden behind optional feature flags or different import paths. Any
-breaking changes will not be included until v6.0.
+breaking changes will not be included until v5.0.
 
 The `synapseclient` package provides an interface to [Synapse](http://www.synapse.org), a collaborative, open-source research platform that allows teams to share data, track analyses, and collaborate, providing support for:
 

diff --git a/docs/news.md b/docs/news.md
@@ -1,13 +1,13 @@
 # Release Notes
 
-### **Notice for the upcoming v6.0 release:**
+### **Notice for the upcoming v5.0 release:**
 
-- The upcoming v6.0 release will include a number of breaking changes. Take a look at
+- The upcoming v5.0 release will include a number of breaking changes. Take a look at
 this [pubpub](https://sagebionetworks.pubpub.org/pub/828a3x4k/release/1) article
 detailing some of the changes.
 - A release date has not been set. A number of these changes will be available within
 the 5.x.x versions hidden behind optional feature flags or different import paths. Any
-breaking changes will not be included until v6.0.
+breaking changes will not be included until v5.0.
 
 ## 4.5.1 (2024-09-19)
 ### Highlights

diff --git a/synapseclient/client.py b/synapseclient/client.py
@@ -600,7 +600,7 @@ def username(self) -> Union[str, None]:
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/api/configuration_services.py::get_config_file",
     )
     @functools.lru_cache()
@@ -755,7 +755,7 @@ def login(
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/api/configuration_services.py::get_config_section_dict",
     )
     def _get_config_section_dict(self, section_name: str) -> Dict[str, str]:
@@ -777,7 +777,7 @@ def _get_config_section_dict(self, section_name: str) -> Dict[str, str]:
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/api/configuration_services.py::get_config_authentication",
     )
     def _get_config_authentication(self) -> Dict[str, str]:
@@ -794,7 +794,7 @@ def _get_config_authentication(self) -> Dict[str, str]:
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/api/configuration_services.py::get_client_authenticated_s3_profile",
     )
     def _get_client_authenticated_s3_profile(
@@ -817,7 +817,7 @@ def _get_client_authenticated_s3_profile(
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/api/configuration_services.py::get_transfer_config",
     )
     def _get_transfer_config(self) -> Dict[str, str]:
@@ -1548,7 +1548,7 @@ def _getWithEntityBundle(
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::ensure_download_location_is_directory",
     )
     def _ensure_download_location_is_directory(self, downloadLocation: str) -> str:
@@ -1573,7 +1573,7 @@ def _ensure_download_location_is_directory(self, downloadLocation: str) -> str:
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::download_file_entity",
     )
     def _download_file_entity(
@@ -1670,7 +1670,7 @@ def _download_file_entity(
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::resolve_download_path_collisions",
     )
     def _resolve_download_path_collisions(
@@ -3115,7 +3115,7 @@ def _convertProvenanceList(self, usedList: list, limitSearch: str = None) -> lis
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/api/file_services.py::get_file_handle_for_download",
     )
     def _getFileHandleDownload(
@@ -3166,7 +3166,7 @@ def _getFileHandleDownload(
     @staticmethod
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::is_retryable_download_error",
     )
     def _is_retryable_download_error(ex: Exception) -> bool:
@@ -3188,7 +3188,7 @@ def _is_retryable_download_error(ex: Exception) -> bool:
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::download_by_file_handle",
     )
     def _downloadFileHandle(
@@ -3316,7 +3316,7 @@ def download_fn(credentials):
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::download_from_url_multi_threaded",
     )
     def _download_from_url_multi_threaded(
@@ -3382,7 +3382,7 @@ def _download_from_url_multi_threaded(
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::is_synapse_uri",
     )
     def _is_synapse_uri(self, uri: str) -> bool:
@@ -3401,7 +3401,7 @@ def _is_synapse_uri(self, uri: str) -> bool:
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_functions.py::download_from_url",
     )
     def _download_from_URL(

diff --git a/synapseclient/core/multithread_download/download_threads.py b/synapseclient/core/multithread_download/download_threads.py
@@ -40,7 +40,7 @@
 @contextmanager
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 def shared_executor(executor):
@@ -55,7 +55,7 @@ def shared_executor(executor):
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 class DownloadRequest(NamedTuple):
@@ -81,7 +81,7 @@ class DownloadRequest(NamedTuple):
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 class TransferStatus(object):
@@ -111,7 +111,7 @@ def elapsed_time(self) -> float:
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 class PresignedUrlInfo(NamedTuple):
@@ -131,7 +131,7 @@ class PresignedUrlInfo(NamedTuple):
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 class PresignedUrlProvider(object):
@@ -183,7 +183,7 @@ def _get_pre_signed_info(self) -> PresignedUrlInfo:
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 def _generate_chunk_ranges(
@@ -209,7 +209,7 @@ def _generate_chunk_ranges(
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 def _pre_signed_url_expiration_time(url: str) -> datetime:
@@ -233,7 +233,7 @@ def _pre_signed_url_expiration_time(url: str) -> datetime:
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 def _get_new_session() -> Session:
@@ -253,7 +253,7 @@ def _get_new_session() -> Session:
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 def _get_file_size(url: str, debug: bool) -> int:
@@ -275,7 +275,7 @@ def _get_file_size(url: str, debug: bool) -> int:
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 def download_file(
@@ -318,7 +318,7 @@ def download_file(
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 def _get_thread_session():
@@ -336,7 +336,7 @@ def _get_thread_session():
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. "
+    reason="To be removed in 5.0.0. "
     "Moved to synapseclient/core/download/download_async.py",
 )
 class _MultithreadedDownloader:
@@ -365,7 +365,7 @@ def __init__(self, syn, executor, max_concurrent_parts):
 
     @deprecated(
         version="4.4.0",
-        reason="To be removed in 6.0.0. "
+        reason="To be removed in 5.0.0. "
         "Moved to synapseclient/core/download/download_async.py",
     )
     def download_file(self, request: DownloadRequest) -> None:

diff --git a/synapseutils/sync.py b/synapseutils/sync.py
@@ -120,7 +120,7 @@ def syncFromSynapse(
             downloaded, no manifest file will be created.
         ifcollision: Determines how to handle file collisions. Maybe
                      "overwrite.local", "keep.local", or "keep.both".
-        allFiles: Deprecated and not to be used. This will be removed in v6.0.0.
+        allFiles: Deprecated and not to be used. This will be removed in v5.0.0.
         followLink: Determines whether the link returns the target Entity.
         manifest: Determines whether creating manifest file automatically. The
                   optional values here (`all`, `root`, `suppress`).
@@ -221,7 +221,7 @@ def syncFromSynapse(
     # implementation of this function with the public signature invoking itself. now
     # that this isn't a recursive any longer we don't need allFiles as a parameter
     # (especially on the public signature) but it is retained for now for backwards
-    # compatibility with external invokers. To be removed in v6.0.0.
+    # compatibility with external invokers. To be removed in v5.0.0.
     if allFiles is not None:
         allFiles.extend(synapse_files)
         synapse_files = allFiles
@@ -584,7 +584,7 @@ async def _upload_item_async(
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. This is being replaced by `generate_manifest`.",
+    reason="To be removed in 5.0.0. This is being replaced by `generate_manifest`.",
 )
 def generateManifest(syn, allFiles, filename, provenance_cache=None) -> None:
     """Generates a manifest file based on a list of entities objects.
@@ -609,7 +609,7 @@ def generateManifest(syn, allFiles, filename, provenance_cache=None) -> None:
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. This is being replaced by `_extract_entity_metadata_for_file`.",
+    reason="To be removed in 5.0.0. This is being replaced by `_extract_entity_metadata_for_file`.",
 )
 def _extract_file_entity_metadata(syn, allFiles, *, provenance_cache=None):
     """
@@ -666,7 +666,7 @@ def _extract_file_entity_metadata(syn, allFiles, *, provenance_cache=None):
 
 @deprecated(
     version="4.4.0",
-    reason="To be removed in 6.0.0. This is being replaced by `_get_entity_provenance_dict_for_file`.",
+    reason="To be removed in 5.0.0. This is being replaced by `_get_entity_provenance_dict_for_file`.",
 )
 def _get_file_entity_provenance_dict(syn, entity):
     """