xlwings-utils 25.2.1__py3-none-any.whl

xlwings_utils/__init__.py

@@ -0,0 +1,5 @@
+from .xlwings_utils import *
+from .xlwings_utils import __version__
+from .dropbox import *
+from .nextcloud import *
+from .local import *

xlwings_utils/dropbox.py

@@ -0,0 +1,258 @@
+import os
+import requests
+import json
+
+_token = None
+missing = object()
+
+
+def normalize_path(path):
+    path = str(path).strip()
+    if path == "/":
+        path = ""
+    if path and not path.startswith("/"):
+        path = "/" + path
+    return path
+
+
+def init(refresh_token=missing, app_key=missing, app_secret=missing, **kwargs):
+    """
+    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 DROPBOX.REFRESH_TOKEN, DROPBOX.APP_KEY and DROPBOX.APP_SECRET
+    environment variables, it is not necessary to call dropbox_init().
+
+    Parameters
+    ----------
+    refresh_token : str
+        oauth2 refreshntoken
+
+        if omitted: use the environment variable DROPBOX.REFRESH_TOKEN
+
+    app_key : str
+        app key
+
+        if omitted: use the environment variable DROPBOX.APP_KEY
+
+
+    app_secret : str
+        app secret
+
+        if omitted: use the environment variable DROPBOX.APP_SECRET
+
+    Returns
+    -------
+    dropbox object
+    """
+
+    global _token
+    try:
+        import pyodide_http
+
+        pyodide_http.patch_all()  # required to reliably use requests on pyodide platforms
+
+    except ImportError:
+        ...
+
+    if refresh_token is missing:
+        if "DROPBOX.REFRESH_TOKEN" in os.environ:
+            refresh_token = os.environ["DROPBOX.REFRESH_TOKEN"]
+        else:
+            raise ValueError("no DROPBOX.REFRESH_TOKEN found in environment.")
+    if app_key is missing:
+        if "DROPBOX.APP_KEY" in os.environ:
+            app_key = os.environ["DROPBOX.APP_KEY"]
+        else:
+            raise ValueError("no DROPBOX.APP_KEY found in environment.")
+    if app_secret is missing:
+        if "DROPBOX.APP_SECRET" in os.environ:
+            app_secret = os.environ["DROPBOX.APP_SECRET"]
+        else:
+            raise ValueError("no DROPBOX.APP_SECRET found in environment.")
+
+    response = requests.post(
+        "https://api.dropbox.com/oauth2/token",
+        data={"grant_type": "refresh_token", "refresh_token": refresh_token, "client_id": app_key, "client_secret": app_secret},
+        timeout=30,
+    )
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError:
+        raise ValueError("invalid dropbox credentials")
+    _token = response.json()["access_token"]
+
+
+def _login():
+    if _token is None:
+        init()  # use environment
+
+
+def dir(path="", recursive=False, show_files=True, show_folders=False):
+    """
+    returns all dropbox files/folders in path
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path from which to list all files (default: '')
+
+    recursive : bool
+        if True, recursively list files and folders. if False (default) no recursion
+
+    show_files : bool
+        if True (default), show file entries
+        if False, do not show file entries
+
+    show_folders : bool
+        if True, show folder entries
+        if False (default), do not show folder entries
+
+    Returns
+    -------
+    files : list
+
+    Note
+    ----
+    If DROPBOX.REFRESH_TOKEN, DROPBOX.APP_KEY and DROPBOX.APP_SECRET environment variables are specified,
+    it is not necessary to call dropbox_init() prior to any dropbox function.
+    """
+    _login()
+
+    path = normalize_path(path)
+
+    API_RPC = "https://api.dropboxapi.com/2"
+    headers = {"Authorization": f"Bearer {_token}", "Content-Type": "application/json"}
+    payload = {"path": path, "recursive": recursive, "include_deleted": False}
+    response = requests.post("https://api.dropboxapi.com/2/files/list_folder", headers=headers, json=payload, timeout=30)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        raise OSError(f"error listing dropbox. Original message is {e}") from None
+    data = response.json()
+    entries = data["entries"]
+    while data.get("has_more"):
+        response = requests.post(f"{API_RPC}/files/list_folder/continue", headers=headers, json={"cursor": data["cursor"]}, timeout=30)
+        try:
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            raise OSError(f"error listing dropbox. Original message is {e}") from None
+        data = response.json()
+        entries.extend(data["entries"])
+
+    result = []
+    for entry in entries:
+        if show_files and entry[".tag"] == "file":
+            result.append(entry["path_display"])
+        if show_folders and entry[".tag"] == "folder":
+            result.append(entry["path_display"] + "/")
+    return result
+
+
+def read(path):
+    """
+    read file from dropbox
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path to read from
+
+    Returns
+    -------
+    contents of the dropbox file : bytes
+
+    Note
+    ----
+    If the file could not be read, an OSError will be raised.
+
+    Note
+    ----
+    If DROPBOX.REFRESH_TOKEN, DROPBOX.APP_KEY and DROPBOX.APP_SECRET environment variables are specified,
+    it is not necessary to call dropbox_init() prior to any dropbox function.
+    """
+
+    _login()
+
+    path = normalize_path(path)
+
+    headers = {"Authorization": f"Bearer {_token}", "Dropbox-API-Arg": json.dumps({"path": path})}
+    with requests.post("https://content.dropboxapi.com/2/files/download", headers=headers, stream=True, timeout=60) as response:
+        try:
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            raise OSError(f"file {str(path)} not found. Original message is {e}") from None
+        chunks = []
+        for chunk in response.iter_content(chunk_size=1024):
+            if chunk:
+                chunks.append(chunk)
+    return b"".join(chunks)
+
+
+def write(path, contents):
+    """
+    write to file on dropbox
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path to write to
+
+    contents : bytes
+        contents to be written
+
+    Note
+    ----
+    If the file could not be written, an OSError will be raised.
+
+    Note
+    ----
+    If DROPBOX.REFRESH_TOKEN, DROPBOX.APP_KEY and DROPBOX.APP_SECRET environment variables are specified,
+    it is not necessary to call dropbox_init() prior to any dropbox function.
+    """
+    _login()
+    path = normalize_path(path)
+
+    headers = {
+        "Authorization": f"Bearer {_token}",
+        "Dropbox-API-Arg": json.dumps(
+            {"path": str(path), "mode": "overwrite", "autorename": False, "mute": False}  # Where it will be saved in Dropbox  # "add" or "overwrite"
+        ),
+        "Content-Type": "application/octet-stream",
+    }
+    response = requests.post("https://content.dropboxapi.com/2/files/upload", headers=headers, data=contents)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        raise OSError(f"file {str(path)} could not be written. Original message is {e}") from None
+
+
+def delete(path):
+    """
+    delete file dropbox
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path to delete
+
+    Note
+    ----
+    If the file could not be deleted, an OSError will be raised.
+
+    Note
+    ----
+    If DROPBOX.REFRESH_TOKEN, DROPBOX.APP_KEY and DROPBOX.APP_SECRET environment variables are specified,
+    it is not necessary to call dropbox_init() prior to any dropbox function.
+    """
+    _login()
+    path = normalize_path(path)
+
+    headers = {"Authorization": f"Bearer {_token}", "Content-Type": "application/json"}
+
+    data = {"path": str(path)}  # Path in Dropbox, starting with /
+
+    response = requests.post("https://api.dropboxapi.com/2/files/delete_v2", headers=headers, data=json.dumps(data))
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        raise OSError(f"file {str(path)} could not be deleted. Original message is {e}") from None

xlwings_utils/local.py

@@ -0,0 +1,53 @@
+from pathlib import Path
+
+def dir(path, recursive=False, show_files=True, show_folders=False):
+    """
+    returns all local files/folders at given path
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path from which to list all files (default: '')
+
+    recursive : bool
+        if True, recursively list files. if False (default) no recursion
+
+    show_files : bool
+        if True (default), show file entries
+        if False, do not show file entries
+
+    show_folders : bool
+        if True, show folder entries
+        if False (default), do not show folder entries
+
+    Returns
+    -------
+    files, relative to path : list
+    """
+    path = Path(path)
+
+    result = []
+    for entry in path.iterdir():
+        if entry.is_file():
+            if show_files:
+                result.append(str(entry))
+        elif entry.is_dir():
+            if show_folders:
+                result.append(str(entry) + "/")
+            if recursive:
+                result.extend(list_local(entry, recursive=recursive, show_files=show_files, show_folders=show_folders))
+    return result
+
+
+def write(path, contents):
+    path = Path(path)
+    path.parent.mkdir(parents=True, exist_ok=True)
+    with open(path, "wb") as f:
+        f.write(contents)
+
+
+def read(path):
+    path = Path(path)
+    with open(path, "rb") as f:
+        contents = f.read()
+    return contents

xlwings_utils/nextcloud.py

@@ -0,0 +1,236 @@
+import requests
+import xml.etree.ElementTree
+import urllib.parse
+import xlwings_utils
+import os
+
+try:
+    import pyodide_http
+except ImportError:
+    ...
+
+missing = object()
+
+_url = None
+
+
+def make_base_path(webdav_url: str) -> str:
+    """
+    Turn 'https://host/remote.php/dav/files/user%40mail.com/'
+    into '/remote.php/dav/files/user@mail.com/' (decoded, with trailing slash).
+    """
+    p = urllib.parse.urlparse(webdav_url)
+    path = urllib.parse.unquote(p.path)
+    if not path.endswith("/"):
+        path += "/"
+    return path
+
+
+def clean_href(href: str, base_path: str) -> str:
+    """
+    Turn href from PROPFIND into a clean relative path.
+    Works whether href is absolute URL or just a server path,
+    and whether it's encoded or not.
+    """
+    # href may be a full URL or just a path
+    if "://" in href:
+        href_path = urllib.parse.unquote(urllib.parse.urlparse(href).path)
+    else:
+        href_path = urllib.parse.unquote(href)
+
+    # Ensure base_path is decoded and slash-normalized
+    base_path = urllib.parse.unquote(base_path)
+    if not base_path.endswith("/"):
+        base_path += "/"
+
+    if href_path.startswith(base_path):
+        rel = href_path[len(base_path) :]
+    else:
+        # fallback: just strip leading slash to avoid weird output
+        rel = href_path.lstrip("/")
+
+    return rel.lstrip("/")
+
+
+def init(url=missing, username=missing, password=missing, **kwargs):
+    global _auth
+    global _url
+    try:
+        import pyodide_http
+
+        pyodide_http.patch_all()  # required to reliably use requests on pyodide platforms
+
+    except ImportError:
+        ...
+
+    if url is missing:
+        if "NEXTCLOUD.URL" in os.environ:
+            url = os.environ["NEXTCLOUD.URL"]
+        else:
+            raise ValueError("no NEXTCLOUD.URL found in environment.")
+    if username is missing:
+        if "NEXTCLOUD.USERNAME" in os.environ:
+            username = os.environ["NEXTCLOUD.USERNAME"]
+        else:
+            raise ValueError("no NEXTCLOUD.USERNAMEfound in environment.")
+    if password is missing:
+        if "NEXTCLOUD.PASSWORD" in os.environ:
+            password = os.environ["NEXTCLOUD.PASSWORD"]
+        else:
+            raise ValueError("no NEXTCLOUD.PASSWORD found in environment.")
+    _url = url
+    _auth = (username, password)
+
+
+def _login():
+    global _url
+    if _url is None:
+        init()  # use environment
+
+
+def dir(path="", recursive=False, show_files=True, show_folders=False):
+    """
+    returns all nextcloud files/folders in path
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path from which to list all files (default: '')
+
+    recursive : bool
+        if True, recursively list files and folders. if False (default) no recursion
+
+    show_files : bool
+        if True (default), show file entries
+        if False, do not show file entries
+
+    show_folders : bool
+        if True, show folder entries
+        if False (default), do not show folder entries
+
+    Returns
+    -------
+    files : list
+
+    Note
+    ----
+    If NEXTCLOUD.URL, NEXTCLOUD.USERNAME and NEXTCLOUD.PASSWORD environment variables are specified,
+    it is not necessary to call nextcloud_init() prior to any nextcloud function.
+    """
+    _login()
+
+    headers = {"Depth": "1000" if recursive else "1"}  # 1 = directory + its immediate children
+
+    response = requests.request("PROPFIND", _url + path, auth=_auth, headers=headers)
+
+    response.raise_for_status()
+    root = xml.etree.ElementTree.fromstring(response.text)
+    namespaces = {"d": "DAV:"}
+
+    items = []
+
+    base_path = make_base_path(_url)
+
+    for response_el in root.findall("d:response", namespaces):
+        href = response_el.find("d:href", namespaces).text
+        href = clean_href(href, base_path)
+        if not href.startswith("/"):
+            href = "/" + href
+
+        prop = response_el.find("d:propstat/d:prop", namespaces)
+        res_type = prop.find("d:resourcetype", namespaces)
+        is_dir = res_type.find("d:collection", namespaces) is not None
+        if is_dir and show_folders:
+            items.append(href)
+        if not is_dir and show_files:
+            items.append(href)
+    return items
+
+
+def read(path):
+    """
+    read file from nextcloud
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path to read from
+
+    Returns
+    -------
+    contents of the nextcloud file : bytes
+
+    Note
+    ----
+    If the file could not be read, an OSError will be raised.
+
+    Note
+    ----
+    If NEXTCLOUD.URL, NEXTCLOUD.USERNAME and NEXTCLOUD.PASSWORD environment variables are specified,
+    it is not necessary to call nextcloud_init() prior to any nextcloud function.
+    """
+
+    _login()
+    response = requests.get(_url + path, auth=_auth)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        raise OSError(f"file {str(path)} not found. Original message is {e}") from None
+    file_content = response.content
+    return file_content
+
+
+def write(path, contents):
+    """
+    write to file on nextcloud
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path to write to
+
+    contents : bytes
+        contents to be written
+
+    Note
+    ----
+    If the file could not be written, an OSError will be raised.
+
+    Note
+    ----
+    If NEXTCLOUD.URL, NEXTCLOUD.USERNAME and NEXTCLOUD.PASSWORD environment variables are specified,
+    it is not necessary to call nextcloud_init() prior to any nextcloud function.
+    """
+    _login()
+    response = requests.put(_url + path, auth=_auth, data=contents, timeout=60)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        raise OSError(f"file {str(path)} could not be written. Original message is {e}") from None
+
+
+def delete(path):
+    """
+    delete file nextcloud
+
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path to delete
+
+    Note
+    ----
+    If the file could not be deleted, an OSError will be raised.
+
+    Note
+    ----
+    If NEXTCLOUD.URL, NEXTCLOUD.USERNAME and NEXTCLOUD.PASSWORD environment variables are specified,
+    it is not necessary to call nextcloud_init() prior to any nextcloud function.
+    """
+    _login()
+
+    response = requests.delete(_url + path, auth=_auth, timeout=30)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        raise OSError(f"file {str(path)} could not be deleted. Original message is {e}") from None