Skip to content

user bash completion path by default #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kindlychung wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

user bash completion path by default #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions src/infi/docopt_completion/bash.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from .common import CompletionGenerator
import os
import string
from pathlib import Path

FILE_TEMPLATE = """{0}\ncomplete -o bashdefault -o default -o filenames -F _{1} {2}"""

Expand All @@ -27,12 +28,13 @@
_{1}_{0}
;;"""


class BashCompletion(CompletionGenerator):
def get_name(self):
return "BASH with bash-completion"

def get_completion_path(self):
return "/etc/bash_completion.d"
return os.path.join(Path.home(), ".bash_completion.d")

def get_completion_filepath(self, cmd):
completion_path = self.get_completion_path()
Expand All @@ -41,24 +43,28 @@ def get_completion_filepath(self, cmd):
def create_subcommand_switch(self, cmd_name, level_num, subcommands, opts):
if len(subcommands) == 0:
return ""
subcommand_cases = '\n'.join(CASE_TEMPLATE.format(subcommand, cmd_name) for subcommand in subcommands)
subcommand_cases = '\n'.join(CASE_TEMPLATE.format(
subcommand, cmd_name) for subcommand in subcommands)
return SUBCOMMAND_SWITCH_TEMPLATE.format(level_num=level_num, subcommand_cases=subcommand_cases)

def create_compreply(self, param_tree):
# add -f (show files in completion options) if there are arguments in the current section
# in this case there are (usually) no subcommands to suggest, and only flags, so it's ok to suggest files,
# and if the user types "-" first, then only the flags will be suggested
flag = '-fW' if len(param_tree.arguments) > 0 else '-W'
word_list = " ".join(param_tree.options) + " " + " ".join(param_tree.subcommands.keys())
word_list = " ".join(param_tree.options) + " " + \
" ".join(param_tree.subcommands.keys())
return "{} '{}'".format(flag, word_list)

def create_section(self, cmd_name, param_tree, option_help, level_num):
subcommands = param_tree.subcommands
opts = param_tree.options
subcommand_switch = self.create_subcommand_switch(cmd_name, level_num, subcommands, opts)
subcommand_switch = self.create_subcommand_switch(
cmd_name, level_num, subcommands, opts)
res = SECTION_TEMPLATE.format(cmd_name=cmd_name,
level_num=level_num,
compreply=self.create_compreply(param_tree),
compreply=self.create_compreply(
param_tree),
subcommand_switch=subcommand_switch,
op="eq" if len(subcommands) > 0 else 'ge')
for subcommand_name, subcommand_tree in subcommands.items():
Expand All @@ -74,9 +80,11 @@ def sanitize_name(self, name):
return "".join([char for char in name if char in valid_chars])

def get_completion_file_content(self, cmd, param_tree, option_help):
completion_file_inner_content = self.create_section(self.sanitize_name(cmd), param_tree, option_help, 1)
completion_file_inner_content = self.create_section(
self.sanitize_name(cmd), param_tree, option_help, 1)
return FILE_TEMPLATE.format(completion_file_inner_content, self.sanitize_name(cmd), cmd)


class ManualBashCompletion(BashCompletion):
def get_completion_path(self):
return "."