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

xlwings_utils/xlwings_utils.py

@@ -5,7 +5,7 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "25.0.4"
+__version__ = "25.0.5"
 
 
 import dropbox
@@ -13,6 +13,7 @@ from pathlib import Path
 import os
 import sys
 import math
+import base64
 
 dbx = None
 Pythonista = sys.platform == "ios"
@@ -678,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
@@ -784,7 +842,21 @@ class Capture:
     @include_print.setter
     def include_print(self, value):
         self._include_print = value
+        
 
+def trigger(sheet):
+    """
+    triggers the macro on sheet
 
+    Parameters
+    ----------
+    sheet : sheet
+        sheet to use
+        
+    """
+
+    sheet["A1"].value = "=NOW()"
+
+        
 if __name__ == "__main__":
     ...

{xlwings_utils-25.0.4.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.4
+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
@@ -19,7 +19,7 @@ This module provides some useful functions to be used in xlwings (lite).
 
 ## Installation
 
-Just add `xlwings-utils` and `ssl` to the *requirements.txt* tab. 
+Just add `xlwings-utils` and `ssl` (even if `dropbox` is not used) to the *requirements.txt* tab. 
 
 In the script, add
 
@@ -49,7 +49,7 @@ If an application runs under xlwings, `xwu.xlwings` will be True. False, if not.
 
 The xlwings lite system does not provide access to the local file system. With this module, files can be copied between Dropbox and the local pyodide file system, making it possible to indirectly use the local file system.
 
-It is only possible, as of now, to use full-access Dropbox apps.
+Currently, it is only possible to use full-access Dropbox apps.
 
 The easiest way to use the Dropbox functionality is to add the credentials to the environment variables. Add REFRESH_TOKEN, APP_KEY and APP_SECRET with their corresponding values to the environment variables. Instructions on how to get these variables can be found here.
 
@@ -86,7 +86,7 @@ xwu.write_dropbox('/downloads/file1.gif')
 ## Block support
 
 The module contains a useful 2-dimensional data structure: *block*.
-This can be useful to manipulate a range without accessing the range directly, which is expensive in terms of memory and execution time.
+This can be useful for manipulating a range without accessing it directly, which is expensive in terms of memory and execution time.
 The advantage over an ordinary list of lists is that a block is index one-based, in line with range and addressing is done with a row, column tuple.
 So, `my_block(lol)[row, col]` is roughly equivalent to `lol[row-1][col-1]`
 
@@ -136,7 +136,7 @@ for row in range(1, 10001):
 	this_block[row,2]= ...
 	if ...: # end condition
 	    break
-sheet.range(10,1).value = this_block.minimized().value
+sheet.range((10,1)).value = this_block.minimized().value
 ```
 
 In this case, only the really processed rows are copied to the sheet.
@@ -195,11 +195,11 @@ We then read the following rows (using hlookups) and access the required values.
 
 ### Filling a block from other sources
 
-The advantage of using a block instead of accessing these sources is	 that they are one-based, just like in Excel.
+The advantage of using a block instead of accessing these sources is that they are one-based, just like in Excel.
 
 It is possible to make a block from an xlrd worksheet with `block.from_xlrd_sheet`. 
 
-It is possible to make a block from a pandas dataframe with `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
+It is possible to create a block from a Pandas DataFrame using `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
 
 It is possible to make a block from an openpyxl worksheet with `block.from_openpyxl_sheet`. 
 
@@ -235,9 +235,9 @@ capture = xwu.Capture(include_print=True)
 
 the stdout output is captured and printed.
 
-Capturing van be enabled and disabled at any time with `capture.enbaled = True` and `capture.enabled = False`.
+Capturing can be enabled and disabled at any time with `capture.enabled = True` and `capture.enabled = False`.
 
-And including print likewise with `capture.include_print`.
+And include print, likewise, with `capture.include_print`.
 
 Alternatively, a context manager is provided:
 
@@ -250,7 +250,7 @@ with capture:
 ```
 Note that stopping the capture, leaves the captured output in place, so it can be extended later.
 
-In either case, the captured output can be then copied to a sheet, like
+In either case, the captured output can then be copied to a sheet, like
 
 ```
 sheet.range(4,5).value = capture.value
@@ -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.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
-xlwings_utils/xlwings_utils.py,sha256=LF7niTS7WnNSoJunwuhF5OYP7yVsLK70Zt59lY0SbMs,23376
-xlwings_utils-25.0.4.dist-info/METADATA,sha256=4pWOuXUtYWkBq4rEEDxIkmITWVECrMzh-PxdlpQ-SXc,10286
-xlwings_utils-25.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xlwings_utils-25.0.4.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
-xlwings_utils-25.0.4.dist-info/RECORD,,