docopt-completion 0.1.0__tar.gz → 0.1.2__tar.gz

{docopt_completion-0.1.0 → docopt_completion-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docopt-completion
-Version: 0.1.0
+Version: 0.1.2
 Summary: A completion for the docopt language
 License: MIT
 Author: Anders Ingemann

{docopt_completion-0.1.0 → docopt_completion-0.1.2}/docopt_completion/__main__.py

@@ -15,12 +15,12 @@ log = logging.getLogger(root_name)
 
 __doc__: str = T.cast(str, pkg_doc) + """
 Usage:
-  docopt-completion intermediate [FILE]
-  docopt-completion bash [FILE]
-  docopt-completion zsh [FILE]
-  docopt-completion register [--dir=DIR] (bash|zsh) COMMAND
-  docopt-completion -h
-  docopt-completion --version
+  docopt.completion intermediate [FILE]
+  docopt.completion bash [FILE]
+  docopt.completion zsh [FILE]
+  docopt.completion register [--dir=DIR] (bash|zsh) COMMAND
+  docopt.completion -h
+  docopt.completion --version
 
 Reads a docopt help text on stdin, except for register. FILE is an intermediate
 with annotations.
@@ -33,7 +33,9 @@ Commands:
                 in $fpath or to be sourced after compinit
   register      Write the completion for COMMAND from its --help, which
                 regenerates itself when COMMAND changes. Without --dir the
-                script goes where bash-completion loads it from, or to
+                script goes to the shell's directory in
+                ${XDG_CONFIG_HOME:-~/.config}/docopt.completion/config.yaml,
+                else where bash-completion loads it from, or to
                 ${XDG_DATA_HOME:-~/.local/share}/zsh/site-functions for zsh
 
 Options:
@@ -52,7 +54,7 @@ def docopt_completion(params: Params):
       directory = params['--dir'] or register.default_dir(shell, os.environ)
       path = register.register(shell, T.cast(str, params['COMMAND']), directory)
       log.info(f'Wrote {path}')
-      if shell == 'zsh':
+      if shell == 'zsh' and params['--dir'] is None and register.configured_dir(shell, os.environ) is None:
         log.info(f'Add {directory} to $fpath before compinit if it isn\'t there already')
       return
     text = sys.stdin.read()

{docopt_completion-0.1.0 → docopt_completion-0.1.2}/docopt_completion/bash.sh

@@ -1,4 +1,4 @@
-# bash completion for "PROG", generated by docopt-completion
+# bash completion for "PROG", generated by docopt.completion
 
 FN() {
   "REFRESH"

{docopt_completion-0.1.0 → docopt_completion-0.1.2}/docopt_completion/register.py

@@ -3,9 +3,11 @@ Completion for a docopt program that has none, generated from its `--help`. The
 itself when the program's resolved path or modification time changes.
 """
 import os
+import re
 import shutil
 import subprocess
 import typing as T
+import yaml
 import docopt_parser as P
 from docopt_completion import intermediate, tables, bash, zsh
 
@@ -14,8 +16,25 @@ class NotDocoptError(P.DocoptError):
   pass
 
 
+def configured_dir(shell: str, env: T.Mapping[str, str]) -> "str | None":
+  """The shell's directory in $XDG_CONFIG_HOME/docopt.completion/config.yaml"""
+  config_home = env.get('XDG_CONFIG_HOME') or os.path.join(env['HOME'], '.config')
+  config_path = os.path.join(config_home, 'docopt.completion', 'config.yaml')
+  if os.path.exists(config_path):
+    with open(config_path) as handle:
+      config = T.cast(T.Dict[str, T.Dict[str, str]], yaml.safe_load(handle) or {})
+    if (configured := config.get(shell, {}).get('directory')) is not None:
+      # Expanded like the shell would: ~ and $VAR or ${VAR}
+      return re.sub(r'^~(?=/|$)', env['HOME'], re.sub(
+        r'\$(\w+)|\$\{(\w+)\}', lambda m: env.get(m.group(1) or m.group(2), ''), configured
+      ))
+  return None
+
+
 def default_dir(shell: str, env: T.Mapping[str, str]) -> str:
-  """Where bash-completion lazy-loads user completions from; zsh has no such place"""
+  """The configured directory, else where bash-completion lazy-loads user completions from"""
+  if (configured := configured_dir(shell, env)) is not None:
+    return configured
   data = env.get('XDG_DATA_HOME') or os.path.join(env['HOME'], '.local', 'share')
   if shell == 'bash':
     user_dir = env.get('BASH_COMPLETION_USER_DIR', '').split(':')[0] or os.path.join(data, 'bash-completion')
@@ -38,9 +57,10 @@ def register(shell: str, command: str, directory: str) -> str:
     if node['type'] == 'argument' and intermediate.placeholder_word(key) in ('option', 'options'):
       raise NotDocoptError(f'The help of {command} looks GNU style ({key}), not docopt')
   compiled = tables.compile(result)
-  name = os.path.basename(command)
+  # A path names a file, the usage names the command that runs it
+  name = result['prog'] if os.sep in command else command
   path = os.path.join(directory, f'{name}.bash' if shell == 'bash' else f'_{name}')
-  refresh = (binary, path, ['docopt-completion', 'register', f'--dir={directory}', shell, command])
+  refresh = (binary, path, ['docopt.completion', 'register', f'--dir={directory}', shell, command])
   code = (bash if shell == 'bash' else zsh).generate(name, compiled, refresh)
   os.makedirs(directory, exist_ok=True)
   with open(path, 'w') as handle:

{docopt_completion-0.1.0 → docopt_completion-0.1.2}/docopt_completion/zsh.sh

@@ -1,5 +1,5 @@
 #compdef "PROG"
-# zsh completion for "PROG", generated by docopt-completion
+# zsh completion for "PROG", generated by docopt.completion
 
 FN() {
   "REFRESH"

{docopt_completion-0.1.0 → docopt_completion-0.1.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "docopt-completion"
 description = "A completion for the docopt language"
-version = "0.1.0"
+version = "0.1.2"
 authors = ["Anders Ingemann <anders@ingemann.de>"]
 license = "MIT"
 readme = "docs/README.pypi.md"
@@ -37,7 +37,7 @@ pyright = "^1.1.238"
 types-docopt = "^0.6.11"
 
 [tool.poetry.scripts]
-docopt-completion = "docopt_completion.__main__:main"
+"docopt.completion" = "docopt_completion.__main__:main"
 
 [tool.pyright]
 include = ["docopt_completion", "tests"]