function name refactor

Author: JanCaha

mergin/client.py

@@ -214,9 +214,9 @@ def validate_auth(self):
                 raise ClientError("Missing login or password")
 
     @staticmethod
-    def _check_token(f):
+    def check_token(f):
         """Wrapper for creating/renewing authorization token.
-        Every function that requires authentication should be decorated with this as @_check_token."""
+        Every function that requires authentication should be decorated with this as @check_token."""
 
         def wrapper(self, *args, **kwargs):
             # functions that run prior to required function using this decorator
@@ -329,7 +329,7 @@ def username(self):
             return None  # not authenticated
         return self._user_info["username"]
 
-    @_check_token
+    @check_token
     def workspace_service(self, workspace_id):
         """
         This Requests information about a workspace service from /workspace/{id}/service endpoint,
@@ -340,7 +340,7 @@ def workspace_service(self, workspace_id):
         resp = self.get(f"/v1/workspace/{workspace_id}/service")
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def workspace_usage(self, workspace_id):
         """
         This Requests information about a workspace usage from /workspace/{id}/usage endpoint,
@@ -393,7 +393,7 @@ def server_version(self):
 
         return self._server_version
 
-    @_check_token
+    @check_token
     def workspaces_list(self):
         """
         Find all available workspaces
@@ -404,7 +404,7 @@ def workspaces_list(self):
         workspaces = json.load(resp)
         return workspaces
 
-    @_check_token
+    @check_token
     def create_workspace(self, workspace_name):
         """
         Create new workspace for currently active user.
@@ -423,7 +423,7 @@ def create_workspace(self, workspace_name):
             e.extra = f"Workspace name: {workspace_name}"
             raise e
 
-    @_check_token
+    @check_token
     def create_project(self, project_name, is_public=False, namespace=None):
         """
         Create new project repository in user namespace on Mergin Maps server.
@@ -473,7 +473,7 @@ def create_project(self, project_name, is_public=False, namespace=None):
             e.extra = f"Namespace: {namespace}, project name: {project_name}"
             raise e
 
-    @_check_token
+    @check_token
     def create_project_and_push(self, project_name, directory, is_public=False, namespace=None):
         """
         Convenience method to create project and push the initial version right after that.
@@ -519,7 +519,7 @@ def create_project_and_push(self, project_name, directory, is_public=False, name
             if mp.inspect_files():
                 self.push_project(directory)
 
-    @_check_token
+    @check_token
     def paginated_projects_list(
         self,
         page=1,
@@ -593,7 +593,7 @@ def paginated_projects_list(
         projects = json.load(resp)
         return projects
 
-    @_check_token
+    @check_token
     def projects_list(
         self,
         tags=None,
@@ -663,7 +663,7 @@ def projects_list(
                 break
         return projects
 
-    @_check_token
+    @check_token
     def project_info(self, project_path_or_id, since=None, version=None):
         """
         Fetch info about project.
@@ -687,7 +687,7 @@ def project_info(self, project_path_or_id, since=None, version=None):
             resp = self.get("/v1/project/{}".format(project_path_or_id), params)
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def paginated_project_versions(self, project_path, page, per_page=100, descending=False):
         """
         Get records of project's versions (history) using calculated pagination.
@@ -709,7 +709,7 @@ def paginated_project_versions(self, project_path, page, per_page=100, descendin
         resp_json = json.load(resp)
         return resp_json["versions"], resp_json["count"]
 
-    @_check_token
+    @check_token
     def project_versions_count(self, project_path):
         """
         return the total count of versions
@@ -725,7 +725,7 @@ def project_versions_count(self, project_path):
         resp_json = json.load(resp)
         return resp_json["count"]
 
-    @_check_token
+    @check_token
     def project_versions(self, project_path, since=1, to=None):
         """
         Get records of project's versions (history) in ascending order.
@@ -773,7 +773,7 @@ def project_versions(self, project_path, since=1, to=None):
         filtered_versions = list(filter(lambda v: (num_since <= int_version(v["name"]) <= num_to), versions))
         return filtered_versions
 
-    @_check_token
+    @check_token
     def download_project(self, project_path, directory, version=None):
         """
         Download project into given directory. If version is not specified, latest version is downloaded
@@ -791,7 +791,7 @@ def download_project(self, project_path, directory, version=None):
         download_project_wait(job)
         download_project_finalize(job)
 
-    @_check_token
+    @check_token
     def user_info(self):
         server_type = self.server_type()
         if server_type == ServerType.OLD:
@@ -800,7 +800,7 @@ def user_info(self):
             resp = self.get("/v1/user/profile")
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def set_project_access(self, project_path, access):
         """
         Updates access for given project.
@@ -824,7 +824,7 @@ def set_project_access(self, project_path, access):
             e.extra = f"Project path: {project_path}"
             raise e
 
-    @_check_token
+    @check_token
     def add_user_permissions_to_project(self, project_path, usernames, permission_level):
         """
         Add specified permissions to specified users to project
@@ -858,7 +858,7 @@ def add_user_permissions_to_project(self, project_path, usernames, permission_le
             category=DeprecationWarning,
         )
 
-    @_check_token
+    @check_token
     def remove_user_permissions_from_project(self, project_path, usernames):
         """
         Removes specified users from project
@@ -883,7 +883,7 @@ def remove_user_permissions_from_project(self, project_path, usernames):
             category=DeprecationWarning,
         )
 
-    @_check_token
+    @check_token
     def project_user_permissions(self, project_path):
         """
         Returns permissions for project
@@ -904,7 +904,7 @@ def project_user_permissions(self, project_path):
         result["readers"] = access.get("readersnames", [])
         return result
 
-    @_check_token
+    @check_token
     def push_project(self, directory):
         """
         Upload local changes to the repository.
@@ -918,7 +918,7 @@ def push_project(self, directory):
         push_project_wait(job)
         push_project_finalize(job)
 
-    @_check_token
+    @check_token
     def pull_project(self, directory):
         """
         Fetch and apply changes from repository.
@@ -932,7 +932,7 @@ def pull_project(self, directory):
         pull_project_wait(job)
         return pull_project_finalize(job)
 
-    @_check_token
+    @check_token
     def clone_project(self, source_project_path, cloned_project_name, cloned_project_namespace=None):
         """
         Clone project on server.
@@ -978,7 +978,7 @@ def clone_project(self, source_project_path, cloned_project_name, cloned_project
         request = urllib.request.Request(url, data=json.dumps(data).encode(), headers=json_headers, method="POST")
         self._do_request(request)
 
-    @_check_token
+    @check_token
     def delete_project_now(self, project_path):
         """
         Delete project repository on server immediately.
@@ -1002,7 +1002,7 @@ def delete_project_now(self, project_path):
         request = urllib.request.Request(url, method="DELETE")
         self._do_request(request)
 
-    @_check_token
+    @check_token
     def delete_project(self, project_path):
         """
         Delete project repository on server. Newer servers since 2023
@@ -1027,7 +1027,7 @@ def delete_project(self, project_path):
         request = urllib.request.Request(url, method="DELETE")
         self._do_request(request)
 
-    @_check_token
+    @check_token
     def project_status(self, directory):
         """
         Get project status, e.g. server and local changes.
@@ -1047,27 +1047,27 @@ def project_status(self, directory):
 
         return pull_changes, push_changes, push_changes_summary
 
-    @_check_token
+    @check_token
     def project_version_info(self, project_id, version):
         """Returns JSON with detailed information about a single project version"""
         resp = self.get(f"/v1/project/version/{project_id}/{version}")
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def project_file_history_info(self, project_path, file_path):
         """Returns JSON with full history of a single file within a project"""
         params = {"path": file_path}
         resp = self.get("/v1/resource/history/{}".format(project_path), params)
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def project_file_changeset_info(self, project_path, file_path, version):
         """Returns JSON with changeset details of a particular version of a file within a project"""
         params = {"path": file_path}
         resp = self.get("/v1/resource/changesets/{}/{}".format(project_path, version), params)
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def get_projects_by_names(self, projects):
         """Returns JSON with projects' info for list of required projects.
         The schema of the returned information is the same as the response from projects_list().
@@ -1082,7 +1082,7 @@ def get_projects_by_names(self, projects):
         resp = self.post("/v1/project/by_names", {"projects": projects}, {"Content-Type": "application/json"})
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def download_file(self, project_dir, file_path, output_filename, version=None):
         """
         Download project file at specified version. Get the latest if no version specified.
@@ -1136,7 +1136,7 @@ def get_file_diff(self, project_dir, file_path, output_diff, version_from, versi
             elif len(diffs) == 1:
                 shutil.copy(diffs[0], output_diff)
 
-    @_check_token
+    @check_token
     def download_file_diffs(self, project_dir, file_path, versions):
         """Download file diffs for specified versions if they are not present
         in the cache.
@@ -1213,7 +1213,7 @@ def has_writing_permissions(self, project_path):
         info = self.project_info(project_path)
         return info["permissions"]["upload"]
 
-    @_check_token
+    @check_token
     def rename_project(self, project_path: str, new_project_name: str) -> None:
         """
         Rename project on server.
@@ -1285,7 +1285,7 @@ def reset_local_changes(self, directory: str, files_to_reset: typing.List[str] =
         if files_download:
             self.download_files(directory, files_download, version=current_version)
 
-    @_check_token
+    @check_token
     def download_files(
         self, project_dir: str, file_paths: typing.List[str], output_paths: typing.List[str] = None, version: str = None
     ):
@@ -1311,7 +1311,7 @@ def has_editor_support(self):
         """
         return is_version_acceptable(self.server_version(), "2024.4.0")
 
-    @_check_token
+    @check_token
     def create_user(
         self,
         email: str,
@@ -1343,23 +1343,23 @@ def create_user(
         user_info = self.post("v2/users", params, json_headers)
         return json.load(user_info)
 
-    @_check_token
+    @check_token
     def get_workspace_member(self, workspace_id: int, user_id: int) -> dict:
         """
         Get a workspace member detail
         """
         resp = self.get(f"v2/workspaces/{workspace_id}/members/{user_id}")
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def list_workspace_members(self, workspace_id: int) -> List[dict]:
         """
         Get a list of workspace members
         """
         resp = self.get(f"v2/workspaces/{workspace_id}/members")
         return json.load(resp)
 
-    @_check_token
+    @check_token
     def update_workspace_member(
         self, workspace_id: int, user_id: int, workspace_role: WorkspaceRole, reset_projects_roles: bool = False
     ) -> dict:
@@ -1375,22 +1375,22 @@ def update_workspace_member(
         workspace_member = self.patch(f"v2/workspaces/{workspace_id}/members/{user_id}", params, json_headers)
         return json.load(workspace_member)
 
-    @_check_token
+    @check_token
     def remove_workspace_member(self, workspace_id: int, user_id: int):
         """
         Remove a user from workspace members
         """
         self.delete(f"v2/workspaces/{workspace_id}/members/{user_id}")
 
-    @_check_token
+    @check_token
     def list_project_collaborators(self, project_id: str) -> List[dict]:
         """
         Get a list of project collaborators
         """
         project_collaborators = self.get(f"v2/projects/{project_id}/collaborators")
         return json.load(project_collaborators)
 
-    @_check_token
+    @check_token
     def add_project_collaborator(self, project_id: str, user: str, project_role: ProjectRole) -> dict:
         """
         Add a user to project collaborators and grant them a project role.
@@ -1402,7 +1402,7 @@ def add_project_collaborator(self, project_id: str, user: str, project_role: Pro
         project_collaborator = self.post(f"v2/projects/{project_id}/collaborators", params, json_headers)
         return json.load(project_collaborator)
 
-    @_check_token
+    @check_token
     def update_project_collaborator(self, project_id: str, user_id: int, project_role: ProjectRole) -> dict:
         """
         Update project role of the existing project collaborator.
@@ -1412,7 +1412,7 @@ def update_project_collaborator(self, project_id: str, user_id: int, project_rol
         project_collaborator = self.patch(f"v2/projects/{project_id}/collaborators/{user_id}", params, json_headers)
         return json.load(project_collaborator)
 
-    @_check_token
+    @check_token
     def remove_project_collaborator(self, project_id: str, user_id: int):
         """
         Remove a user from project collaborators
@@ -1424,7 +1424,7 @@ def server_config(self) -> dict:
         response = self.get("/config")
         return json.load(response)
 
-    @_check_token
+    @check_token
     def send_logs(
         self,
         logfile: str,