xlwings-utils 25.1.1__py3-none-any.whl → 25.1.2__py3-none-any.whl

xlwings_utils/xlwings_utils.py

@@ -5,7 +5,7 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "25.1.1"
+__version__ = "25.1.2"
 
 
 from pathlib import Path
@@ -30,13 +30,10 @@ except ImportError:
 missing = object()
 
 _token = None
-missing = object()
 
 
 def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **kwargs):
     """
-    dropbox initialize
-
     This function may to be called prior to using any dropbox function
     to specify the request token, app key and app secret.
     If these are specified as DROPBOX.REFRESH_TOKEN, DROPBOX.APP_KEY and DROPBOX.APP_SECRET
@@ -47,18 +44,18 @@ def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **k
     refresh_token : str
         oauth2 refreshntoken
 
-        if omitted: use the environment variable REFRESH_TOKEN
+        if omitted: use the environment variable DROPBOX.REFRESH_TOKEN
 
     app_key : str
         app key
 
-        if omitted: use the environment variable APP_KEY
+        if omitted: use the environment variable DROPBOX.APP_KEY
 
 
     app_secret : str
         app secret
 
-        if omitted: use the environment variable APP_SECRET
+        if omitted: use the environment variable DROPBOX.APP_SECRET
 
     Returns
     -------
@@ -67,7 +64,7 @@ def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **k
 
     global _token
     if xlwings:
-        pyodide_http.patch_all()  # to enable chunked mode
+        pyodide_http.patch_all()  # required to reliably use requests on pyodide platforms
 
     if refresh_token is missing:
         if "DROPBOX.REFRESH_TOKEN" in os.environ:
@@ -85,28 +82,25 @@ def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **k
         else:
             raise ValueError("no DROPBOX.APP_SECRET found in environment.")
 
-    resp = requests.post(
+    response = requests.post(
         "https://api.dropbox.com/oauth2/token",
         data={"grant_type": "refresh_token", "refresh_token": refresh_token, "client_id": app_key, "client_secret": app_secret},
         timeout=30,
     )
     try:
-        resp.raise_for_status()
+        response.raise_for_status()
     except requests.exceptions.HTTPError:
         raise ValueError("invalid dropbox credentials")
-    _token = resp.json()["access_token"]
+    _token = response.json()["access_token"]
 
 
 def _login_dropbox():
-    global _token
     if _token is None:
         dropbox_init()  # use environment
 
 
 def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
     """
-    list_dropbox
-
     returns all dropbox files/folders in path
 
     Parameters
@@ -138,15 +132,15 @@ def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
 
     API_RPC = "https://api.dropboxapi.com/2"
     headers = {"Authorization": f"Bearer {_token}", "Content-Type": "application/json"}
-    payload = {"path": path, "recursive": recursive, "include_deleted": False}
-    r = requests.post("https://api.dropboxapi.com/2/files/list_folder", headers=headers, json=payload, timeout=30)
-    r.raise_for_status()
-    data = r.json()
+    payload = {"path": str(path), "recursive": recursive, "include_deleted": False}
+    response = requests.post("https://api.dropboxapi.com/2/files/list_folder", headers=headers, json=payload, timeout=30)
+    response.raise_for_status()
+    data = response.json()
     entries = data["entries"]
     while data.get("has_more"):
-        r = requests.post(f"{API_RPC}/files/list_folder/continue", headers=headers, json={"cursor": data["cursor"]}, timeout=30)
-        r.raise_for_status()
-        data = r.json()
+        response = requests.post(f"{API_RPC}/files/list_folder/continue", headers=headers, json={"cursor": data["cursor"]}, timeout=30)
+        response.raise_for_status()
+        data = response.json()
         entries.extend(data["entries"])
 
     result = []
@@ -160,9 +154,7 @@ def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
 
 def read_dropbox(dropbox_path):
     """
-    read_dropbox
-
-    read from dopbox at given path
+    read file from dropbox
 
     Parameters
     ----------
@@ -181,13 +173,13 @@ def read_dropbox(dropbox_path):
 
     _login_dropbox()
     headers = {"Authorization": f"Bearer {_token}", "Dropbox-API-Arg": json.dumps({"path": dropbox_path})}
-    with requests.post("https://content.dropboxapi.com/2/files/download", headers=headers, stream=True, timeout=60) as r:
+    with requests.post("https://content.dropboxapi.com/2/files/download", headers=headers, stream=True, timeout=60) as response:
         try:
-            r.raise_for_status()
+            response.raise_for_status()
         except requests.exceptions.HTTPError as e:
-            raise FileNotFoundError(f"file {dropbox_path} not found. Original message is {e}") from None
+            raise FileNotFoundError(f"file {str(dropbox_path)} not found. Original message is {e}") from None
         chunks = []
-        for chunk in r.iter_content(chunk_size=1024):
+        for chunk in response.iter_content(chunk_size=1024):
             if chunk:
                 chunks.append(chunk)
     return b"".join(chunks)
@@ -195,9 +187,7 @@ def read_dropbox(dropbox_path):
 
 def write_dropbox(dropbox_path, contents):
     """
-    write_dropbox
-
-    write from dopbox at given path
+    write to file on dropbox
 
     Parameters
     ----------
@@ -216,12 +206,7 @@ def write_dropbox(dropbox_path, contents):
     headers = {
         "Authorization": f"Bearer {_token}",
         "Dropbox-API-Arg": json.dumps(
-            {
-                "path": dropbox_path,  # Where it will be saved in Dropbox
-                "mode": "overwrite",  # "add" or "overwrite"
-                "autorename": False,
-                "mute": False,
-            }
+            {"path": str(dropbox_path), "mode": "overwrite", "autorename": False, "mute": False}  # Where it will be saved in Dropbox  # "add" or "overwrite"
         ),
         "Content-Type": "application/octet-stream",
     }
@@ -230,25 +215,34 @@ def write_dropbox(dropbox_path, contents):
 
 
 def delete_from_dropbox(dropbox_path):
+    """
+    delete file dropbox
+
+    Parameters
+    ----------
+    dropbox_path : str or Pathlib.Path
+        path to delete
+
+    Note
+    ----
+    If REFRESH_TOKEN, APP_KEY and APP_SECRET environment variables are specified,
+    it is not necessary to call dropbox_init() prior to any dropbox function.
+    """
     _login_dropbox()
 
     headers = {"Authorization": f"Bearer {_token}", "Content-Type": "application/json"}
 
-    data = {
-        "path": dropbox_path  # Path in Dropbox, starting with /
-    }
+    data = {"path": str(dropbox_path)}  # Path in Dropbox, starting with /
 
     response = requests.post("https://api.dropboxapi.com/2/files/delete_v2", headers=headers, data=json.dumps(data))
     if response.status_code == 200:
-        return
+        return response
     raise FileNotFoundError(f"dropbox file {dropbox_path} not found")
 
 
 def list_local(path, recursive=False, show_files=True, show_folders=False):
     """
-    list_local
-
-    returns all local files/folders in path
+    returns all local files/folders at given path
 
     Parameters
     ----------
@@ -320,8 +314,7 @@ class block:
         self.dict = {}
         self.number_of_rows = number_of_rows
         self.number_of_columns = number_of_columns
-        self._highest_used_row_number = None
-        self._highest_used_column_number = None
+        self._invalidate_highest_used_cache()
 
     def __eq__(self, other):
         if isinstance(other, block):
@@ -495,17 +488,21 @@ class block:
     def value(self):
         return [[self.dict.get((row, column)) for column in range(1, self.number_of_columns + 1)] for row in range(1, self.number_of_rows + 1)]
 
+    def _invalidate_highest_used_cache(self):
+        self._highest_used_row_number = None
+        self._highest_used_column_number = None
+
     def __setitem__(self, row_column, value):
         row, column = row_column
         if row < 1 or row > self.number_of_rows:
-            raise IndexError(f"row must be between 1 and {self.number_of_rows} not {row}")
+            raise IndexError(f"row must be between 1 and {self.number_of_rows}; not {row}")
         if column < 1 or column > self.number_of_columns:
-            raise IndexError(f"column must be between 1 and {self.number_of_columns} not {column}")
+            raise IndexError(f"column must be between 1 and {self.number_of_columns}; not {column}")
         if value is None:
             if (row, column) in self.dict:
                 del self.dict[row, column]
-                self._highest_used_row_number = None  # invalidate cached value
-                self._highest_used_column_number = None  # invalidate cached value
+                self._invalidate_highest_used_cache()
+
         else:
             self.dict[row, column] = value
             if self._highest_used_row_number:
@@ -537,8 +534,8 @@ class block:
     @number_of_rows.setter
     def number_of_rows(self, value):
         if value < 1:
-            raise ValueError(f"number_of_rows should be >=1, not {value}")
-        self._highest_used_row_number = None
+            raise ValueError(f"number_of_rows should be >=1; not {value}")
+        self._invalidate_highest_used_cache()
         self._number_of_rows = value
         for row, column in list(self.dict):
             if row > self._number_of_rows:
@@ -551,8 +548,8 @@ class block:
     @number_of_columns.setter
     def number_of_columns(self, value):
         if value < 1:
-            raise ValueError(f"number_of_columns should be >=1, not {value}")
-        self._highest_used_column_number = None
+            raise ValueError(f"number_of_columns should be >=1; not {value}")
+        self._invalidate_highest_used_cache()
         self._number_of_columns = value
         for row, column in list(self.dict):
             if column > self._number_of_columns:
@@ -1042,3 +1039,4 @@ def trigger_macro(sheet):
 
 if __name__ == "__main__":
     ...
+

{xlwings_utils-25.1.1.dist-info → xlwings_utils-25.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.1.1
+Version: 25.1.2
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils

xlwings_utils-25.1.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
+xlwings_utils/xlwings_utils.py,sha256=z-N00D0O_0LyhDOhpHuAI2Ddphig40-LpgWS9rOIr_c,30481
+xlwings_utils-25.1.2.dist-info/METADATA,sha256=Kg-GSXueKT9vbNCTaX1EBt-4zB5k7JOHUezbhWBncMY,12265
+xlwings_utils-25.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xlwings_utils-25.1.2.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
+xlwings_utils-25.1.2.dist-info/RECORD,,

xlwings_utils-25.1.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
-xlwings_utils/xlwings_utils.py,sha256=yFbxuyrSkBhsr4OmUUI5ppYyNpb3T9bVi-7qeuDAPKI,30256
-xlwings_utils-25.1.1.dist-info/METADATA,sha256=7aBUGylo6jmsoyDbqbOiBZ9T8c9qeXb_KYLwVDdQPzg,12265
-xlwings_utils-25.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xlwings_utils-25.1.1.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
-xlwings_utils-25.1.1.dist-info/RECORD,,