From 4acec273463deca92e579ca3141055a2923e3173 Mon Sep 17 00:00:00 2001 From: Travis Prescott Date: Wed, 22 May 2019 14:00:29 -0700 Subject: [PATCH] Ensure usages of ~ also use os.path.expanduser. (#153) --- docs/cli.md | 2 +- examples/exapp | 2 +- examples/exapp2 | 2 +- examples/test_exapp | 2 +- knack/config.py | 2 +- tests/test_cli_scenarios.py | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 9256248..454d316 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -9,7 +9,7 @@ We recommend specifying `cli_name`, `config_dir` and `config_env_var_prefix`. For example: `cli_name` - Name of CLI. Typically the executable name. -`config_dir` - Path to config dir. e.g. `os.path.join('~', '.myconfig')` +`config_dir` - Path to config dir. e.g. `os.path.expanduser(os.path.join('~', '.myconfig'))` `config_env_var_prefix` - A prefix for environment variables used in config e.g. `CLI_`. Use the `invoke()` method to invoke commands. diff --git a/examples/exapp b/examples/exapp index 4ea8744..b5ac6ad 100755 --- a/examples/exapp +++ b/examples/exapp @@ -79,7 +79,7 @@ class MyCommandsLoader(CLICommandsLoader): mycli = CLI(cli_name=cli_name, - config_dir=os.path.join('~', '.{}'.format(cli_name)), + config_dir=os.path.expanduser(os.path.join('~', '.{}'.format(cli_name))), config_env_var_prefix=cli_name, commands_loader_cls=MyCommandsLoader, help_cls=MyCLIHelp) diff --git a/examples/exapp2 b/examples/exapp2 index 2361f1d..154d63d 100644 --- a/examples/exapp2 +++ b/examples/exapp2 @@ -86,7 +86,7 @@ class MyCLI(CLI): mycli = MyCLI(cli_name=cli_name, - config_dir=os.path.join('~', '.{}'.format(cli_name)), + config_dir=os.path.expanduser(os.path.join('~', '.{}'.format(cli_name))), config_env_var_prefix=cli_name, commands_loader_cls=MyCommandsLoader, help_cls=MyCLIHelp) diff --git a/examples/test_exapp b/examples/test_exapp index 715609d..bec82a3 100755 --- a/examples/test_exapp +++ b/examples/test_exapp @@ -47,7 +47,7 @@ class MyCommandsLoader(CLICommandsLoader): name = 'exapp4' mycli = CLI(cli_name=name, - config_dir=os.path.join('~', '.{}'.format(name)), + config_dir=os.path.expanduser(os.path.join('~', '.{}'.format(name))), config_env_var_prefix=name, commands_loader_cls=MyCommandsLoader) diff --git a/knack/config.py b/knack/config.py index ff23c4a..2581864 100644 --- a/knack/config.py +++ b/knack/config.py @@ -21,7 +21,7 @@ class CLIConfig(object): '0': False, 'no': False, 'false': False, 'off': False} _DEFAULT_CONFIG_ENV_VAR_PREFIX = 'CLI' - _DEFAULT_CONFIG_DIR = os.path.join('~', '.{}'.format('cli')) + _DEFAULT_CONFIG_DIR = os.path.expanduser(os.path.join('~', '.{}'.format('cli'))) _DEFAULT_CONFIG_FILE_NAME = 'config' _CONFIG_DEFAULTS_SECTION = 'defaults' diff --git a/tests/test_cli_scenarios.py b/tests/test_cli_scenarios.py index 995c7aa..782e40d 100644 --- a/tests/test_cli_scenarios.py +++ b/tests/test_cli_scenarios.py @@ -87,7 +87,7 @@ def load_command_table(self, args): self.command_table['abc list'] = CLICommand(self.cli_ctx, 'abc list', a_test_command_handler) return OrderedDict(self.command_table) - mycli = CLI(cli_name='exapp1', config_dir=os.path.join('~', '.exapp1'), commands_loader_cls=MyCommandsLoader) + mycli = CLI(cli_name='exapp1', config_dir=os.path.expanduser(os.path.join('~', '.exapp1')), commands_loader_cls=MyCommandsLoader) expected_output = """[ {