xlwings-utils 25.0.5__py3-none-any.whl → 25.0.6__py3-none-any.whl

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()
@@ -679,6 +683,60 @@ 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
+
+    @classmethod
+    def encode_files(cls, *files):
+        """
+        make a block with the given files encoded
+
+        Parameters
+        ----------
+        files : file names (str)
+            files to be encoded
+
+        Returns
+        -------
+        block with encoded files : block
+            not minimized!
+        """
+
+        bl = cls(number_of_rows=50000, number_of_columns=1)
+
+        n = 5000  # block size
+        row = 1
+        for file in files:
+            bl[row, 1] = f"<file={file}>"
+            row += 1
+            b64 = base64.b64encode(open(file, "rb").read()).decode("utf-8")
+            while b64:
+                b64_n = b64[:n]
+                bl[row, 1] = b64_n
+                row += 1
+                b64 = b64[n:]
+            bl[row, 1] = f"</file>"
+            row += 1
+        return bl
+
 
 class Capture:
     """
@@ -786,70 +844,20 @@ class Capture:
     def include_print(self, value):
         self._include_print = value
 
-
-def trigger_VBA(book):
+def trigger_macro(sheet):
     """
-    triggers the macro on sheet VBA in book
+    triggers the macro on sheet
 
     Parameters
     ----------
-    book : xw.Book
-        book to use
-    """
+    sheet : sheet
+        sheet to use
 
-    book.sheets["VBA"]["A1"].value = "=NOW()"
-
-
-def init_transfer_files(book):
-    """
-    initializes the file info on sheet VBA in book
-
-    should be called prior to calling any transfer_file()
-
-    Parameters
-    ----------
-    book : xw.Book
-        book to use
-    """
-
-    global row1
-    book.sheets["VBA"].range((10, 1), (1000000, 1)).clear()
-    row1 = 10
-
-
-def transfer_file(book, file):
     """
-    makes the local file to be encoded on sheet VBA in book
-    to be triggered later
 
-    init_transfer_files should be called prior to any transfer_file()
-
-    Parameters
-    ----------
-    book : xw.Book
-        book to use
-
-    file : string
-        name of file to be encoded
-    """
-
-    global row1
-    ws = book.sheets("VBA")
-    ws_block = block(number_of_rows=50000, number_of_columns=1)
-    n = 5000  # block size
-    row = 1
-    ws_block[row, 1] = f"<file={file}>"
-    row += 1
-    b64 = base64.b64encode(open(file, "rb").read()).decode("utf-8")
-    while b64:
-        b64_n = b64[:n]
-        ws_block[row, 1] = b64_n
-        row += 1
-        b64 = b64[n:]
-    ws_block[row, 1] = f"</file>"
-    ws.range((row1, 1)).value = ws_block.minimized().value
-    row1 += ws_block.highest_used_row_number
+    sheet["A1"].value = "=NOW()"
 
 
 if __name__ == "__main__":
     ...
+

{xlwings_utils-25.0.5.dist-info → xlwings_utils-25.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.5
+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.
 
@@ -263,10 +262,93 @@ The capture buffer can also be retrieved as a string with `capture.str` and `cap
 
 Clearing the captured stdout buffer can be done at any time with `capture.clear()`.
 
+## Functionality for accessing local files via VBA
+
+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.
+
+Files can be encoded into a block, like:
+
+```
+    bl = xwu.block.encode_files("film1.mp4", "settings.txt")
+    book.sheets["VBA"].range((10,2)).value=bl.value
+```
+
+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
+
+```
+bl.decode_to_files()
+```
+
+The VBA code below can be used to decode encoded file(s ) on a worksheet.
+
+```
+Sub DecodeFiles()
+    
+    Dim vArr() As Byte
+    Dim S As String
+    Dim Column As Integer
+    Dim Row As Integer
+    Dim ws As Worksheet
+    Dim Count As Integer
+    Dim FileNames As String
+    
+    Column = 2
+    Row = 1
+    
+    ThisDir = ThisWorkbook.Path
+    Set ws = Me
+    Count = 0
+    While Row < 30000
+        Line = ws.Cells(Row, Column)
+        If InStr(Line, "<file=") = 1 And Right(Line, 1) = ">" Then
+            If Count <> 0 Then
+                FileNames = FileNames & ", "
+            End If
+            Count = Count + 1
+            FileNameOnly = Mid(Line, 7, Len(Line) - 7)
+            Filename = ThisDir & "/" & FileNameOnly
+            FileNames = FileNames & FileNameOnly
+            
+            Row = Row + 1
+            S = ""
+            While ws.Cells(Row, Column) <> "</file>"
+                S = S & ws.Cells(Row, Column)
+                Row = Row + 1
+            Wend
+                
+            vArr = Base64ToArray(S)
+        
+            Open Filename For Binary Access Write As #1
+            WritePos = 1
+            Put #1, WritePos, vArr
+            Close #1
+        End If
+        
+        Row = Row + 1
+    
+    Wend
+    
+    If Count = 0 Then
+        MsgBox "No files to decode"
+    Else
+        MsgBox "Successfully decoded and written " & Str(Count) & " file(s): " & FileNames
+    End If
+```
 
 ## Contact info
 
-You can contact Ruud van der Ham, the core developer, via ruud@salabim.org .
+You can contact Ruud van der Ham, the core developer, at ruud@salabim.org.
 
 ## Badges
 

xlwings_utils-25.0.6.dist-info/RECORD

@@ -0,0 +1,6 @@
+xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
+xlwings_utils/xlwings_utils.py,sha256=5glVg37dkRfHSBT-gcSK-aKqAl-prDmRYcVh-Im0wt4,25463
+xlwings_utils-25.0.6.dist-info/METADATA,sha256=aK8ufY5s5Wp7x1iU11g2dRNGaWRXOx67VAsM0wJJV6I,13139
+xlwings_utils-25.0.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xlwings_utils-25.0.6.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
+xlwings_utils-25.0.6.dist-info/RECORD,,

xlwings_utils-25.0.5.dist-info/RECORD

@@ -1,6 +0,0 @@
-xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
-xlwings_utils/xlwings_utils.py,sha256=LT2NxlvS0T9wY4Qi9UiINpS1S1nmM2IutoBgkWk3JDo,24760
-xlwings_utils-25.0.5.dist-info/METADATA,sha256=MBHmRPFi-ytcOioOS2oII7pWN9e6SyOXHV_M3CVSJBs,10317
-xlwings_utils-25.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xlwings_utils-25.0.5.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
-xlwings_utils-25.0.5.dist-info/RECORD,,