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

# xonsh.built_ins

The xonsh built-ins.

Note that this module is named ‘built_ins’ so as not to be confused with the special Python builtins module.

class xonsh.built_ins.Cmd(xsh: XonshSession, *args: str, bg=False, redirects: dict[str, str] | None = None)

  A command group.

  hide()

    dispatch ![]

  obj()

    dispatch !()

  out()

    dispatch $()

  pipe(*args)

    combine $() | $[]

  run()

    dispatch $[]

class xonsh.built_ins.DynamicAccessProxy(refname, objname)

  Proxies access dynamically.

  Parameters:
    refname str

      ‘.’-separated string that represents the new, reference name that the user will access.

    objname str

      ‘.’-separated string that represents the name where the target object actually lives that refname points to.

  property obj

    Dynamically grabs object

class xonsh.built_ins.InlineImporter

  Inline importer allows to import and use module attribute or function in one line.

class xonsh.built_ins.XonshPathLiteral(*args, **kwargs)

  Extension of `pathlib.Path` to support extended functionality.

  classmethod cwd()

    Return a new path pointing to the current working directory.

  classmethod from_uri(uri)

    Return a new path from the given ‘file’ URI.

  classmethod home()

    Return a new path pointing to expanduser(‘~’).

  absolute()

    Return an absolute version of this path No normalization or symlink resolution is performed.

    Use resolve() to resolve symlinks and remove ‘..’ segments.

  as_posix()

    Return the string representation of the path with forward (/) slashes.

  as_uri()

    Return the path as a URI.

  cd() → XonshPathLiteralChangeDirectoryContextManager

    Returns context manager to change the directory e.g. `with p'/tmp'.cd(): $[ls]`

  chmod(mode, *, follow_symlinks=True)

    Extension of `pathlib.Path.chmod` that returns `self` instead of `None`.

  copy(target, **kwargs)

    Recursively copy this file or directory tree to the given destination.

  copy_into(target_dir, **kwargs)

    Copy this file or directory tree into the given existing directory.

  exists(*, follow_symlinks=True)

    Whether this path exists.

    This method normally follows symlinks; to check whether a symlink exists, add the argument follow_symlinks=False.

  expanduser()

    Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser)

  full_match(pattern, *, case_sensitive=None)

    Return True if this path matches the given glob-style pattern. The pattern is matched against the entire path.

  glob(pattern, *, case_sensitive=None, recurse_symlinks=False)

    Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.

  group(*, follow_symlinks=True)

    Return the group name of the file gid.

  hardlink_to(target)

    Make this path a hard link pointing to the same file as target.

    Note the order of arguments (self, target) is the reverse of os.link’s.

  is_absolute()

    True if the path is absolute (has both a root and, if applicable, a drive).

  is_block_device()

    Whether this path is a block device.

  is_char_device()

    Whether this path is a character device.

  is_dir(*, follow_symlinks=True)

    Whether this path is a directory.

  is_fifo()

    Whether this path is a FIFO.

  is_file(*, follow_symlinks=True)

    Whether this path is a regular file (also True for symlinks pointing to regular files).

  is_junction()

    Whether this path is a junction.

  is_mount()

    Check if this path is a mount point

  is_relative_to(other)

    Return True if the path is relative to another path or False.

  is_reserved()

    Return True if the path contains one of the special names reserved by the system, if any.

  is_socket()

    Whether this path is a socket.

  is_symlink()

    Whether this path is a symbolic link.

  iterdir()

    Yield path objects of the directory contents.

    The children are yielded in arbitrary order, and the special entries ‘.’ and ‘..’ are not included.

  joinpath(*pathsegments)

    Combine this path with one or several arguments, and return a new path representing either a subpath (if all arguments are relative paths) or a totally different path (if one of the arguments is anchored).

  lchmod(mode)

    Like chmod(), except if the path points to a symlink, the symlink’s permissions are changed, rather than its target’s.

  lstat()

    Like stat(), except if the path points to a symlink, the symlink’s status information is returned, rather than its target’s.

  match(path_pattern, *, case_sensitive=None)

    Return True if this path matches the given pattern. If the pattern is relative, matching is done from the right; otherwise, the entire path is matched. The recursive wildcard ‘**’ is not supported by this method.

  mkdir(mode=511, parents=False, exist_ok=False)

    Extension of `pathlib.Path.mkdir` that returns `self` instead of `None`.

  move(target)

    Recursively move this file or directory tree to the given destination.

  move_into(target_dir)

    Move this file or directory tree into the given existing directory.

  open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)

    Open the file pointed to by this path and return a file object, as the built-in open() function does.

  owner(*, follow_symlinks=True)

    Return the login name of the file owner.

  read_bytes()

    Open the file in bytes mode, read it, and close the file.

  read_text(encoding=None, errors=None, newline=None)

    Open the file in text mode, read it, and close the file.

  readlink()

    Return the path to which the symbolic link points.

  relative_to(other, *, walk_up=False)

    Return the relative path to another path identified by the passed arguments. If the operation is not possible (because this is not related to the other path), raise ValueError.

    The walk_up parameter controls whether .. may be used to resolve the path.

  rename(target)

    Rename this path to the target path.

    The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.

    Returns the new Path instance pointing to the target path.

  replace(target)

    Rename this path to the target path, overwriting if that path exists.

    The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.

    Returns the new Path instance pointing to the target path.

  resolve(strict=False)

    Make the path absolute, resolving all symlinks on the way and also normalizing it.

  rglob(pattern, *, case_sensitive=None, recurse_symlinks=False)

    Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.

  rmdir()

    Remove this directory. The directory must be empty.

  samefile(other_path)

    Return whether other_path is the same or not as this file (as returned by os.path.samefile()).

  stat(*, follow_symlinks=True)

    Return the result of the stat() system call on this path, like os.stat() does.

  symlink_to(target, target_is_directory=False)

    Make this path a symlink pointing to the target path. Note the order of arguments (link, target) is the reverse of os.symlink.

  touch(mode=438, exist_ok=True)

    Extension of `pathlib.Path.touch` that returns `self` instead of `None`.

  unlink(missing_ok=False)

    Remove this file or link. If the path is a directory, use rmdir() instead.

  walk(top_down=True, on_error=None, follow_symlinks=False)

    Walk the directory tree from this directory, similar to os.walk().

  with_name(name)

    Return a new path with the file name changed.

  with_segments(*pathsegments)

    Construct a new path object from any number of path-like objects. Subclasses may override this method to customize how new path objects are created from methods like iterdir().

  with_stem(stem)

    Return a new path with the stem changed.

  with_suffix(suffix)

    Return a new path with the file suffix changed. If the path has no suffix, add given suffix. If the given suffix is an empty string, remove the suffix from the path.

  write_bytes(data)

    Open the file in bytes mode, write to it, and close the file.

  write_text(data, encoding=None, errors=None, newline=None)

    Open the file in text mode, write to it, and close the file.

  property anchor

    The concatenation of the drive and root, or ‘’.

  property drive

    The drive prefix (letter or UNC path), if any.

  property info

    A PathInfo object that exposes the file type and other file attributes of this path.

  property name

    The final path component, if any.

  property parent

    The logical parent of the path.

  property parents

    A sequence of this path’s logical parents.

  parser = <module 'posixpath' (frozen)>
  property parts

    An object providing sequence-like access to the components in the filesystem path.

  property root

    The root of the path, if any.

  property stem

    The final path component, minus its last suffix.

  property suffix

    The final component’s last suffix, if any.

    This includes the leading period. For example: ‘.txt’

  property suffixes

    A list of the final component’s suffixes, if any.

    These include the leading periods. For example: [‘.tar’, ‘.gz’]

class xonsh.built_ins.XonshPathLiteralChangeDirectoryContextManager(path: XonshPathLiteral)

  Implements context manager to use in xonsh path literal.

class xonsh.built_ins.XonshSession

  All components defining a xonsh session.

  Warning! If you use this object for any reason and access `__xonsh__` or `xonsh.built_ins.XSH` attributes or functions, you do so at your own risk, as the internal contents and behavior of this object may change with any release. For repeatable use cases, find a way to improve `XonshSessionInterface` or `xonsh.api`.

  Attributes:
    exit: int or None

      Session attribute. In case of integer value it signals xonsh to exit with returning this value as exit code.

  cmd(*args: str, **kwargs)
  link_builtins()
  load(execer=None, ctx=None, inherit_env=True, save_origin_env=False, **kwargs)

    Loads the session with default values.

    Parameters:
      execer Execer, optional

        Xonsh execution object, may be None to start

      ctx Mapping, optional

        Context to start xonsh session with.

      inherit_env bool

        If `True`: inherit environment variables from `os.environ`. If `False`: use default values for environment variables and set `$XONSH_ENV_INHERITED = False`.

  unlink_builtins()
  unload()
  property aliases
  property completers

    Returns a list of all available completers. Init when first accessing the attribute

  property last

class xonsh.built_ins.XonshSessionInterface

  Xonsh Session Interface

  Attributes:
    env xonsh.environ.Env

      A xonsh environment e.g. @.env.get(‘HOME’, ‘/tmp’).

    history xonsh.history.History

      Xonsh history backend e.g. @.history[-1].cmd. See also history –help to manage history from command line.

    imp xonsh.built_ins.InlineImporter

      The inline importer provides instant access to library functions and attributes e.g. @.imp.time.time().

    lastcmd xonsh.procs.pipelines.CommandPipeline

      Last executed subprocess-mode command pipeline e.g. @.lastcmd.rtn returns exit code.

  env = None
  history = None
  imp: InlineImporter

    Inline importer allows to import and use module attribute or function in one line.

  lastcmd = None

xonsh.built_ins.call_macro(f, raw_args, glbs, locs)

  Calls a function as a macro, returning its result.

  Parameters:
    f callable object

      The function that is called as `f(*args)`.

    raw_args tuple of str

      The str representation of arguments of that were passed into the macro. These strings will be parsed, compiled, evaled, or left as a string depending on the annotations of f.

    glbs Mapping

      The globals from the call site.

    locs Mapping or None

      The locals from the call site.

xonsh.built_ins.convert_macro_arg(raw_arg, kind, glbs, locs, *, name='<arg>', macroname='<macro>')

  Converts a string macro argument based on the requested kind.

  Parameters:
    raw_arg str

      The str representation of the macro argument.

    kind object

      A flag or type representing how to convert the argument.

    glbs Mapping

      The globals from the call site.

    locs Mapping or None

      The locals from the call site.

    name str, optional

      The macro argument name.

    macroname str, optional

      The name of the macro itself.

  Returns:
    The converted argument.

xonsh.built_ins.ensure_list_of_strs(x)

  Ensures that x is a list of strings.

xonsh.built_ins.ensure_str_or_callable(x)

  Ensures that x is single string or function.

xonsh.built_ins.enter_macro(obj, raw_block, glbs, locs)

  Prepares to enter a context manager macro by attaching the contents of the macro block, globals, and locals to the object. These modifications are made in-place and the original object is returned.

  Parameters:
    obj context manager

      The object that is about to be entered via a with-statement.

    raw_block str

      The str of the block that is the context body. This string will be parsed, compiled, evaled, or left as a string depending on the return annotation of obj.__enter__.

    glbs Mapping

      The globals from the context site.

    locs Mapping or None

      The locals from the context site.

  Returns:
    obj context manager

      The same context manager but with the new macro information applied.

xonsh.built_ins.eval_fstring_field(field)

  Evaluates the argument in Xonsh context.

xonsh.built_ins.get_default_builtins(execer=None)

xonsh.built_ins.globsearch(s)

xonsh.built_ins.helper(x, name='')

  Prints help about, and then returns that variable.

xonsh.built_ins.in_macro_call(f, glbs, locs)

  Attaches macro globals and locals temporarily to function as a context manager.

  Parameters:
    f callable object

      The function that is called as `f(*args)`.

    glbs Mapping

      The globals from the call site.

    locs Mapping or None

      The locals from the call site.

xonsh.built_ins.list_of_list_of_strs_outer_product(x)

  Takes an outer product of a list of strings

xonsh.built_ins.list_of_strs_or_callables(x)

  Ensures that x is a list of strings or functions. This is called when using the `@()` operator to expand it’s content.

xonsh.built_ins.path_literal(s)

xonsh.built_ins.pathsearch(func, s, pymode=False, pathobj=False)

  Takes a string and returns a list of file paths that match (regex, glob, or arbitrary search function). If pathobj=True, the return is a list of pathlib.Path objects instead of strings.

xonsh.built_ins.regexsearch(s)

xonsh.built_ins.reglob(path, parts=None, i=None)

  Regular expression-based globbing.

xonsh.built_ins.resetting_signal_handle(sig, f)

  Sets a new signal handle that will automatically restore the old value once the new handle is finished.

xonsh.built_ins.subproc_captured_hiddenobject(*cmds, envs=None)

  Runs a subprocess, capturing the output. Returns an instance of HiddenCommandPipeline representing the completed command.

xonsh.built_ins.subproc_captured_inject(*cmds, envs=None)

  Runs a subprocess, capturing the output. Returns a list of whitespace-separated strings of the stdout that was produced. The string is split using xonsh’s lexer, rather than Python’s str.split() or shlex.split().

xonsh.built_ins.subproc_captured_object(*cmds, envs=None)

  Runs a subprocess, capturing the output. Returns an instance of CommandPipeline representing the completed command.

xonsh.built_ins.subproc_captured_stdout(*cmds, envs=None)

  Runs a subprocess, capturing the output. Returns the stdout that was produced as a str or list based on `$XONSH_SUBPROC_OUTPUT_FORMAT`.

xonsh.built_ins.subproc_uncaptured(*cmds, envs=None)

  Runs a subprocess, without capturing the output. Returns the stdout that was produced as a str.

xonsh.built_ins.superhelper(x, name='')

  Prints help about, and then returns that variable.

xonsh.built_ins.xonsh_builtins(execer=None)

  A context manager for using the xonsh builtins only in a limited scope. Likely useful in testing.