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

xlwings_utils/xlwings_utils.py

@@ -679,7 +679,64 @@ 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
+        """
+
+        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):
+        """
+        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:
     """
     specifies how to capture stdout
@@ -785,71 +842,21 @@ class Capture:
     @include_print.setter
     def include_print(self, value):
         self._include_print = value
+        
 
-
-def trigger_VBA(book):
-    """
-    triggers the macro on sheet VBA in book
-
-    Parameters
-    ----------
-    book : xw.Book
-        book 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):
+def trigger(sheet):
     """
-    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()
+    triggers the macro on sheet
 
     Parameters
     ----------
-    book : xw.Book
-        book to use
-
-    file : string
-        name of file to be encoded
+    sheet : sheet
+        sheet to use
+        
     """
 
-    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.5.post0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.5
+Version: 25.0.5.post0
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -263,10 +263,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.
+
+Note that the sheet must have a worksheet named `VBA`, and the VBA code will normally reside there.
+
+There are three Python functions defined:
+
+  * `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)
+
+  * `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.
+
+The VBA code below can be used to decode encoded file(s) and write to the local file system.
+
+```
+Sub WriteFiles()
+    
+    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 = 1
+    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 Cells(4, 2) = "y" Then
+        ws.Range("A10:A1000000").Clear
+    End If
+    
+    If Count = 0 Then
+        MsgBox "No files written"
+    Else
+        MsgBox "Successfully 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.5.post0.dist-info/RECORD

@@ -0,0 +1,6 @@
+xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
+xlwings_utils/xlwings_utils.py,sha256=KP4RPmEyajLF2pn9IS3QEQyYC_xBn1yNoWzdh3cqqSo,25238
+xlwings_utils-25.0.5.post0.dist-info/METADATA,sha256=1amSYUkgWF76__slfIRyOpR-J-VbHjeoqmZxipWK21Q,13036
+xlwings_utils-25.0.5.post0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xlwings_utils-25.0.5.post0.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
+xlwings_utils-25.0.5.post0.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,,