Method _complete_users

cmd2/cmd2.py:2144–2179

Complete ~ and ~user strings. :param text: the string prefix we are attempting to match (all matches must begin with it) :param add_trailing_sep_if_dir: whether a trailing separator should be appended to directory completions :return: a Completions object

(text: str, add_trailing_sep_if_dir: bool)

    @staticmethod
    def _complete_users(text: str, add_trailing_sep_if_dir: bool) -> Completions:
        """Complete ~ and ~user strings.

        :param text: the string prefix we are attempting to match (all matches must begin with it)
        :param add_trailing_sep_if_dir: whether a trailing separator should be appended to directory completions
        :return: a Completions object
        """
        items: list[CompletionItem] = []

        # Windows lacks the pwd module so we can't get a list of users.
        # Instead we will return a result once the user enters text that
        # resolves to an existing home directory.
        if sys.platform.startswith("win"):
            expanded_path = os.path.expanduser(text)
            if os.path.isdir(expanded_path):
                user = text
                if add_trailing_sep_if_dir:
                    user += os.path.sep
                items.append(CompletionItem(user))
        else:
            import pwd

            # Iterate through a list of users from the password database
            for cur_pw in pwd.getpwall():
                # Check if the user has an existing home dir
                if os.path.isdir(cur_pw.pw_dir):
                    # Add a ~ to the user to match against text
                    cur_user = "~" + cur_pw.pw_name
                    if cur_user.startswith(text):
                        if add_trailing_sep_if_dir:
                            cur_user += os.path.sep
                        items.append(CompletionItem(cur_user))

        # Since all ~user matches resolve to directories, set allow_finalization to False
        # so the user can continue into the subdirectory structure.
        return Completions(items=items, allow_finalization=False)

    def path_complete(
        self,