xlwings-utils 25.0.5.post0__tar.gz → 25.0.6__tar.gz

{xlwings_utils-25.0.5.post0 → xlwings_utils-25.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.5.post0
+Version: 25.0.6
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -62,8 +62,7 @@ python -c "exec(__import__('requests').get('https://salabim.org/dropbox setup.py
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get the folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. If the file is not read correctly, which seems
-to happen rather frequently, an OSError exception is raised.
+The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is very 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.
 
@@ -267,31 +266,34 @@ Clearing the captured stdout buffer can be done at any time with `capture.clear(
 
 Currently, *xlwings Lite* does not provide access to the local file system. Therefore, xlwings_utils offers some functionality to trigger a VBA script as well as functionality to encode a file in the pyodide file system to a VBA sheet and to trigger writing the encoded file(s) to the local file system.
 
-Note that the sheet must have a worksheet named `VBA`, and the VBA code will normally reside there.
+Files can be encoded into a block, like:
 
-There are three Python functions defined:
+```
+    bl = xwu.block.encode_files("film1.mp4", "settings.txt")
+    book.sheets["VBA"].range((10,2)).value=bl.value
+```
 
-  * `trigger_VBA()`
-    fires a VBA script, provided a VBA function is defined on the sheet, like:
-    
-    ```
-    Sub Worksheet_Calculate()
-        If Me.Range("A1").Formula = "=NOW()" Then
-            Me.Range("A1").Value = Null
-            REM Code to run 
-        End If
-    End Sub
-    ```
-  * `init_transfer_files()`
-    This should be called prior to any `transfer_file` call. It just removes all encoded files from the VBA sheet (if any)
+With this code, column B will be filled with encoded copies of the files *film1.mp4* and *settings.txt* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
+
+```
+Private Sub Worksheet_Calculate()
+    If Me.Range("A1").Formula = "=NOW()" Then
+        Me.Range("A1").Value = Null
+        Call MacroToExecute
+    End If
+End Sub
+```
+
+, where `MacroToExecute` should contain the user code, most likely code to decode files encoded with something like
 
-  * `transfer_file()`
-    Can be used to encode a file on the pyodide file system to the VBA sheet. Multiple files are allowed. The file name will be encoded on the sheet as well.
+```
+bl.decode_to_files()
+```
 
-The VBA code below can be used to decode encoded file(s) and write to the local file system.
+The VBA code below can be used to decode encoded file(s ) on a worksheet.
 
 ```
-Sub WriteFiles()
+Sub DecodeFiles()
     
     Dim vArr() As Byte
     Dim S As String
@@ -301,7 +303,7 @@ Sub WriteFiles()
     Dim Count As Integer
     Dim FileNames As String
     
-    Column = 1
+    Column = 2
     Row = 1
     
     ThisDir = ThisWorkbook.Path
@@ -336,14 +338,11 @@ Sub WriteFiles()
         Row = Row + 1
     
     Wend
-    If Cells(4, 2) = "y" Then
-        ws.Range("A10:A1000000").Clear
-    End If
     
     If Count = 0 Then
-        MsgBox "No files written"
+        MsgBox "No files to decode"
     Else
-        MsgBox "Successfully written " & Str(Count) & " file(s): " & FileNames
+        MsgBox "Successfully decoded and written " & Str(Count) & " file(s): " & FileNames
     End If
 ```
 

{xlwings_utils-25.0.5.post0 → xlwings_utils-25.0.6}/README.md

@@ -49,8 +49,7 @@ python -c "exec(__import__('requests').get('https://salabim.org/dropbox setup.py
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get the folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. If the file is not read correctly, which seems
-to happen rather frequently, an OSError exception is raised.
+The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is very 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.
 
@@ -254,31 +253,34 @@ Clearing the captured stdout buffer can be done at any time with `capture.clear(
 
 Currently, *xlwings Lite* does not provide access to the local file system. Therefore, xlwings_utils offers some functionality to trigger a VBA script as well as functionality to encode a file in the pyodide file system to a VBA sheet and to trigger writing the encoded file(s) to the local file system.
 
-Note that the sheet must have a worksheet named `VBA`, and the VBA code will normally reside there.
+Files can be encoded into a block, like:
 
-There are three Python functions defined:
+```
+    bl = xwu.block.encode_files("film1.mp4", "settings.txt")
+    book.sheets["VBA"].range((10,2)).value=bl.value
+```
 
-  * `trigger_VBA()`
-    fires a VBA script, provided a VBA function is defined on the sheet, like:
-    
-    ```
-    Sub Worksheet_Calculate()
-        If Me.Range("A1").Formula = "=NOW()" Then
-            Me.Range("A1").Value = Null
-            REM Code to run 
-        End If
-    End Sub
-    ```
-  * `init_transfer_files()`
-    This should be called prior to any `transfer_file` call. It just removes all encoded files from the VBA sheet (if any)
+With this code, column B will be filled with encoded copies of the files *film1.mp4* and *settings.txt* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
+
+```
+Private Sub Worksheet_Calculate()
+    If Me.Range("A1").Formula = "=NOW()" Then
+        Me.Range("A1").Value = Null
+        Call MacroToExecute
+    End If
+End Sub
+```
+
+, where `MacroToExecute` should contain the user code, most likely code to decode files encoded with something like
 
-  * `transfer_file()`
-    Can be used to encode a file on the pyodide file system to the VBA sheet. Multiple files are allowed. The file name will be encoded on the sheet as well.
+```
+bl.decode_to_files()
+```
 
-The VBA code below can be used to decode encoded file(s) and write to the local file system.
+The VBA code below can be used to decode encoded file(s ) on a worksheet.
 
 ```
-Sub WriteFiles()
+Sub DecodeFiles()
     
     Dim vArr() As Byte
     Dim S As String
@@ -288,7 +290,7 @@ Sub WriteFiles()
     Dim Count As Integer
     Dim FileNames As String
     
-    Column = 1
+    Column = 2
     Row = 1
     
     ThisDir = ThisWorkbook.Path
@@ -323,14 +325,11 @@ Sub WriteFiles()
         Row = Row + 1
     
     Wend
-    If Cells(4, 2) = "y" Then
-        ws.Range("A10:A1000000").Clear
-    End If
     
     If Count = 0 Then
-        MsgBox "No files written"
+        MsgBox "No files to decode"
     Else
-        MsgBox "Successfully written " & Str(Count) & " file(s): " & FileNames
+        MsgBox "Successfully decoded and written " & Str(Count) & " file(s): " & FileNames
     End If
 ```
 

{xlwings_utils-25.0.5.post0 → xlwings_utils-25.0.6}/pyproject.toml

@@ -10,7 +10,7 @@ authors = [
     { name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com" },
 ]
 description = "xlwings_utils"
-version = "25.0.5.post0"
+version = "25.0.6"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [

{xlwings_utils-25.0.5.post0 → xlwings_utils-25.0.6}/xlwings_utils/xlwings_utils.py

@@ -5,7 +5,7 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "25.0.5"
+__version__ = "25.0.6"
 
 
 import dropbox
@@ -155,7 +155,7 @@ def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
     return out
 
 
-def read_dropbox(dropbox_path):
+def read_dropbox(dropbox_path, max_retries=100):
     """
     read_dropbox
 
@@ -166,6 +166,9 @@ def read_dropbox(dropbox_path):
     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
@@ -175,16 +178,17 @@ def read_dropbox(dropbox_path):
     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.
 
-    If the file size does not match the metadata, as sometimes happens on pyodide, an OSError exception will be raised.
+    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()
-    metadata, response = dbx.files_download(dropbox_path)
-    file_content = response.content
-    if len(file_content) != metadata.size:
-        raise OSError(f"file size ({len(file_content)}) does not match metadata ({metadata.size})")
-    return file_content
-
+    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")
 
 def write_dropbox(dropbox_path, contents):
     _login_dbx()
@@ -680,29 +684,26 @@ class block:
         return self.vlookup(s, row_from=row_from, row_to=row_to, column1=column1, column2=column2, default=default)
 
     def decode_to_files(self):
-        """ 
+        """
         decode the block with encoded file(s) to individual local files
         """
+        for column in self.number_of_columns:
+            row = 1
+            while row <= self.number_of_rows:
+                if self[row, column] and self[row, column].startswith("<file=") and self[row, column].endswith(">"):
+                    filename = self[row, column][6:-1]
+                    collect = []
+                    row += 1
+                    while self[row, column] != "</file>":
+                        print(f"{self[row,column]=}")
+
+                        if self[row, column]:
+                            collect.append(self[row, column])
+                        row += 1
+                    decoded = base64.b64decode("".join(collect))
+                    open(filename, "wb").write(decoded)
+                row += 1
 
-        row=1
-        while row<=self.number_of_rows:
-            if self[row,1] and self[row,1].startswith('<file=') and self[row,1].endswith('>'):
-                filename=self[row,1][6:-1]
-                collect=[]
-                row+=1
-                print(f"{filename=}")
-
-                while self[row,1]!='</file>':
-                    print(f"{self[row,1]=}")
-
-                    if self[row,1]:
-                        collect.append(self[row,1])
-                    row+=1
-                print(f"{collect=}")
-                decoded=base64.b64decode(''.join(collect))
-                open(filename,'wb').write(decoded)
-            row+=1
-            
     @classmethod
     def encode_files(cls, *files):
         """
@@ -711,7 +712,7 @@ class block:
         Parameters
         ----------
         files : file names (str)
-            files to be encoded 
+            files to be encoded
 
         Returns
         -------
@@ -719,8 +720,8 @@ class block:
             not minimized!
         """
 
-        bl =cls(number_of_rows=50000, number_of_columns=1)
-        
+        bl = cls(number_of_rows=50000, number_of_columns=1)
+
         n = 5000  # block size
         row = 1
         for file in files:
@@ -733,10 +734,10 @@ class block:
                 row += 1
                 b64 = b64[n:]
             bl[row, 1] = f"</file>"
-            row+=1    
+            row += 1
         return bl
-            
-    
+
+
 class Capture:
     """
     specifies how to capture stdout
@@ -842,9 +843,8 @@ class Capture:
     @include_print.setter
     def include_print(self, value):
         self._include_print = value
-        
 
-def trigger(sheet):
+def trigger_macro(sheet):
     """
     triggers the macro on sheet
 
@@ -852,11 +852,12 @@ def trigger(sheet):
     ----------
     sheet : sheet
         sheet to use
-        
+
     """
 
     sheet["A1"].value = "=NOW()"
 
-        
+
 if __name__ == "__main__":
     ...
+

{xlwings_utils-25.0.5.post0 → xlwings_utils-25.0.6}/xlwings_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.5.post0
+Version: 25.0.6
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -62,8 +62,7 @@ python -c "exec(__import__('requests').get('https://salabim.org/dropbox setup.py
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get the folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. If the file is not read correctly, which seems
-to happen rather frequently, an OSError exception is raised.
+The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is very 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.
 
@@ -267,31 +266,34 @@ Clearing the captured stdout buffer can be done at any time with `capture.clear(
 
 Currently, *xlwings Lite* does not provide access to the local file system. Therefore, xlwings_utils offers some functionality to trigger a VBA script as well as functionality to encode a file in the pyodide file system to a VBA sheet and to trigger writing the encoded file(s) to the local file system.
 
-Note that the sheet must have a worksheet named `VBA`, and the VBA code will normally reside there.
+Files can be encoded into a block, like:
 
-There are three Python functions defined:
+```
+    bl = xwu.block.encode_files("film1.mp4", "settings.txt")
+    book.sheets["VBA"].range((10,2)).value=bl.value
+```
 
-  * `trigger_VBA()`
-    fires a VBA script, provided a VBA function is defined on the sheet, like:
-    
-    ```
-    Sub Worksheet_Calculate()
-        If Me.Range("A1").Formula = "=NOW()" Then
-            Me.Range("A1").Value = Null
-            REM Code to run 
-        End If
-    End Sub
-    ```
-  * `init_transfer_files()`
-    This should be called prior to any `transfer_file` call. It just removes all encoded files from the VBA sheet (if any)
+With this code, column B will be filled with encoded copies of the files *film1.mp4* and *settings.txt* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
+
+```
+Private Sub Worksheet_Calculate()
+    If Me.Range("A1").Formula = "=NOW()" Then
+        Me.Range("A1").Value = Null
+        Call MacroToExecute
+    End If
+End Sub
+```
+
+, where `MacroToExecute` should contain the user code, most likely code to decode files encoded with something like
 
-  * `transfer_file()`
-    Can be used to encode a file on the pyodide file system to the VBA sheet. Multiple files are allowed. The file name will be encoded on the sheet as well.
+```
+bl.decode_to_files()
+```
 
-The VBA code below can be used to decode encoded file(s) and write to the local file system.
+The VBA code below can be used to decode encoded file(s ) on a worksheet.
 
 ```
-Sub WriteFiles()
+Sub DecodeFiles()
     
     Dim vArr() As Byte
     Dim S As String
@@ -301,7 +303,7 @@ Sub WriteFiles()
     Dim Count As Integer
     Dim FileNames As String
     
-    Column = 1
+    Column = 2
     Row = 1
     
     ThisDir = ThisWorkbook.Path
@@ -336,14 +338,11 @@ Sub WriteFiles()
         Row = Row + 1
     
     Wend
-    If Cells(4, 2) = "y" Then
-        ws.Range("A10:A1000000").Clear
-    End If
     
     If Count = 0 Then
-        MsgBox "No files written"
+        MsgBox "No files to decode"
     Else
-        MsgBox "Successfully written " & Str(Count) & " file(s): " & FileNames
+        MsgBox "Successfully decoded and written " & Str(Count) & " file(s): " & FileNames
     End If
 ```