Skip to content
Back to top
View this page
Edit this page

# xonsh.completers.tools

Xonsh completer tools.

class xonsh.completers.tools.RichCompletion(value, *args, **kwargs)

  A rich completion that completers can return instead of a string

  Parameters:
    value

      The completion’s actual value.

    prefix_len

      Length of the prefix to be replaced in the completion. If None, the default prefix len will be used.

    display

      Text to display in completion option list instead of `value`. NOTE: If supplied, the common prefix with other completions won’t be removed.

    description

      Extra text to display when the completion is selected.

    style

      Style to pass to prompt-toolkit’s `Completion` object.

    append_closing_quote

      Whether to append a closing quote to the completion if the cursor is after it. See `Completer.complete` in `xonsh/completer.py`

    append_space

      Whether to append a space after the completion. This is intended to work with `appending_closing_quote`, so the space will be added correctly after the closing quote. This is used in `Completer.complete`. An extra bonus is that the space won’t show up in the `display` attribute.

    provider

      Optional, debug-only tag identifying the sub-source inside the completer that produced this completion (e.g. `"alias"`, `"command"`, `"python"`, `"path"`). Surfaced by `$XONSH_COMPLETER_TRACE` so users can tell whether a match came from, say, an alias vs. a `$PATH` executable inside the same `base` completer. Does not affect UX.

  capitalize(/)

    Return a capitalized version of the string.

    More specifically, make the first character have upper case and the rest lower case.

  casefold(/)

    Return a version of the string suitable for caseless comparisons.

  center(width, fillchar=' ', /)

    Return a centered string of length width.

    Padding is done using the specified fill character (default is a space).

  encode(/, encoding='utf-8', errors='strict')

    Encode the string using the codec registered for encoding.

    encoding

      The encoding in which to encode the string.

    errors

      The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

  expandtabs(/, tabsize=8)

    Return a copy where all tab characters are expanded using spaces.

    If tabsize is not given, a tab size of 8 characters is assumed.

  format(*args, **kwargs)

    Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

  format_map(mapping, /)

    Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

  isalnum(/)

    Return True if the string is an alpha-numeric string, False otherwise.

    A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

  isalpha(/)

    Return True if the string is an alphabetic string, False otherwise.

    A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

  isascii(/)

    Return True if all characters in the string are ASCII, False otherwise.

    ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

  isdecimal(/)

    Return True if the string is a decimal string, False otherwise.

    A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

  isdigit(/)

    Return True if the string is a digit string, False otherwise.

    A string is a digit string if all characters in the string are digits and there is at least one character in the string.

  isidentifier(/)

    Return True if the string is a valid Python identifier, False otherwise.

    Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

  islower(/)

    Return True if the string is a lowercase string, False otherwise.

    A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

  isnumeric(/)

    Return True if the string is a numeric string, False otherwise.

    A string is numeric if all characters in the string are numeric and there is at least one character in the string.

  isprintable(/)

    Return True if all characters in the string are printable, False otherwise.

    A character is printable if repr() may use it in its output.

  isspace(/)

    Return True if the string is a whitespace string, False otherwise.

    A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

  istitle(/)

    Return True if the string is a title-cased string, False otherwise.

    In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

  isupper(/)

    Return True if the string is an uppercase string, False otherwise.

    A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

  join(iterable, /)

    Concatenate any number of strings.

    The string whose method is called is inserted in between each given string. The result is returned as a new string.

    Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

  ljust(width, fillchar=' ', /)

    Return a left-justified string of length width.

    Padding is done using the specified fill character (default is a space).

  lower(/)

    Return a copy of the string converted to lowercase.

  lstrip(chars=None, /)

    Return a copy of the string with leading whitespace removed.

    If chars is given and not None, remove characters in chars instead.

  partition(sep, /)

    Partition the string into three parts using the given separator.

    This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

    If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

  removeprefix(prefix, /)

    Return a str with the given prefix string removed if present.

    If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

  removesuffix(suffix, /)

    Return a str with the given suffix string removed if present.

    If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

  replace(**kwargs)

    Create a new RichCompletion with replaced attributes

  rjust(width, fillchar=' ', /)

    Return a right-justified string of length width.

    Padding is done using the specified fill character (default is a space).

  rpartition(sep, /)

    Partition the string into three parts using the given separator.

    This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

    If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

  rsplit(/, sep=None, maxsplit=-1)

    Return a list of the substrings in the string, using sep as the separator string.

    > sep

    >   The separator used to split the string.

    >   When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

    > maxsplit

    >   Maximum number of splits. -1 (the default value) means no limit.

    Splitting starts at the end of the string and works to the front.

  rstrip(chars=None, /)

    Return a copy of the string with trailing whitespace removed.

    If chars is given and not None, remove characters in chars instead.

  split(/, sep=None, maxsplit=-1)

    Return a list of the substrings in the string, using sep as the separator string.

    > sep

    >   The separator used to split the string.

    >   When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

    > maxsplit

    >   Maximum number of splits. -1 (the default value) means no limit.

    Splitting starts at the front of the string and works to the end.

    Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

  splitlines(/, keepends=False)

    Return a list of the lines in the string, breaking at line boundaries.

    Line breaks are not included in the resulting list unless keepends is given and true.

  strip(chars=None, /)

    Return a copy of the string with leading and trailing whitespace removed.

    If chars is given and not None, remove characters in chars instead.

  swapcase(/)

    Convert uppercase characters to lowercase and lowercase characters to uppercase.

  title(/)

    Return a version of the string where each word is titlecased.

    More specifically, words start with uppercased characters and all remaining cased characters have lower case.

  translate(table, /)

    Replace each character in the string using the given translation table.

    > table

    >   Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

    The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

  upper(/)

    Return a copy of the string converted to uppercase.

  zfill(width, /)

    Pad a numeric string with zeros on the left, to fill a field of the given width.

    The string is never truncated.

  property value

xonsh.completers.tools.apply_lprefix(comps, lprefix)

xonsh.completers.tools.comp_based_completer(ctx: CommandContext, start_index=0, **env: str)

  Helper function to complete commands such as `pip`,``django-admin``,… that use bash’s `complete`

xonsh.completers.tools.complete_from_sub_proc(*args: str, sep=None, filter_prefix=None, **env_vars: str)

xonsh.completers.tools.completion_from_cmd_output(line: str, append_space=False)

xonsh.completers.tools.contextual_command_completer(func: Callable[[CommandContext], set[RichCompletion | str] | tuple[set[RichCompletion | str], int] | None])

  like `contextual_completer`, but will only run when completing a command and will directly receive the `CommandContext` object

xonsh.completers.tools.contextual_command_completer_for(cmd: str)

  like `contextual_command_completer`, but will only run when completing the `cmd` command

xonsh.completers.tools.contextual_completer(func: Callable[[CompletionContext], set[RichCompletion | str] | tuple[set[RichCompletion | str], int] | None])

  Decorator for a contextual completer

  This is used to mark completers that want to use the parsed completion context. See `xonsh/parsers/completion_context.py`.

  `func` receives a single CompletionContext object.

xonsh.completers.tools.get_filter_function()

  Return the completion filter function based on `$XONSH_COMPLETER_MODE`.

  Modes:

  - `"substring_tier"` (default) — completions are filtered by case-insensitive substring match. The pipeline’s tier-based sort ranks prefix matches above substring matches.

  - `"prefix"` — only completions that start with the prefix are shown (case-insensitive).

xonsh.completers.tools.is_contextual_completer(func)

xonsh.completers.tools.is_exclusive_completer(func)

xonsh.completers.tools.justify(s, max_length, left_pad=0)

  Re-wrap the string s so that each line is no more than max_length characters long, padding all lines but the first on the left with the string left_pad.

xonsh.completers.tools.non_exclusive_completer(func)

  Decorator for a non-exclusive completer

  This is used to mark completers that will be collected with other completer’s results.

xonsh.completers.tools.sub_proc_get_output(*args, **env_vars: str) → tuple[bytes, bool]

xonsh.completers.tools.tag_provider(result, provider: str)

  Tag completer output with `provider` for `$XONSH_COMPLETER_TRACE`.

  Accepts any of the three standard completer return shapes and preserves the shape so downstream pipeline logic (exclusivity, filtering, lprefix) is unaffected:

  - `None` → returned unchanged.

  - `(comps, extra)` 2-tuple → `(tagged_generator, extra)`.

  - Any other iterable → generator of tagged completions.