From b21fad9cec399033f81983145f2c47b9182e45b2 Mon Sep 17 00:00:00 2001
From: Gokhan Ozbulak <gokhan.ozbulak@idiap.ch>
Date: Tue, 9 Apr 2024 13:28:57 +0200
Subject: [PATCH] Modified comments for better qa #60
---
src/mednet/scripts/upload.py | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/src/mednet/scripts/upload.py b/src/mednet/scripts/upload.py
index eede2766..0b0f1417 100644
--- a/src/mednet/scripts/upload.py
+++ b/src/mednet/scripts/upload.py
@@ -21,7 +21,12 @@ from .click import ConfigCommand
logger = setup(__name__.split(".")[0], format="%(levelname)s: %(message)s")
def get_config():
- """Returns an instance of the Gitlab object for remote operations."""
+ """Return an instance of the Gitlab object for remote operations.
+
+ Returns
+ -------
+ Gitlab entry and credential.
+ """
cfg = pathlib.Path(os.path.expanduser("~/.python-gitlab.cfg"))
if cfg.exists():
@@ -37,6 +42,20 @@ def get_config():
return gl, config
def create_temp_copy(source, target):
+ """ Create a copy of original file in temp folder.
+
+ Parameters
+ ----------
+ source
+ Source file.
+ target
+ Target file.
+
+ Returns
+ -------
+ Path to target file in temp folder.
+ """
+
temp_dir = tempfile.gettempdir()
target = os.path.join(temp_dir, target)
shutil.copy2(source, target)
--
GitLab