xonsh.completers.tools#

Xonsh completer tools.

class xonsh.completers.tools.RichCompletion(value, *args, **kwargs)[source]#

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.

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).

count(sub[, start[, end]])int#

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

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.

endswith(suffix[, start[, end]])bool#

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

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.

find(sub[, start[, end]])int#

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs)str#

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

format_map(mapping)str#

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

index(sub[, start[, end]])int#

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

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 the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

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.

static maketrans(x, y=<unrepresentable>, z=<unrepresentable>, /)#

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

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)[source]#

Create a new RichCompletion with replaced attributes

rfind(sub[, start[, end]])int#

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]])int#

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

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 words in the string, using sep as the delimiter string.

sep

The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result.

maxsplit

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

Splits are done starting at the end of the string and working 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 words in the string, using sep as the delimiter string.

sep

The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result.

maxsplit

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

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.

startswith(prefix[, start[, end]])bool#

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

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)[source]#
xonsh.completers.tools.comp_based_completer(ctx: xonsh.parsers.completion_context.CommandContext, start_index=0, **env: str)[source]#

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)[source]#
xonsh.completers.tools.completion_from_cmd_output(line: str, append_space=False)[source]#
xonsh.completers.tools.contextual_command_completer(func: Callable[[xonsh.parsers.completion_context.CommandContext], Optional[Union[Set[Union[xonsh.completers.tools.RichCompletion, str]], Tuple[Set[Union[xonsh.completers.tools.RichCompletion, str]], int]]]])[source]#

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)[source]#

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

xonsh.completers.tools.contextual_completer(func: Callable[[xonsh.parsers.completion_context.CompletionContext], Optional[Union[Set[Union[xonsh.completers.tools.RichCompletion, str]], Tuple[Set[Union[xonsh.completers.tools.RichCompletion, str]], int]]]])[source]#

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()[source]#

Return an appropriate filtering function for completions, given the valid of $CASE_SENSITIVE_COMPLETIONS

xonsh.completers.tools.is_contextual_completer(func)[source]#
xonsh.completers.tools.is_exclusive_completer(func)[source]#
xonsh.completers.tools.justify(s, max_length, left_pad=0)[source]#

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)[source]#

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[source]#