Skip to content

Config

clak.comp.config

Register a Python executable for use with the argcomplete module.

To perform the registration, source the output of this script in your bash shell (quote the output to avoid interpolation).

Example:

$ eval "$(register-python-argcomplete my-favorite-script.py)"

For Tcsh

$ eval `register-python-argcomplete --shell tcsh my-favorite-script.py`

For Fish

$ register-python-argcomplete --shell fish         my-favourite-script.py > ~/.config/fish/my-favourite-script.py.fish

XDGConfigMixin

XDG configuration support mixin.

Provides standard XDG base directory arguments for configuration files and directories: - --conf-file: Config file path ($XDG_CONFIG_HOME/my_app/config.yaml) - --data-dir: Data directory ($XDG_DATA_HOME/my_app) - --cache-dir: Cache directory ($XDG_CACHE_HOME/my_app) - --log-dir: Log directory ($XDG_CACHE_HOME/my_app/logs)

Source code in clak/comp/config.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class XDGConfigMixin:  # pylint: disable=too-few-public-methods
    """XDG configuration support mixin.

    Provides standard XDG base directory arguments for configuration files and directories:
    - --conf-file: Config file path ($XDG_CONFIG_HOME/my_app/config.yaml)
    - --data-dir: Data directory ($XDG_DATA_HOME/my_app)
    - --cache-dir: Cache directory ($XDG_CACHE_HOME/my_app)
    - --log-dir: Log directory ($XDG_CACHE_HOME/my_app/logs)
    """

    # config_dir = Argument('--config-dir', help=argparse.SUPPRESS,
    #     default=os.path.expanduser("~/.config/my_app"))

    # For AI:
    # This class should provide following arguments:
    # --conf-file = $XDG_CONFIG_HOME/my_app/config.yaml
    # --data-dir = $XDG_DATA_HOME/my_app
    # --cache-dir = $XDG_CACHE_HOME/my_app
    # --log-dir = $XDG_CACHE_HOME/my_app/logs

    # XDG base directories with defaults
    xdg_config = Argument(
        "--conf-file",
        # help=argparse.SUPPRESS,
        help="Configuration file to use",
        default=os.path.expanduser("~/.config/my_app/config.yaml"),
    )
    xdg_data_dir = Argument(
        "--data-dir",
        help=argparse.SUPPRESS,
        default=os.path.expanduser("~/.local/share/my_app"),
    )
    xdg_cache_dir = Argument(
        "--cache-dir",
        help=argparse.SUPPRESS,
        default=os.path.expanduser("~/.cache/my_app"),
    )
    xdg_log_dir = Argument(
        "--log-dir",
        help=argparse.SUPPRESS,
        default=os.path.expanduser("~/.cache/my_app/logs"),
    )