Source code for argcomplete.completers

# Copyright 2012-2023, Andrey Kislyuk and argcomplete contributors.
# Licensed under the Apache License. See for more info.

import argparse
import os
import subprocess

def _call(*args, **kwargs):
    # TODO: replace "universal_newlines" with "text" once 3.6 support is dropped
    kwargs["universal_newlines"] = True
        return subprocess.check_output(*args, **kwargs).splitlines()
    except subprocess.CalledProcessError:
        return []

class BaseCompleter:
    This is the base class that all argcomplete completers should subclass.

    def __call__(
        self, *, prefix: str, action: argparse.Action, parser: argparse.ArgumentParser, parsed_args: argparse.Namespace
        raise NotImplementedError("This method should be implemented by a subclass.")

[docs] class ChoicesCompleter(BaseCompleter):
[docs] def __init__(self, choices): self.choices = choices
def _convert(self, choice): if not isinstance(choice, str): choice = str(choice) return choice
[docs] def __call__(self, **kwargs): return (self._convert(c) for c in self.choices)
EnvironCompleter = ChoicesCompleter(os.environ)
[docs] class FilesCompleter(BaseCompleter): """ File completer class, optionally takes a list of allowed extensions """
[docs] def __init__(self, allowednames=(), directories=True): # Fix if someone passes in a string instead of a list if isinstance(allowednames, (str, bytes)): allowednames = [allowednames] self.allowednames = [x.lstrip("*").lstrip(".") for x in allowednames] self.directories = directories
[docs] def __call__(self, prefix, **kwargs): completion = [] if self.allowednames: if self.directories: files = _call(["bash", "-c", "compgen -A directory -- '{p}'".format(p=prefix)]) completion += [f + "/" for f in files] for x in self.allowednames: completion += _call(["bash", "-c", "compgen -A file -X '!*.{0}' -- '{p}'".format(x, p=prefix)]) else: completion += _call(["bash", "-c", "compgen -A file -- '{p}'".format(p=prefix)]) anticomp = _call(["bash", "-c", "compgen -A directory -- '{p}'".format(p=prefix)]) completion = list(set(completion) - set(anticomp)) if self.directories: completion += [f + "/" for f in anticomp] return completion
class _FilteredFilesCompleter(BaseCompleter): def __init__(self, predicate): """ Create the completer A predicate accepts as its only argument a candidate path and either accepts it or rejects it. """ assert predicate, "Expected a callable predicate" self.predicate = predicate def __call__(self, prefix, **kwargs): """ Provide completions on prefix """ target_dir = os.path.dirname(prefix) try: names = os.listdir(target_dir or ".") except Exception: return # empty iterator incomplete_part = os.path.basename(prefix) # Iterate on target_dir entries and filter on given predicate for name in names: if not name.startswith(incomplete_part): continue candidate = os.path.join(target_dir, name) if not self.predicate(candidate): continue yield candidate + "/" if os.path.isdir(candidate) else candidate
[docs] class DirectoriesCompleter(_FilteredFilesCompleter):
[docs] def __init__(self): _FilteredFilesCompleter.__init__(self, predicate=os.path.isdir)
[docs] class SuppressCompleter(BaseCompleter): """ A completer used to suppress the completion of specific arguments """
[docs] def __init__(self): pass
[docs] def suppress(self): """ Decide if the completion should be suppressed """ return True