xlwings-utils 25.0.7.post0__py3-none-any.whl → 25.0.8__py3-none-any.whl

xlwings_utils/xlwings_utils.py

@@ -5,7 +5,7 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "25.0.7"
+__version__ = "25.0.8"
 
 
 import dropbox
@@ -20,20 +20,48 @@ Pythonista = sys.platform == "ios"
 try:
     import xlwings
 
+    xlwings = True
+
 except ImportError:
     xlwings = False
 
 missing = object()
 
 
+def pythonista_environ():
+    """
+    tries to update environment variables from the file environ.toml at top level.
+    should only be used under Pythonista
+    """
+    try:
+        import tomlib
+    except ModuleNotFoundError:
+        import tomli as tomlib
+    from pathlib import Path
+    import os
+
+    environ_file = Path("~/Documents").expanduser() / "environ.toml"
+    with open(environ_file, "rb") as f:
+        d0 = tomlib.load(f)
+        d1 = {}
+        for k0, v0 in d0.items():
+            if isinstance(v0, dict):
+                for k1, v1 in v0.items():
+                    d1[f"{k0}.{k1}".upper()] = v1
+            else:
+                d1[k0.upper()] = v0
+
+        os.environ.update(d1)
+
+
 def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **kwargs):
     """
     dropbox initialize
 
     This function may to be called prior to using any dropbox function
     to specify the request token, app key and app secret.
-    If these are specified as REFRESH_TOKEN, APP_KEY and APP_SECRET
-    environment variables, it is no necessary to call dropbox_init().
+    If these are specified as DROPBOX.REFRESH_TOKEN, DROPBOX.APP_KEY and DROPBOX.APP_SECRET
+    environment variables, it is not necessary to call dropbox_init().
 
     Parameters
     ----------
@@ -55,47 +83,41 @@ def dropbox_init(refresh_token=missing, app_key=missing, app_secret=missing, **k
 
     Returns
     -------
-    -
+    dropbox object
     """
     global dbx
 
     if Pythonista:
-        # under Pythonista, the environ is updated from the .environ.toml file, if present
-        environ_file = Path(os.environ["HOME"]) / "Documents" / ".environ.toml"
-
-        if environ_file.is_file():
-            with open(environ_file, "r") as f:
-                import toml
-
-                d = toml.load(f)
-                os.environ.update(d)
+        pythonista_environ()
 
     if refresh_token is missing:
-        if "REFRESH_TOKEN" in os.environ:
-            refresh_token = os.environ["REFRESH_TOKEN"]
+        if "DROPBOX.REFRESH_TOKEN" in os.environ:
+            refresh_token = os.environ["DROPBOX.REFRESH_TOKEN"]
         else:
-            raise ValueError("no REFRESH_TOKEN found in environment.")
+            raise ValueError("no DROPBOX.REFRESH_TOKEN found in environment.")
     if app_key is missing:
-        if "APP_KEY" in os.environ:
-            app_key = os.environ["APP_KEY"]
+        if "DROPBOX.APP_KEY" in os.environ:
+            app_key = os.environ["DROPBOX.APP_KEY"]
         else:
-            raise ValueError("no APP_KEY found in environment.")
+            raise ValueError("no DROPBOX.APP_KEY found in environment.")
     if app_secret is missing:
-        if "APP_SECRET" in os.environ:
-            app_secret = os.environ["APP_SECRET"]
+        if "DROPBOX.APP_SECRET" in os.environ:
+            app_secret = os.environ["DROPBOX.APP_SECRET"]
         else:
-            raise ValueError("no APP_SECRET found in environment.")
+            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)
+    _dbx = dropbox.Dropbox(oauth2_refresh_token=refresh_token, app_key=app_key, app_secret=app_secret, **kwargs)
     try:
-        dbx.files_list_folder(path="")  # just to test proper credentials
+        _dbx.files_list_folder(path="")  # just to test proper credentials
     except dropbox.exceptions.AuthError:
         raise ValueError("invalid dropbox credentials")
+    return _dbx
 
 
 def _login_dbx():
+    global dbx
     if dbx is None:
-        dropbox_init()  # use environment
+        dbx = dropbox_init()  # use environment
 
 
 def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
@@ -110,7 +132,7 @@ def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
         path from which to list all files (default: '')
 
     recursive : bool
-        if True, recursively list files. if False (default) no recursion
+        if True, recursively list files and folders. if False (default) no recursion
 
     show_files : bool
         if True (default), show file entries
@@ -124,10 +146,6 @@ def list_dropbox(path="", recursive=False, show_files=True, show_folders=False):
     -------
     files : list
 
-    Note
-    ----
-    Directory entries are never returned
-
     Note
     ----
     If REFRESH_TOKEN, APP_KEY and APP_SECRET environment variables are specified,
@@ -290,6 +308,11 @@ class block:
         self.number_of_rows = number_of_rows
         self.number_of_columns = number_of_columns
 
+    def __eq__(self, other):
+        if isinstance(other, block):
+            return self.value == other.value
+        return False
+
     @classmethod
     def from_value(cls, value, column_like=False):
         """
@@ -297,18 +320,12 @@ class block:
 
         Parameters
         ----------
-        value : scaler, list of scalars, list of lists of scalars or block
+        value : scalar, list of scalars, list of lists of scalars or block
             value to be used in block, possibly expanded to a list of lists of scalars
 
         column_like : boolean
             if value is a list of scalars, values is interpreted as a column if True, as a row otherwise
 
-        number_of_rows : int
-            if given, expand or shrink to the given number of rows
-
-        number_of_columns : int
-            if given, expand or shrink to the given number of columns
-
         Returns
         -------
         block : block
@@ -328,7 +345,7 @@ class block:
             for column, item in enumerate(row_contents, 1):
                 if item and not (isinstance(item, float) and math.isnan(item)):
                     bl.dict[row, column] = item
-                    bl._number_of_columns = max(bl.number_of_columns, column)
+                bl._number_of_columns = max(bl.number_of_columns, column)
         return bl
 
     @classmethod
@@ -341,19 +358,12 @@ class block:
         rng : xlwings.Range
             range to be used be used in block
 
-        number_of_rows : int
-            if given, expand or shrink to the given number of rows
-
-        number_of_columns : int
-            if given, expand or shrink to the given number of columns
-
         Returns
         -------
         block : block
         """
         number_of_rows, number_of_columns = rng.shape
-        bl = cls.from_value(rng.value, column_like=(number_of_columns == 1))
-        return bl
+        return cls.from_value(rng.value, column_like=(number_of_columns == 1))
 
     @classmethod
     def from_xlrd_sheet(cls, sheet):
@@ -365,12 +375,6 @@ class block:
         sheet : xlrd sheet
             sheet to be used be used in block
 
-        number_of_rows : int
-            if given, expand or shrink to the given number of rows
-
-        number_of_columns : int
-            if given, expand or shrink to the given number of columns
-
         Returns
         -------
         block : block
@@ -380,6 +384,18 @@ class block:
 
     @classmethod
     def from_openpyxl_sheet(cls, sheet):
+        """
+        makes a block from an openpyxl sheet
+
+        Parameters
+        ----------
+        sheet : xlrd sheet
+            sheet to be used be used in block
+
+        Returns
+        -------
+        block : block
+        """
         v = [[cell.value for cell in row] for row in sheet.iter_rows()]
         return cls.from_value(v)
 
@@ -393,12 +409,6 @@ class block:
         filename : str
             file to be used be used in block
 
-        number_of_rows : int
-            if given, expand or shrink to the given number of rows
-
-        number_of_columns : int
-            if given, expand or shrink to the given number of columns
-
         Returns
         -------
         block : block
@@ -417,12 +427,6 @@ class block:
         df : pandas dataframe
             dataframe to be used be used in block
 
-        number_of_rows : int
-            if given, expand or shrink to the given number of rows
-
-        number_of_columns : int
-            if given, expand or shrink to the given number of columns
-
         Returns
         -------
         block : block
@@ -432,18 +436,12 @@ class block:
 
     def to_openpyxl_sheet(self, sheet):
         """
-        makes a block from a given openpyxl sheet
+        appends a block to a given openpyxl sheet
 
         Parameters
         ----------
         sheet: openpyxl sheet
-            sheet to be used be used in block
-
-        number_of_rows : int
-            if given, expand or shrink to the given number of rows
-
-        number_of_columns : int
-            if given, expand or shrink to the given number of columns
+            sheet to be used be used
 
         Returns
         -------
@@ -488,7 +486,11 @@ class block:
             raise IndexError(f"row must be between 1 and {self.number_of_rows} not {row}")
         if column < 1 or column > self.number_of_columns:
             raise IndexError(f"column must be between 1 and {self.number_of_columns} not {column}")
-        self.dict[row, column] = value
+        if value is None:
+            if (row, column) in self.dict:
+                del self.dict[row, column]
+        else:
+            self.dict[row, column] = value
 
     def __getitem__(self, row_column):
         row, column = row_column
@@ -562,7 +564,7 @@ class block:
         if column > self.number_of_columns:
             raise ValueError(f"{name}={column} > number_of_columns={self.number_of_columns}")
 
-    def transpose(self):
+    def transposed(self):
         """
         transpose block
 
@@ -827,7 +829,16 @@ class block:
 
     def decode_to_files(self):
         """
-        decode the block with encoded file(s) to individual pyoidide files
+        decode the block with encoded file(s) to individual pyoidide file(s)
+
+        Returns
+        -------
+        count : int
+            number of files decoded
+
+        Note
+        ----
+        if the block does not contain an encode file, the method just returns 0
         """
         count = 0
         for column in range(1, self.number_of_columns + 1):

{xlwings_utils-25.0.7.post0.dist-info → xlwings_utils-25.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.7.post0
+Version: 25.0.8
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -51,7 +51,9 @@ The xlwings lite system does not provide access to the local file system. With t
 
 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.
+The easiest way to use the Dropbox functionality is to add the credentials to the environment variables. Add DROPBOX.REFRESH_TOKEN,
+DROPBOX.APP_KEY and DROPBOX.APP_SECRET with their corresponding values to the environment variables.
+Instructions on how to get these variables can be found here.
 
 In order to make a Dropbox app, and get the required environment variables, just execute this line from the command line (shell).
 
@@ -60,7 +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.
+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`.
 

xlwings_utils-25.0.8.dist-info/RECORD

@@ -0,0 +1,6 @@
+xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
+xlwings_utils/xlwings_utils.py,sha256=HNip6tVo2sxhlysNm2zWVRY2bciWUujpzN-NmISUOiM,28690
+xlwings_utils-25.0.8.dist-info/METADATA,sha256=KwS8dQNtM4n95zj2EXYaQfZFXMGga8MkQKVchmCQO9w,12447
+xlwings_utils-25.0.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xlwings_utils-25.0.8.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
+xlwings_utils-25.0.8.dist-info/RECORD,,

xlwings_utils-25.0.7.post0.dist-info/RECORD

@@ -1,6 +0,0 @@
-xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
-xlwings_utils/xlwings_utils.py,sha256=f13mQGcZ6syg7vkU97iYEHXj4Mlai6gPZd0XhOkxiwY,28717
-xlwings_utils-25.0.7.post0.dist-info/METADATA,sha256=vsTv_WzSM6miRYN5OltUUr2i5YkybpepE9crGXMZrZk,12424
-xlwings_utils-25.0.7.post0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xlwings_utils-25.0.7.post0.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
-xlwings_utils-25.0.7.post0.dist-info/RECORD,,