Source code for libqtile.config

# Copyright (c) 2012-2015 Tycho Andersen
# Copyright (c) 2013 xarvh
# Copyright (c) 2013 horsik
# Copyright (c) 2013-2014 roger
# Copyright (c) 2013 Tao Sauvage
# Copyright (c) 2014 ramnes
# Copyright (c) 2014 Sean Vig
# Copyright (c) 2014 Adi Sieker
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
from __future__ import annotations

import contextlib
import os.path
import sys
from typing import TYPE_CHECKING

from libqtile import configurable, hook, utils
from libqtile.backend import base
from import Bar
from libqtile.command.base import CommandObject

    from typing import Callable

    from import BarType
    from libqtile.command.base import ItemT
    from import _Group

[docs]class Key: """Defines a keybinding. Parameters ========== modifiers: A list of modifier specifications. Modifier specifications are one of: "shift", "lock", "control", "mod1", "mod2", "mod3", "mod4", "mod5". key: A key specification, e.g. "a", "Tab", "Return", "space". commands: A list of lazy command objects generated with the lazy.lazy helper. If multiple Call objects are specified, they are run in sequence. desc: description to be added to the key binding """ def __init__(self, modifiers: list[str], key: str, *commands, desc: str = ""): self.modifiers = modifiers self.key = key self.commands = commands self.desc = desc def __repr__(self): return "<Key (%s, %s)>" % (self.modifiers, self.key)
[docs]class KeyChord: """Define a key chord aka vim like mode Parameters ========== modifiers: A list of modifier specifications. Modifier specifications are one of: "shift", "lock", "control", "mod1", "mod2", "mod3", "mod4", "mod5". key: A key specification, e.g. "a", "Tab", "Return", "space". submappings: A list of Key or KeyChord declarations to bind in this chord. mode: A string with vim like mode name. If it's set, the chord mode will not be left after a keystroke (except for Esc which always leaves the current chord/mode). """ def __init__( self, modifiers: list[str], key: str, submappings: list[Key | KeyChord], mode: str = "", ): self.modifiers = modifiers self.key = key submappings.append(Key([], "Escape")) self.submappings = submappings self.mode = mode def __repr__(self): return "<KeyChord (%s, %s)>" % (self.modifiers, self.key)
class Mouse: def __init__(self, modifiers: list[str], button: str, *commands, **kwargs): self.modifiers = modifiers self.button = button self.commands = commands self.button_code = int(self.button.replace("Button", "")) for k, v in kwargs.items(): setattr(self, k, v) self.modmask: int = 0
[docs]class Drag(Mouse): """Defines binding of a mouse to some dragging action On each motion event command is executed with two extra parameters added x and y offset from previous move. """ def __init__(self, *args, start=False, **kwargs): super().__init__(*args, **kwargs) self.start = start def __repr__(self): return "<Drag (%s, %s)>" % (self.modifiers, self.button)
[docs]class Click(Mouse): """Defines binding of a mouse click""" def __repr__(self): return "<Click (%s, %s)>" % (self.modifiers, self.button)
[docs]class EzConfig: """ Helper class for defining key and button bindings in an emacs-like format. Inspired by Xmonad's XMonad.Util.EZConfig. """ modifier_keys = { "M": "mod4", "A": "mod1", "S": "shift", "C": "control", } def parse(self, spec): """ Splits an emacs keydef into modifiers and keys. For example: "M-S-a" -> ['mod4', 'shift'], 'a' "A-<minus>" -> ['mod1'], 'minus' "C-<Tab>" -> ['control'], 'Tab' """ mods = [] keys = [] for key in spec.split("-"): if not key: break if key in self.modifier_keys: if keys: msg = "Modifiers must always come before key/btn: %s" raise utils.QtileError(msg % spec) mods.append(self.modifier_keys[key]) continue if len(key) == 1: keys.append(key) continue if len(key) > 3 and key[0] == "<" and key[-1] == ">": keys.append(key[1:-1]) continue if not keys: msg = "Invalid key/btn specifier: %s" raise utils.QtileError(msg % spec) if len(keys) > 1: msg = "Key chains are not supported: %s" % spec raise utils.QtileError(msg) return mods, keys[0]
class EzKey(EzConfig, Key): def __init__(self, keydef, *commands, **kwargs): modkeys, key = self.parse(keydef) super().__init__(modkeys, key, *commands, **kwargs) class EzClick(EzConfig, Click): def __init__(self, btndef, *commands, **kwargs): modkeys, button = self.parse(btndef) button = "Button%s" % button super().__init__(modkeys, button, *commands, **kwargs) class EzDrag(EzConfig, Drag): def __init__(self, btndef, *commands, **kwargs): modkeys, button = self.parse(btndef) button = "Button%s" % button super().__init__(modkeys, button, *commands, **kwargs) class ScreenRect: def __init__(self, x, y, width, height): self.x = x self.y = y self.width = width self.height = height def __repr__(self): return "<%s %d,%d %d,%d>" % ( self.__class__.__name__, self.x, self.y, self.width, self.height, ) def hsplit(self, columnwidth): assert columnwidth > 0 assert columnwidth < self.width return ( self.__class__(self.x, self.y, columnwidth, self.height), self.__class__(self.x + columnwidth, self.y, self.width - columnwidth, self.height), ) def vsplit(self, rowheight): assert rowheight > 0 assert rowheight < self.height return ( self.__class__(self.x, self.y, self.width, rowheight), self.__class__(self.x, self.y + rowheight, self.width, self.height - rowheight), )
[docs]class Screen(CommandObject): """A physical screen, and its associated paraphernalia. Define a screen with a given set of Bars of a specific geometry. Note that bar.Bar objects can only be placed at the top or the bottom of the screen (bar.Gap objects can be placed anywhere). Also, ``x``, ``y``, ``width``, and ``height`` aren't specified usually unless you are using 'fake screens'. The ``wallpaper`` parameter, if given, should be a path to an image file. How this image is painted to the screen is specified by the ``wallpaper_mode`` parameter. By default, the image will be placed at the screens origin and retain its own dimensions. If the mode is 'fill', the image will be centred on the screen and resized to fill it. If the mode is 'stretch', the image is stretched to fit all of it into the screen. """ group: _Group previous_group: _Group index: int def __init__( self, top: BarType | None = None, bottom: BarType | None = None, left: BarType | None = None, right: BarType | None = None, wallpaper: str | None = None, wallpaper_mode: str | None = None, x: int | None = None, y: int | None = None, width: int | None = None, height: int | None = None, ): = top self.bottom = bottom self.left = left self.right = right self.wallpaper = wallpaper self.wallpaper_mode = wallpaper_mode self.qtile = None # x position of upper left corner can be > 0 # if one screen is "right" of the other self.x = x if x is not None else 0 self.y = y if y is not None else 0 self.width = width if width is not None else 0 self.height = height if height is not None else 0 def _configure(self, qtile, index, x, y, width, height, group, reconfigure_gaps=False): self.qtile = qtile self.index = index self.x = x self.y = y self.width = width self.height = height self.set_group(group) for i in self.gaps: i._configure(qtile, self, reconfigure=reconfigure_gaps) if self.wallpaper: self.wallpaper = os.path.expanduser(self.wallpaper) self.paint(self.wallpaper, self.wallpaper_mode) def paint(self, path, mode=None): self.qtile.paint_screen(self, path, mode) @property def gaps(self): return (i for i in [, self.bottom, self.left, self.right] if i) @property def dx(self): return self.x + self.left.size if self.left else self.x @property def dy(self): return self.y + if else self.y @property def dwidth(self): val = self.width if self.left: val -= self.left.size if self.right: val -= self.right.size return val @property def dheight(self): val = self.height if val -= if self.bottom: val -= self.bottom.size return val def get_rect(self): return ScreenRect(self.dx, self.dy, self.dwidth, self.dheight) def set_group(self, new_group, save_prev=True, warp=True): """Put group on this screen""" if new_group is None: return if new_group.screen == self: return if save_prev and hasattr(self, "group"): self.previous_group = if new_group.screen: # g1 <-> s1 (self) # g2 (new_group) <-> s2 to # g1 <-> s2 # g2 <-> s1 g1 = s1 = self g2 = new_group s2 = new_group.screen = g1 g1.set_screen(s2, warp) = g2 g2.set_screen(s1, warp) else: if hasattr(self, "group"): old_group = ctx = self.qtile.core.masked() else: old_group = None ctx = contextlib.nullcontext() = new_group with ctx: # display clients of the new group and then hide from old group # to remove the screen flickering new_group.set_screen(self, warp) if old_group is not None: old_group.set_screen(None, warp)"setgroup")"focus_change")"layout_change",[], def toggle_group(self, group=None, warp=True): """Switch to the selected group or to the previously active one""" if group in (, None) and hasattr(self, "previous_group"): group = self.previous_group self.set_group(group, warp=warp) def _items(self, name: str) -> ItemT: if name == "layout" and is not None: return True, list(range(len( elif name == "window" and is not None: return True, [i.wid for i in] elif name == "bar": return False, [x.position for x in self.gaps] elif name == "widget": return False, [ for g in self.gaps for w in g.widgets if isinstance(g, Bar)] elif name == "group": return True, [] return None def _select(self, name, sel): if name == "layout": if sel is None: return else: return utils.lget(, sel) elif name == "window": if sel is None: return else: for i in if i.wid == sel: return i elif name == "bar": return getattr(self, sel) elif name == "widget": for gap in self.gaps: if not isinstance(gap, Bar): continue for widget in gap.widgets: if == sel: return widget elif name == "group": if sel is None: return else: return if sel == else None def resize(self, x=None, y=None, w=None, h=None): if x is None: x = self.x if y is None: y = self.y if w is None: w = self.width if h is None: h = self.height self._configure(self.qtile, self.index, x, y, w, h, for bar in [, self.bottom, self.left, self.right]: if bar: bar.draw() self.qtile.call_soon(
[docs] def cmd_info(self): """Returns a dictionary of info for this screen.""" return dict(index=self.index, width=self.width, height=self.height, x=self.x, y=self.y)
[docs] def cmd_resize(self, x=None, y=None, w=None, h=None): """Resize the screen""" self.resize(x, y, w, h)
[docs] def cmd_next_group(self, skip_empty=False, skip_managed=False): """Switch to the next group""" n =, skip_managed) self.set_group(n) return
[docs] def cmd_prev_group(self, skip_empty=False, skip_managed=False, warp=True): """Switch to the previous group""" n =, skip_managed) self.set_group(n, warp=warp) return
[docs] def cmd_toggle_group(self, group_name=None, warp=True): """Switch to the selected group or to the previously active one""" group = self.qtile.groups_map.get(group_name) self.toggle_group(group, warp=warp)
[docs] def cmd_set_wallpaper(self, path, mode=None): """Set the wallpaper to the given file.""" self.paint(path, mode)
[docs]class Group: """Represents a "dynamic" group These groups can spawn apps, only allow certain Matched windows to be on them, hide when they're not in use, etc. Groups are identified by their name. Parameters ========== name: string the name of this group matches: default ``None`` list of ``Match`` objects whose windows will be assigned to this group exclusive: boolean when other apps are started in this group, should we allow them here or not? spawn: string or list of strings this will be ``exec()`` d when the group is created, you can pass either a program name or a list of programs to ``exec()`` layout: string the name of default layout for this group (e.g. 'max' or 'stack'). This is the name specified for a particular layout in or if not defined it defaults in general the class name in all lower case. layouts: list the group layouts list overriding global layouts. Use this to define a separate list of layouts for this particular group. persist: boolean should this group stay alive with no member windows? init: boolean is this group alive when qtile starts? position int group position label: string the display name of the group. Use this to define a display name other than name of the group. If set to None, the display name is set to the name. """ def __init__( self, name: str, matches: list[Match] | None = None, exclusive=False, spawn: str | list[str] | None = None, layout: str | None = None, layouts: list | None = None, persist=True, init=True, layout_opts=None, screen_affinity=None, position=sys.maxsize, label: str | None = None, ): = name self.label = label self.exclusive = exclusive self.spawn = spawn self.layout = layout self.layouts = layouts or [] self.persist = persist self.init = init self.matches = matches or [] self.layout_opts = layout_opts or {} self.screen_affinity = screen_affinity self.position = position def __repr__(self): attrs = utils.describe_attributes( self, [ "exclusive", "spawn", "layout", "layouts", "persist", "init", "matches", "layout_opts", "screen_affinity", ], ) return "<config.Group %r (%s)>" % (, attrs)
[docs]class ScratchPad(Group): """Represents a "ScratchPad" group ScratchPad adds a (by default) invisible group to qtile. That group is used as a place for currently not visible windows spawned by a ``DropDown`` configuration. Parameters ========== name: string the name of this group dropdowns: default ``None`` list of DropDown objects position: int group position label: string The display name of the ScratchPad group. Defaults to the empty string such that the group is hidden in ``GroupList`` widget. single : Boolean Only one of the window among the specified dropdowns will be visible at a time. """ def __init__(self, name, dropdowns=None, position=sys.maxsize, label="", single=False): Group.__init__( self, name, layout="floating", layouts=["floating"], init=False, position=position, label=label, ) self.dropdowns = dropdowns if dropdowns is not None else [] self.single = single def __repr__(self): return "<config.ScratchPad %r (%s)>" % (, ", ".join( for dd in self.dropdowns), )
[docs]class Match: """Match for dynamic groups or auto-floating windows. It can match by title, wm_class, role, wm_type, wm_instance_class or net_wm_pid. ``Match`` supports both regular expression objects (i.e. the result of ``re.compile()``) or strings (match as an "include"-match). If a window matches all specified values, it is considered a match. Parameters ========== title: matches against the WM_NAME atom (X11) or title (Wayland) wm_class: matches against the second string in WM_CLASS atom (X11) or app ID (Wayland) role: matches against the WM_ROLE atom (X11 only) wm_type: matches against the WM_TYPE atom (X11 only) wm_instance_class: matches against the first string in WM_CLASS atom (X11) or app ID (Wayland) net_wm_pid: matches against the _NET_WM_PID atom (X11) or PID (Wayland) - (only int allowed for this rule) func: delegate the match to the given function, which receives the tested client as argument and must return True if it matches, False otherwise """ def __init__( self, title=None, wm_class=None, role=None, wm_type=None, wm_instance_class=None, net_wm_pid=None, func: Callable[[base.WindowType], bool] | None = None, wid=None, ): self._rules = {} if title is not None: self._rules["title"] = title if wm_class is not None: self._rules["wm_class"] = wm_class if wm_instance_class is not None: self._rules["wm_instance_class"] = wm_instance_class if wid is not None: self._rules["wid"] = wid if net_wm_pid is not None: try: self._rules["net_wm_pid"] = int(net_wm_pid) except ValueError: error = 'Invalid rule for net_wm_pid: "%s" only int allowed' % str(net_wm_pid) raise utils.QtileError(error) if func is not None: self._rules["func"] = func if role is not None: self._rules["role"] = role if wm_type is not None: self._rules["wm_type"] = wm_type @staticmethod def _get_property_predicate(name, value): if name == "net_wm_pid" or name == "wid": return lambda other: other == value elif name == "wm_class": def predicate(other): # match as an "include"-match on any of the received classes match = getattr(other, "match", lambda v: v in other) return value and any(match(v) for v in value) return predicate else: def predicate(other): # match as an "include"-match match = getattr(other, "match", lambda v: v in other) return match(value) return predicate def compare(self, client): for property_name, rule_value in self._rules.items(): if property_name == "title": value = elif "class" in property_name: wm_class = client.get_wm_class() if not wm_class: return False if property_name == "wm_instance_class": value = wm_class[0] else: value = wm_class elif property_name == "role": value = client.get_wm_role() elif property_name == "func": return rule_value(client) elif property_name == "net_wm_pid": value = client.get_pid() elif property_name == "wid": value = client.wid else: value = client.get_wm_type() # Some of the window.get_...() functions can return None if value is None: return False match = self._get_property_predicate(property_name, value) if not match(rule_value): return False if not self._rules: return False return True def map(self, callback, clients): """Apply callback to each client that matches this Match""" for c in clients: if callback(c) def __repr__(self): return "<Match %s>" % self._rules
[docs]class Rule: """How to act on a match A Rule contains a list of Match objects, and a specification about what to do when any of them is matched. Parameters ========== match : ``Match`` object or a list of such associated with this ``Rule`` float : auto float this window? intrusive : override the group's exclusive setting? break_on_match : Should we stop applying rules if this rule is matched? """ def __init__(self, match, group=None, float=False, intrusive=False, break_on_match=True): if isinstance(match, Match): self.matchlist = [match] else: self.matchlist = match = group self.float = float self.intrusive = intrusive self.break_on_match = break_on_match def matches(self, w): return any(w.match(m) for m in self.matchlist) def __repr__(self): actions = utils.describe_attributes( self, ["group", "float", "intrusive", "break_on_match"] ) return "<Rule match=%r actions=(%s)>" % (self.matchlist, actions)