CTkFileDialog-plus 2.1.1__py3-none-any.whl

CTkFileDialog/Constants/__init__.py

@@ -0,0 +1,45 @@
+"""
+This module is part of the CTkFileDialog library.
+
+It defines system path constants that point to useful directories such as the 
+user's home, config, cache, and data folders, as well as the system PATH and temp directory.
+
+These constants follow the XDG Base Directory Specification where possible,
+and serve as a utility for file dialogs and other filesystem operations within the library.
+
+Available constants:
+
+- PWD:        Current working directory where the program was launched.
+- HOME:       User's home directory.
+- TEMP:       Temporary directory, resolved from common environment variables or defaulting to /tmp.
+- CONFIG_DIR: XDG-compliant user configuration directory (e.g., ~/.config).
+- CACHE_DIR:  XDG-compliant user cache directory (e.g., ~/.cache).
+- DATA_DIR:   XDG-compliant user data directory (e.g., ~/.local/share).
+- PATH:       List of directories in the system PATH environment variable.
+- VENV:       Path to the active Python virtual environment (VIRTUAL_ENV or CONDA_PREFIX).
+- DOWNLOAD_DIR: Default download directory (e.g., ~/Downloads).
+- DOWNLOAD_DIR_VIDEO: Default video download directory (e.g., ~/Downloads/Video).
+
+Author: Flick
+Repository: https://github.com/FlickGMD/CTkFileDialog
+
+Modified: by abdelilah 
+https://github.com/hmidani-abdelilah/CTkFileDialog-plus
+
+"""
+
+from .constants import PWD, HOME, PATH, TEMP, CONFIG_DIR, CACHE_DIR, DATA_DIR, VENV, PATHS ,DOWNLOAD_DIR, DOWNLOAD_DIR_VIDEO
+
+__all__ = [
+        'PWD',
+        'HOME',
+        'PATH',
+        'TEMP',
+        'CACHE_DIR',
+        'CONFIG_DIR',
+        'DATA_DIR',
+        'VENV',
+        'PATHS',
+        'DOWNLOAD_DIR',
+        'DOWNLOAD_DIR_VIDEO',
+        ]

CTkFileDialog/Constants/constants.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+from pathlib import Path
+import os
+
+# Current working directory (e.g., where the program was launched)
+PWD = str(Path.cwd())
+
+# User's home directory (e.g., /home/user or C:\Users\user)
+HOME = str(Path.home())
+
+
+
+# System PATH split into a list of directories
+PATH = os.getenv('PATH').split(os.pathsep)
+
+# Temporary directory (fallback to /tmp if no env vars are set)
+TEMP = os.getenv('TMPDIR') or os.getenv('TEMP') or os.getenv('TMP') 
+
+# XDG-compliant user configuration directory (default: ~/.config)
+CONFIG_DIR = os.getenv('XDG_CONFIG_HOME', str(Path(HOME) / '.config'))
+
+# XDG-compliant user cache directory (default: ~/.cache)
+CACHE_DIR = os.getenv('XDG_CACHE_HOME', str(Path(HOME) / '.cache'))
+
+# XDG-compliant user data directory (default: ~/.local/share)
+DATA_DIR = os.getenv('XDG_DATA_HOME', str(Path(HOME) / '.local' / 'share'))
+
+# Active Python virtual environment (venv or conda), fallback to PWD 
+VENV = os.getenv("VIRTUAL_ENV") or os.getenv("CONDA_PREFIX") or PWD
+
+# Download directory windows and linux (default: ~/Downloads)
+DOWNLOAD_DIR = str(Path(HOME) / 'Downloads')
+
+# Download directory Video windows and linux  (default: ~/Downloads/Video )
+DOWNLOAD_DIR_VIDEO = str(Path(DOWNLOAD_DIR) / 'Video')
+# create the directory if it doesn't exist
+if not os.path.exists(DOWNLOAD_DIR_VIDEO):
+    os.makedirs(DOWNLOAD_DIR_VIDEO)
+
+
+# All paths in a single dictionary for easy access
+PATHS = {
+    "HOME": HOME,
+    "PWD": PWD,
+    "TEMP": TEMP,
+    "CONFIG_DIR": CONFIG_DIR,
+    "DATA_DIR": DATA_DIR,
+    "CACHE_DIR": CACHE_DIR,
+    "PATH": PATH, 
+    'VENV': VENV,
+    'DOWNLOAD_DIR': DOWNLOAD_DIR,
+    'DOWNLOAD_DIR_VIDEO': DOWNLOAD_DIR_VIDEO
+}

CTkFileDialog/Dialog.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+"""Backward-compatibility shim.
+
+Historically all dialog classes lived in this module.  They have been
+moved to ``CTkFileDialog.ui``.  This file re-exports the public names so
+any external ``from CTkFileDialog.Dialog import _DrawApp`` continues to
+work.
+"""
+from .ui.default_dialog import DrawApp, _DrawApp
+from .ui.mini_dialog import MiniDialog, _MiniDialog
+from .ui.tooltip import CustomToolTip
+from .system.platform import System as _System
+
+# Historical private name
+_CustomToolTip = CustomToolTip
+
+__all__ = [
+    "DrawApp",
+    "_DrawApp",
+    "MiniDialog",
+    "_MiniDialog",
+    "CustomToolTip",
+    "_CustomToolTip",
+    "_System",
+]

CTkFileDialog/__init__.py

@@ -0,0 +1,36 @@
+'''
+File dialog created in custom Tkinter and inspired by the Tkinter dialog.
+
+- Version: 0.3.3
+- Author: Flick
+- Github: https://github.com/FlickGMD/CTkFileDialog
+- License: MIT
+- Version: 0.1.0
+- Author: abdelilah
+- Github: https://github.com/hmidani-abdelilah/CTkFileDialog-plus
+- License: MIT
+'''
+from ._functions import (
+        askopenfilename, askdirectory, askopenfile, askopenfiles, askopenfilenames,
+        asksaveasfile, asksaveasfilename,
+        askopendirname, askopendirnames,
+        askopenpathname, askopenpathnames,
+        )
+from . import Constants
+
+__version__ = '0.3.3'
+__all__ = [
+        'askopenfilename',
+        'askdirectory',
+        'askopenfile',
+        'askopenfiles',
+        'askopenfilenames',
+        'asksaveasfile',
+        'asksaveasfilename', 
+        'askopendirname',
+        'askopendirnames',
+        'askopenpathname',
+        'askopenpathnames',
+        'Constants'
+        ]
+

CTkFileDialog/_functions.py

@@ -0,0 +1,521 @@
+#!/usr/bin/env python
+"""Public dialog functions — API surface is unchanged."""
+from __future__ import annotations
+
+from typing import List, Literal, Optional, TextIO, Tuple, Union
+
+from typeguard import typechecked
+
+from .ui.default_dialog import _DrawApp
+from .ui.mini_dialog import _MiniDialog
+from .utils.helpers import apply_defaultext, normalize_filetypes
+
+
+# Re-export helpers under historical private names for any external use
+_normalize_filetypes = normalize_filetypes
+_apply_defaultext = apply_defaultext
+
+
+@typechecked
+def askopenfilename(
+    style: Literal["Mini", "Default"] = "Default",
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    hidden: bool = False,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> str | None:
+    """
+    Displays a file dialog for selecting a single file and returns the file path.
+    """
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="askopenfilename",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return app.selected_file if app.selected_file else None
+    elif style == "Mini":
+        app = _MiniDialog(
+            method="askopenfilename",
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            autocomplete=autocomplete,
+            hidden=hidden,
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        return app.selected_path
+
+
+@typechecked
+def askdirectory(
+    style: Literal["Default", "Mini"] = "Default",
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    hidden: bool = False,
+    autocomplete: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> str | None:
+    """Displays a directory selection dialog and returns the selected path."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            method="askdirectory",
+            autocomplete=autocomplete,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return app.selected_file if app.selected_file else None
+    elif style == "Mini":
+        app = _MiniDialog(
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            hidden=hidden,
+            method="askdirectory",
+            autocomplete=autocomplete,
+            foldercreation=foldercreation,
+            title=title,
+            geometry=geometry[1],
+        )
+        return app.selected_path if app.selected_path else None
+
+
+@typechecked
+def askopendirname(
+    style: Literal["Default", "Mini"] = "Default",
+    hidden: bool = False,
+    autocomplete: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> str:
+    """Allow the user to choose a single directory."""
+    if style == "Default":
+        app = _DrawApp(
+            current_path=initial_dir,
+            hidden=hidden,
+            method="askdirectory",
+            autocomplete=autocomplete,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return app.selected_file if app.selected_file else ""
+    elif style == "Mini":
+        app = _MiniDialog(
+            initial_dir=initial_dir,
+            hidden=hidden,
+            method="askdirectory",
+            autocomplete=autocomplete,
+            foldercreation=foldercreation,
+            title=title,
+            geometry=geometry[1],
+        )
+        return app.selected_path if app.selected_path else ""
+
+
+@typechecked
+def askopendirnames(
+    style: Literal["Default", "Mini"] = "Default",
+    hidden: bool = False,
+    autocomplete: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> tuple[str, ...]:
+    """Allow the user to choose multiple directories (Ctrl/Shift + click)."""
+    if style == "Default":
+        app = _DrawApp(
+            current_path=initial_dir,
+            hidden=hidden,
+            method="askdirectories",
+            autocomplete=autocomplete,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return tuple(app.selected_objects) if app.selected_objects else tuple()
+    elif style == "Mini":
+        app = _MiniDialog(
+            initial_dir=initial_dir,
+            hidden=hidden,
+            method="askdirectories",
+            autocomplete=autocomplete,
+            foldercreation=foldercreation,
+            title=title,
+            geometry=geometry[1],
+        )
+        return tuple(app.selected_paths) if app.selected_paths else tuple()
+
+
+@typechecked
+def askopenpathname(
+    style: Literal["Default", "Mini"] = "Default",
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    hidden: bool = False,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> str:
+    """Allow the user to choose a single file or folder."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="askopenpathname",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return app.selected_file if app.selected_file else ""
+    elif style == "Mini":
+        app = _MiniDialog(
+            method="askopenpathname",
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            autocomplete=autocomplete,
+            hidden=hidden,
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        return app.selected_path if app.selected_path else ""
+
+
+@typechecked
+def askopenpathnames(
+    style: Literal["Default", "Mini"] = "Default",
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    hidden: bool = False,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> tuple[str, ...]:
+    """Allow the user to choose multiple files and folders (Ctrl/Shift + click)."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="askopenpathnames",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return tuple(app.selected_objects) if app.selected_objects else tuple()
+    elif style == "Mini":
+        app = _MiniDialog(
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            hidden=hidden,
+            autocomplete=autocomplete,
+            method="askopenpathnames",
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        return tuple(app.selected_paths) if app.selected_paths else tuple()
+
+
+@typechecked
+def askopenfilenames(
+    style: Literal["Default", "Mini"] = "Default",
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    hidden: bool = False,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> tuple[str, ...] | None:
+    """Displays a file dialog for multiple file selection."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="askopenfilenames",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return tuple(app.selected_objects) if app.selected_objects else None
+    elif style == "Mini":
+        app = _MiniDialog(
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            hidden=hidden,
+            method="askopenfilenames",
+            autocomplete=autocomplete,
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        return tuple(app.selected_paths) if app.selected_paths else None
+
+
+@typechecked
+def asksaveasfilename(
+    style: Literal["Default", "Mini"] = "Default",
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    hidden: bool = False,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    defaultext: Optional[str] = None,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+) -> str | None:
+    """Displays a save file dialog and returns the selected path."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="asksaveasfilename",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return apply_defaultext(app.selected_file, defaultext) if app.selected_file else None
+    elif style == "Mini":
+        app = _MiniDialog(
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            hidden=hidden,
+            method="asksaveasfilename",
+            autocomplete=autocomplete,
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        return apply_defaultext(app.selected_path, defaultext) if app.selected_path else None
+
+
+@typechecked
+def asksaveasfile(
+    style: Literal["Default", "Mini"] = "Default",
+    mode: Literal["r", "rb", "r+", "rb+", "r+b", "w", "wb", "w+", "wb+", "a", "ab", "a+", "ab+", "x", "xb"] = "w",
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    hidden: bool = False,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    defaultext: Optional[str] = None,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+    **kwargs,
+) -> TextIO | None:
+    """Displays a save dialog and returns an open file object."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="asksaveasfile",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        selected = apply_defaultext(app.selected_file, defaultext)
+        return open(selected, mode=mode, **kwargs) if selected else None
+    elif style == "Mini":
+        app = _MiniDialog(
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            hidden=hidden,
+            method="asksaveasfile",
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        selected = apply_defaultext(app.selected_path, defaultext)
+        return open(selected, mode=mode, **kwargs) if selected else None
+
+
+@typechecked
+def askopenfile(
+    style: Literal["Mini", "Default"] = "Default",
+    mode: Literal["r", "rb", "r+", "rb+", "r+b", "w", "wb", "w+", "wb+", "a", "ab", "a+", "ab+", "x", "xb"] = "r",
+    hidden: bool = False,
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+    **kwargs,
+) -> TextIO | None:
+    """Displays an open file dialog and returns an open file object."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="askopenfile",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return open(app.selected_file, mode=mode, **kwargs) if app.selected_file else None
+    elif style == "Mini":
+        app = _MiniDialog(
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            hidden=hidden,
+            method="askopenfile",
+            autocomplete=autocomplete,
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        return open(app.selected_path, mode=mode, **kwargs) if app.selected_path else None
+
+
+@typechecked
+def askopenfiles(
+    style: Literal["Default", "Mini"] = "Default",
+    mode: Literal["r", "rb", "r+", "rb+", "r+b", "w", "wb", "w+", "wb+", "a", "ab", "a+", "ab+", "x", "xb"] = "r",
+    hidden: bool = False,
+    filetypes: Optional[List[Union[str, Tuple[str, str]]]] = None,
+    preview_img: bool = False,
+    autocomplete: bool = False,
+    video_preview: bool = False,
+    initial_dir: str = ".",
+    tool_tip: bool = False,
+    foldercreation: bool = True,
+    geometry: Tuple[str, str] = ("1320x720", "500x400"),
+    title: str = "CTkFileDialog",
+    **kwargs,
+) -> tuple[TextIO, ...] | None:
+    """Displays a multi-file open dialog and returns multiple open file objects."""
+    normalized = normalize_filetypes(filetypes)
+    if style == "Default":
+        app = _DrawApp(
+            filetypes=normalized,
+            current_path=initial_dir,
+            hidden=hidden,
+            preview_img=preview_img,
+            method="askopenfilenames",
+            autocomplete=autocomplete,
+            video_preview=video_preview,
+            tool_tip=tool_tip,
+            foldercreation=foldercreation,
+            geometry=geometry[0],
+            title=title,
+        )
+        app.app.wait_window()
+        return (
+            tuple(open(f, mode=mode, **kwargs) for f in app.selected_objects)
+            if app.selected_objects
+            else None
+        )
+    elif style == "Mini":
+        app = _MiniDialog(
+            filetypes=normalized,
+            initial_dir=initial_dir,
+            hidden=hidden,
+            autocomplete=autocomplete,
+            method="askopenfilenames",
+            foldercreation=foldercreation,
+            geometry=geometry[1],
+            title=title,
+        )
+        return (
+            tuple(open(f, mode=mode, **kwargs) for f in app.selected_paths)
+            if app.selected_paths
+            else None
+        )

CTkFileDialog/_system.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+"""Backward-compatibility shim for platform helpers."""
+from .system.platform import find_owner, System
+
+__all__ = ["find_owner", "System"]