xlwings-utils 25.0.9__tar.gz → 25.1.0__tar.gz

{xlwings_utils-25.0.9 → xlwings_utils-25.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.9
+Version: 25.1.0
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -9,7 +9,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: dropbox
 
  <img src="https://www.salabim.org/xlwings_utils_logo2.png">  
 
@@ -19,7 +18,7 @@ This module provides some useful functions to be used in xlwings (lite).
 
 ## Installation
 
-Just add `xlwings-utils` and `ssl` (even if `dropbox` is not used) to the *requirements.txt* tab. 
+Just add `xlwings-utils` to the *requirements.txt* tab. 
 
 In the script, add
 
@@ -66,10 +65,10 @@ The file `dropbox setup.py` can also be found in the repo of xlwings_lite .
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get at all folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is rather unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
-
 The function `write_dropbox` can be used to write contents (bytes) to a Dropbox file.
 
+The function `delete_from_dropbox` can be used to delete a Dropbox file.
+
 The functions `list_local`, `read_local` and `write_local` offer similar functionality for the local file system (on pyodide).
 
 So, a way to access a file on the system's drive (mapped to Dropbox) as a local file is:

{xlwings_utils-25.0.9 → xlwings_utils-25.1.0}/README.md

@@ -6,7 +6,7 @@ This module provides some useful functions to be used in xlwings (lite).
 
 ## Installation
 
-Just add `xlwings-utils` and `ssl` (even if `dropbox` is not used) to the *requirements.txt* tab. 
+Just add `xlwings-utils` to the *requirements.txt* tab. 
 
 In the script, add
 
@@ -53,10 +53,10 @@ The file `dropbox setup.py` can also be found in the repo of xlwings_lite .
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get at all folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is rather unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
-
 The function `write_dropbox` can be used to write contents (bytes) to a Dropbox file.
 
+The function `delete_from_dropbox` can be used to delete a Dropbox file.
+
 The functions `list_local`, `read_local` and `write_local` offer similar functionality for the local file system (on pyodide).
 
 So, a way to access a file on the system's drive (mapped to Dropbox) as a local file is:

{xlwings_utils-25.0.9 → xlwings_utils-25.1.0}/pyproject.toml

@@ -10,12 +10,10 @@ authors = [
     { name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com" },
 ]
 description = "xlwings_utils"
-version = "25.0.9"
+version = "25.1.0"
 readme = "README.md"
 requires-python = ">=3.9"
-dependencies = [
-    "dropbox",
-]
+dependencies = []
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python :: 3 :: Only",

{xlwings_utils-25.0.9 → xlwings_utils-25.1.0}/tests/test_xlwings_utils.py

@@ -67,6 +67,39 @@ def test_block2():
     assert this_block.value == [[1, 2, 3, None], [4, 5, 6, None], [None, None, None, None]]
 
 
+def test_highest_used():
+    this_block = xwu.block(number_of_rows=4, number_of_columns=4)
+    assert this_block._highest_used_row_number is None
+    assert this_block.highest_used_row_number == 1
+    assert this_block.highest_used_column_number == 1
+    this_block[2, 3] = 1
+    assert this_block._highest_used_row_number is not None
+    assert this_block.highest_used_row_number == 2
+    assert this_block.highest_used_column_number == 3
+    this_block[1, 2] = 1
+    assert this_block._highest_used_row_number is not None
+    assert this_block.highest_used_row_number == 2
+    assert this_block.highest_used_column_number == 3
+    this_block[3, 4] = 1
+    assert this_block._highest_used_row_number is not None
+    assert this_block.highest_used_row_number == 3
+    assert this_block.highest_used_column_number == 4
+    this_block[3, 4] = None
+    assert this_block._highest_used_row_number is None
+    assert this_block.highest_used_row_number == 2
+    assert this_block.highest_used_column_number == 3
+    this_block[2, 3] = None
+    assert this_block._highest_used_row_number is None
+    this_block[2, 3] = 1
+    assert this_block._highest_used_row_number is None
+    this_block[2, 3] = None
+    this_block[1, 2] = None
+    assert this_block._highest_used_row_number is None
+    assert this_block.highest_used_row_number == 1
+    assert this_block.highest_used_column_number == 1
+    assert this_block._highest_used_row_number is not None
+
+
 def test_block_one_dimension():
     this_block = xwu.block.from_value([1, 2, 3])
     assert this_block.value == [[1, 2, 3]]
@@ -79,20 +112,23 @@ def test_block_scalar():
     this_block = xwu.block.from_value(1)
     assert this_block.value == [[1]]
 
+
 def test_transpose():
     this_block = xwu.block.from_value([[1, 2, 3], [4, 5, 6]])
-    transposed_block=this_block.transposed()
-    assert transposed_block.value==[[1,4],[2,5],[3,6]]
+    transposed_block = this_block.transposed()
+    assert transposed_block.value == [[1, 4], [2, 5], [3, 6]]
+
 
 def test_delete_none():
     this_block = xwu.block.from_value([[1, 2, None], [4, 5, None]])
-    assert len(this_block.dict)==4
-    this_block[1,1]=None
-    assert len(this_block.dict)==3    
-    this_block[1,1]=None
-    assert len(this_block.dict)==3 
-    assert this_block.value==[[None, 2, None], [4, 5, None]]
-    
+    assert len(this_block.dict) == 4
+    this_block[1, 1] = None
+    assert len(this_block.dict) == 3
+    this_block[1, 1] = None
+    assert len(this_block.dict) == 3
+    assert this_block.value == [[None, 2, None], [4, 5, None]]
+
+
 def test_raise():
     this_block = xwu.block(number_of_rows=4, number_of_columns=6)
     with pytest.raises(IndexError):
@@ -115,52 +151,55 @@ def test_raise():
     with pytest.raises(IndexError):
         this_block[1, 7] = 1
 
+
 def test_lookup():
-    bl=xwu.block.from_value([[1,"One", "Un"],[2, "Two", "Deux"],[3,"Three","Trois"]])
-    assert bl.lookup(1)=="One"
-    assert bl.lookup(3, column2=3)=="Trois"
+    bl = xwu.block.from_value([[1, "One", "Un"], [2, "Two", "Deux"], [3, "Three", "Trois"]])
+    assert bl.lookup(1) == "One"
+    assert bl.lookup(3, column2=3) == "Trois"
     with pytest.raises(ValueError):
         bl.lookup(4)
-    assert bl.lookup(4,default='x')=='x'        
+    assert bl.lookup(4, default="x") == "x"
     with pytest.raises(ValueError):
         bl.lookup(1, column1=4)
     with pytest.raises(ValueError):
         bl.lookup(1, column1=3)
-    assert bl.lookup_row(1)==1
-    assert bl.lookup_row(3)==3
+    assert bl.lookup_row(1) == 1
+    assert bl.lookup_row(3) == 3
+
 
 def test_vookup():
-    bl=xwu.block.from_value([[1,"One", "Un"],[2, "Two", "Deux"],[3,"Three","Trois"]])
-    assert bl.vlookup(1)=="One"
-    assert bl.vlookup(3, column2=3)=="Trois"
+    bl = xwu.block.from_value([[1, "One", "Un"], [2, "Two", "Deux"], [3, "Three", "Trois"]])
+    assert bl.vlookup(1) == "One"
+    assert bl.vlookup(3, column2=3) == "Trois"
     with pytest.raises(ValueError):
         bl.vlookup(4)
-    assert bl.vlookup(4, default='x')=='x'
+    assert bl.vlookup(4, default="x") == "x"
     with pytest.raises(ValueError):
         bl.vlookup(1, column1=4)
     with pytest.raises(ValueError):
         bl.vlookup(1, column1=3)
 
+
 def test_hlookup():
-    bl=xwu.block.from_value([[1,2,3],"One Two Three".split(), "Un Deux Trois".split()])
-                 
-    assert bl.hlookup(1)=="One"
-    assert bl.hlookup(3, row2=3)=="Trois"
+    bl = xwu.block.from_value([[1, 2, 3], "One Two Three".split(), "Un Deux Trois".split()])
+
+    assert bl.hlookup(1) == "One"
+    assert bl.hlookup(3, row2=3) == "Trois"
     with pytest.raises(ValueError):
         bl.hlookup(4)
-    assert bl.hlookup(4,default='x')=='x'
+    assert bl.hlookup(4, default="x") == "x"
     with pytest.raises(ValueError):
         bl.hlookup(1, row1=4)
     with pytest.raises(ValueError):
         bl.hlookup(1, row1=3)
-    assert bl.lookup_column(1)==1
-    assert bl.lookup_column(3)==3
+    assert bl.lookup_column(1) == 1
+    assert bl.lookup_column(3) == 3
 
 
 def test_capture(capsys):
     print("abc")
     print("def")
-    capture=xwu.Capture()
+    capture = xwu.Capture()
     out, err = capsys.readouterr()
     assert out == "abc\ndef\n"
     assert capture.str_keep == ""
@@ -172,10 +211,10 @@ def test_capture(capsys):
     out, err = capsys.readouterr()
     assert out == ""
     assert capture.str_keep == "abc\ndef\n"
-    assert capture.value_keep == [['abc'], ['def']]
+    assert capture.value_keep == [["abc"], ["def"]]
     assert capture.str == "abc\ndef\n"
     assert capture.value == []
-        
+
     with capture:
         print("abc")
         print("def")
@@ -188,28 +227,27 @@ def test_capture(capsys):
         print("def")
     with capture:
         print("ghi")
-        print("jkl")        
+        print("jkl")
     out, err = capsys.readouterr()
     assert out == ""
-    assert capture.str_keep == "abc\ndef\nghi\njkl\n"        
-    assert capture.value_keep == [['abc'], ['def'], ['ghi'], ['jkl']]
-    assert capture.value == [['abc'], ['def'], ['ghi'], ['jkl']]    
+    assert capture.str_keep == "abc\ndef\nghi\njkl\n"
+    assert capture.value_keep == [["abc"], ["def"], ["ghi"], ["jkl"]]
+    assert capture.value == [["abc"], ["def"], ["ghi"], ["jkl"]]
     assert capture.value == []
-    
-    capture.enabled=True
+
+    capture.enabled = True
     print("abc")
-    print("def")    
-    capture.enabled=False
+    print("def")
+    capture.enabled = False
     print("xxx")
-    print("yyy")          
-    capture.enabled=True
+    print("yyy")
+    capture.enabled = True
     print("ghi")
-    print("jkl")        
-    assert capture.str_keep == "abc\ndef\nghi\njkl\n"      
+    print("jkl")
+    assert capture.str_keep == "abc\ndef\nghi\njkl\n"
+
+    # include_print is not testable with pytest
+
 
-    
-        # include_print is not testable with pytest
-    
 if __name__ == "__main__":
     pytest.main(["-vv", "-s", "-x", __file__])
-

{xlwings_utils-25.0.9 → xlwings_utils-25.1.0}/xlwings_utils/xlwings_utils.py

@@ -5,28 +5,33 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "25.0.9"
+__version__ = "25.1.0"
 
 
-import dropbox
 from pathlib import Path
 import os
 import sys
 import math
 import base64
+import requests
+import json
 
-dbx = None
 Pythonista = sys.platform == "ios"
+
 try:
     import xlwings
 
     xlwings = True
+    import pyodide_http
 
 except ImportError:
     xlwings = False
 
 missing = object()
 
+_token = None
+missing = object()
+
 
 def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **kwargs):
     """
@@ -59,7 +64,10 @@ def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **k
     -------
     dropbox object
     """
-    global dbx
+
+    global _token
+    if xlwings:
+        pyodide_http.patch_all()  # to enable chunked mode
 
     if refresh_token is missing:
         if "DROPBOX.REFRESH_TOKEN" in os.environ:
@@ -77,18 +85,22 @@ def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **k
         else:
             raise ValueError("no DROPBOX.APP_SECRET found in environment.")
 
-    _dbx = dropbox.Dropbox(oauth2_refresh_token=refresh_token, app_key=app_key, app_secret=app_secret, **kwargs)
+    resp = 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:
-        _dbx.files_list_folder(path="")  # just to test proper credentials
-    except dropbox.exceptions.AuthError:
+        resp.raise_for_status()
+    except requests.exceptions.HTTPError:
         raise ValueError("invalid dropbox credentials")
-    return _dbx
+    _token = resp.json()["access_token"]
 
 
-def _login_dbx():
-    global dbx
-    if dbx is None:
-        dbx = dropbox_init()  # use environment
+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):
@@ -122,28 +134,31 @@ def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
     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_dbx()
-    out = []
-    result = dbx.files_list_folder(path, recursive=recursive)
+    _login_dropbox()
+
+    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()
+    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()
+        entries.extend(data["entries"])
 
-    for entry in result.entries:
-        if show_files and isinstance(entry, dropbox.files.FileMetadata):
-            out.append(entry.path_display)
-        if show_folders and isinstance(entry, dropbox.files.FolderMetadata):
-            out.append(entry.path_display + "/")
-
-    while result.has_more:
-        result = dbx.files_list_folder_continue(result.cursor)
-        for entry in result.entries:
-            if show_files and isinstance(entry, dropbox.files.FileMetadata):
-                out.append(entry.path_display)
-            if show_folders and isinstance(entry, dropbox.files.FolderMetadata):
-                out.append(entry.path_display + "/")
-
-    return out
+    result = []
+    for entry in entries:
+        if show_files and entry[".tag"] == "file":
+            result.append(entry["path_display"])
+        if show_folders and entry[".tag"] == "folder":
+            result.append(entry["path_display"] + "/")
+    return result
 
 
-def read_dropbox(dropbox_path, max_retries=100):
+def read_dropbox(dropbox_path):
     """
     read_dropbox
 
@@ -154,9 +169,6 @@ def read_dropbox(dropbox_path, max_retries=100):
     dropbox_path : str or Pathlib.Path
         path to read from
 
-    max_retries : int
-        number of retries (default: 100)
-
     Returns
     -------
     contents of the dropbox file : bytes
@@ -165,18 +177,20 @@ def read_dropbox(dropbox_path, max_retries=100):
     ----
     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.
-
-    As reading from dropbox is very unreliable under pyodide, reading will have to be retried (by default maximum 100 times).
-    The number of retries can be found with read_dropbox.retries.
     """
 
-    _login_dbx()
-    for read_dropbox.retries in range(max_retries + 1):
-        metadata, response = dbx.files_download(dropbox_path)
-        file_content = response.content
-        if len(file_content) == metadata.size:
-            return file_content
-    raise OSError(f"after {max_retries} still no valid response")
+    _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:
+        try:
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            raise FileNotFoundError(f"file {dropbox_path} not found. Original message is {e}") from None
+        chunks = []
+        for chunk in r.iter_content(chunk_size=1024):
+            if chunk:
+                chunks.append(chunk)
+    return b"".join(chunks)
 
 
 def write_dropbox(dropbox_path, contents):
@@ -198,8 +212,36 @@ def write_dropbox(dropbox_path, contents):
     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_dbx()
-    dbx.files_upload(contents, dropbox_path, mode=dropbox.files.WriteMode.overwrite)
+    _login_dropbox()
+    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,
+            }
+        ),
+        "Content-Type": "application/octet-stream",
+    }
+    response = requests.post("https://content.dropboxapi.com/2/files/upload", headers=headers, data=contents)
+    return response
+
+
+def delete_from_dropbox(dropbox_path):
+    _login_dropbox()
+
+    headers = {"Authorization": f"Bearer {_token}", "Content-Type": "application/json"}
+
+    data = {
+        "path": 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
+    raise FileNotFoundError(f"dropbox file {dropbox_path} not found")
 
 
 def list_local(path, recursive=False, show_files=True, show_folders=False):
@@ -278,6 +320,8 @@ 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
 
     def __eq__(self, other):
         if isinstance(other, block):
@@ -460,8 +504,14 @@ class block:
         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
         else:
             self.dict[row, column] = value
+            if self._highest_used_row_number:
+                self._highest_used_row_number = max(self._highest_used_row_number, row)
+            if self._highest_used_column_number:
+                self._highest_used_column_number = max(self._highest_used_column_number, column)
 
     def __getitem__(self, row_column):
         row, column = row_column
@@ -488,6 +538,7 @@ class block:
     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
         self._number_of_rows = value
         for row, column in list(self.dict):
             if row > self._number_of_rows:
@@ -501,6 +552,7 @@ class block:
     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
         self._number_of_columns = value
         for row, column in list(self.dict):
             if column > self._number_of_columns:
@@ -508,17 +560,22 @@ class block:
 
     @property
     def highest_used_row_number(self):
-        if self.dict:
-            return max(row for (row, column) in self.dict)
-        else:
-            return 1
+        if not self._highest_used_row_number:
+            if self.dict:
+                self._highest_used_row_number = max(row for (row, column) in self.dict)
+            else:
+                self._highest_used_row_number = 1
+        return self._highest_used_row_number
 
     @property
     def highest_used_column_number(self):
-        if self.dict:
-            return max(column for (row, column) in self.dict)
-        else:
-            return 1
+        if not self._highest_used_column_number:
+            if self.dict:
+                self._highest_used_column_number = max(column for (row, column) in self.dict)
+            else:
+                self._highest_used_column_number = 1
+
+        return self._highest_used_column_number
 
     def __repr__(self):
         return f"block({self.value})"