tkinter — Python-интерфейс к Tcl/Tk

Программа «Привет, мир»

Мы начнем с рассмотрения приложения «Привет, мир» в Tkinter. Это не самая маленькая программа, которую мы могли бы написать, но она содержит достаточно элементов, чтобы проиллюстрировать некоторые ключевые понятия, которые вам понадобятся.

from tkinter import *
from tkinter import ttk
root = Tk()
frm = ttk.Frame(root, padding=10)
frm.grid()
ttk.Label(frm, text="Hello World!").grid(column=0, row=0)
ttk.Button(frm, text="Quit", command=root.destroy).grid(column=1, row=0)
root.mainloop()

После импорта следующая строка создает экземпляр класса Tk, который инициализирует Tk и создает связанный интерпретатор Tcl. Он также создает окно верхнего уровня, известное как корневое окно, которое служит основным окном приложения.

Следующая строка создает виджет рамки, который в данном случае будет содержать метку и кнопку, которые мы создадим далее. Рамка помещается внутрь корневого окна.

Следующая строка создает виджет метки, содержащий статическую строку текста. Метод grid() используется для задания относительной компоновки (позиции) метки внутри содержащей ее рамки, аналогично тому, как работают таблицы в HTML.

Затем создается виджет кнопки и размещается справа от метки. При нажатии он вызовет метод destroy() корневого окна.

Наконец, метод mainloop() выводит все на экран и реагирует на пользовательский ввод до завершения программы.

Важные понятия Tk

Даже эта простая программа иллюстрирует следующие ключевые понятия Tk:

виджеты

Пользовательский интерфейс Tkinter состоит из отдельных виджетов. Каждый виджет представлен как объект Python, созданный из классов, таких как ttk.Frame, ttk.Label, и ttk.Button.

иерархия виджетов

Виджеты организованы в иерархию. Метка и кнопка были помещены в рамку, которая, в свою очередь, была помещена в корневое окно. При создании каждого дочернего виджета его родительский виджет передается в качестве первого аргумента конструктору виджета.

опции конфигурации

Виджеты имеют опции конфигурации, которые изменяют их внешний вид и поведение, например, текст, отображаемый в метке или кнопке. Разные классы виджетов будут иметь разные наборы опций.

управление геометрией

Виджеты не добавляются автоматически в пользовательский интерфейс при их создании. Управление геометрией, например, grid, управляет тем, где они будут размещены в пользовательском интерфейсе.

цикл событий

Tkinter реагирует на пользовательский ввод, изменения из вашей программы и даже обновляет отображение только при активном выполнении цикла событий. Если ваша программа не выполняет цикл событий, ваш пользовательский интерфейс не будет обновляться.

Понимание того, как Tkinter оборачивает Tcl/Tk

Когда ваше приложение использует классы и методы Tkinter, Tkinter внутренне собирает строки, представляющие команды Tcl/Tk, и выполняет эти команды в интерпретаторе Tcl, связанном с экземпляром вашего приложения Tk.

Независимо от того, пытаетесь ли вы найти справочную документацию, найти нужный метод или опцию, адаптировать существующий код или отлаживать ваше приложение Tkinter, иногда полезно понять, как выглядят эти основополагающие команды Tcl/Tk.

Чтобы проиллюстрировать, вот эквивалент Tcl/Tk основной части скрипта Tkinter, приведенного выше.

ttk::frame .frm -padding 10
grid .frm
grid [ttk::label .frm.lbl -text "Hello World!"] -column 0 -row 0
grid [ttk::button .frm.btn -text "Quit" -command "destroy ."] -column 1 -row 0

Синтаксис Tcl похож на многие языки оболочек, где первое слово — это команда для выполнения, за которой следуют аргументы этой команды, разделенные пробелами. Не углубляясь в подробности, обратите внимание на следующее:

• Команды, используемые для создания виджетов (например, ttk::frame), соответствуют классам виджетов в Tkinter.
• Опции виджетов Tcl (например, -text) соответствуют ключевым аргументам в Tkinter.
• Виджеты упоминаются по пути в Tcl (например, .frm.btn), тогда как Tkinter не использует имена, а использует ссылки на объекты.
• Местоположение виджета в иерархии виджетов кодируется в его (иерархическом) пути, который использует . (точку) в качестве разделителя пути. Путь для корневого окна — просто . (точка). В Tkinter иерархия определяется не путем, а путем указания родительского виджета при создании каждого дочернего виджета.
• Операции, реализованные как отдельные команды в Tcl (например, grid или destroy), представлены как методы объектов виджетов Tkinter. Как вы увидите вскоре, в других случаях Tcl использует то, что кажется вызовами методов объектов виджетов, которые более точно отражают то, что используется в Tkinter.

Как мне…? Какая опция…?

Если вы не знаете, как сделать что-то в Tkinter, и не можете сразу найти это в используемом вами учебнике или справочной документации, есть несколько полезных стратегий.

Во-первых, помните, что детали работы отдельных виджетов могут различаться в разных версиях Tkinter и Tcl/Tk. Если вы ищете документацию, убедитесь, что она соответствует установленным на вашей системе версиям Python и Tcl/Tk.

При поиске способов использования API полезно знать точное имя класса, опции или метода, который вы используете. Интроспекция, либо в интерактивной оболочке Python, либо с помощью print(), может помочь вам определить то, что вам нужно.

Чтобы узнать, какие опции конфигурации доступны для любого виджета, вызовите его метод configure(), который возвращает словарь, содержащий различную информацию об объекте, включая значения по умолчанию и текущие значения. Используйте keys() для получения только имен каждой опции.

btn = ttk.Button(frm, ...)
print(btn.configure().keys())

Поскольку у большинства виджетов есть много общих опций конфигурации, полезно выяснить, какие из них специфичны для определенного класса виджетов. Сравнение списка опций с списком опций более простого виджета, например, рамки, является одним из способов сделать это.

print(set(btn.configure().keys()) - set(frm.configure().keys()))

Аналогично, вы можете найти доступные методы для объекта виджета, используя стандартную функцию dir(). Если вы попробуете, вы увидите, что существует более 200 общих методов виджетов, поэтому опять-таки полезно определить те, которые специфичны для класса виджетов.

print(dir(btn))
print(set(dir(btn)) - set(dir(frm)))

Навигация по справочному руководству Tcl/Tk

Как уже отмечалось, официальная справочная документация по командам Tk (Tk commands) часто является наиболее точным описанием того, какие конкретные операции с виджетами выполняют. Даже зная имя опции или метода, который вам нужен, у вас все равно могут быть несколько мест для поиска.

Хотя все операции в Tkinter реализуются как вызовы методов объектов виджетов, вы видели, что многие операции Tcl/Tk появляются как команды, которые принимают путь к виджету в качестве первого параметра, за которым следуют необязательные параметры, например:

destroy .
grid .frm.btn -column 0 -row 0

Однако другие выглядят больше как методы, вызываемые на объекте виджета (на самом деле, когда вы создаете виджет в Tcl/Tk, он создает Tcl-команду с именем пути к виджету, причем первым параметром этой команды является имя вызываемого метода).

.frm.btn invoke
.frm.lbl configure -text "Goodbye"

В официальной документации Tcl/Tk вы найдете большинство операций, которые выглядят как вызовы методов, в справке по конкретному виджету (например, вы найдете метод invoke() в справке по ttk::button), в то время как функции, принимающие виджет в качестве параметра, часто имеют свою собственную справку (например, grid).

Вы найдете многие общие опции и методы в справочниках по options или ttk::widget, в то время как другие находятся в справке по конкретному классу виджетов.

Вы также обнаружите, что многие методы Tkinter имеют сложные имена, например, winfo_x(), winfo_height(), winfo_viewable(). Вы найдете документацию по всем этим в справке по winfo.

Параметры настройки

Параметры контролируют такие вещи, как цвет и ширину рамки виджета. Параметры могут быть заданы тремя способами:

При создании объекта с использованием ключевых аргументов

fred = Button(self, fg="red", bg="blue")

После создания объекта, рассматривая имя параметра как индекс словаря

fred["fg"] = "red"
fred["bg"] = "blue"

Используйте метод config() для обновления нескольких атрибутов после создания объекта

fred.config(fg="red", bg="blue")

Для получения полного объяснения заданного параметра и его поведения, см. страницы руководства Tk для соответствующего виджета.

Обратите внимание, что страницы руководства перечисляют «СТАНДАРТНЫЕ ПАРАМЕТРЫ» и «ПАРАМЕТРЫ, СПЕЦИФИЧНЫЕ ДЛЯ ВИДЖЕТА» для каждого виджета. Первое — список параметров, общих для многих виджетов, последнее — параметры, специфичные для данного виджета. Стандартные параметры документированы на странице руководства options(3).

В данном документе различие между стандартными и специфичными для виджета параметрами не делается. Некоторые параметры не применяются к некоторым видам виджетов. Реагирует ли конкретный виджет на определенный параметр, зависит от класса виджета; кнопки имеют параметр command, метки — нет.

Поддерживаемые виджетом параметры перечислены на странице руководства этого виджета или могут быть запрошены во время выполнения, вызвав метод config() без аргументов или вызвав метод keys() на этом виджете. Результатом этих вызовов является словарь, ключ которого — имя параметра в виде строки (например, 'relief'), а значения — 5-кортежи.

Некоторые параметры, такие как bg, являются синонимами для общих параметров с длинными именами (bg — сокращение от «background»). Передача имени сокращенного параметра в метод config() вернёт 2-кортеж, а не 5-кортеж. 2-кортеж, возвращаемый назад, будет содержать имя синонима и «настоящий» параметр (например, ('bg', 'background')).

Пример:

>>> print(fred.config())
{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')}

Конечно, напечатанный словарь будет содержать все доступные параметры и их значения. Это лишь пример.

Упаковщик

Упаковщик — один из механизмов управления геометрией Tk. Менеджеры геометрии используются для указания относительного расположения виджетов в их контейнере — их общем родителе. В отличие от более громоздкого размещателя (который используется реже и не рассматривается здесь), упаковщик принимает указания на качественные отношения — над, слева от, заполняющий и т. д. — и вычисляет точные координаты размещения.

Размер любого родительского виджета определяется размером «дочерних виджетов» внутри него. Упаковщик используется для управления тем, где дочерние виджеты появляются внутри родительского виджета, в который они упаковываются. Вы можете упаковывать виджеты в фреймы, а фреймы — в другие фреймы, чтобы добиться желаемой компоновки. Кроме того, расположение динамически корректируется для учета постепенных изменений конфигурации после упаковки.

Обратите внимание, что виджеты не отображаются, пока их геометрия не задана с помощью менеджера геометрии. Это распространённая ошибка на ранней стадии — пропустить задание геометрии и затем удивляться, когда виджет создан, но ничего не отображается. Виджет отобразится только после того, как к нему будет применён, например, метод pack() упаковщика.

Метод pack() можно вызывать с парами «ключевой параметр/значение», которые управляют тем, где виджет должен появиться в контейнере и как он должен вести себя при изменении размера основного окна приложения. Вот несколько примеров:

fred.pack()                     # defaults to side = "top"
fred.pack(side="left")
fred.pack(expand=1)

Параметры упаковщика

Для получения более подробной информации об упаковщике и параметрах, которые он может принимать, см. страницы руководства и страницу 183 книги Джона Аустерхаута.

anchor

Тип привязки. Определяет, где упаковщик помещает каждый дочерний элемент в его области.

expand

Булево значение, 0 или 1.

fill

Допустимые значения: 'x', 'y', 'both', 'none'.

ipadx и ipady

Расстояние — определяющее внутренний отступ по каждой стороне дочернего виджета.

padx и pady

Расстояние — определяющее внешний отступ по каждой стороне дочернего виджета.

side

Допустимые значения: 'left', 'right', 'top', 'bottom'.

Связывание переменных виджетов

Текущее значение некоторых виджетов (например, виджетов текстового ввода) может быть напрямую связано с переменными приложения с помощью специальных параметров. Эти параметры — variable, textvariable, onvalue, offvalue, и value. Эта связь работает в обоих направлениях: если переменная изменяется по какой-либо причине, виджет, с которым она связана, обновляется, отражая новое значение.

К сожалению, в текущей реализации tkinter невозможно передать произвольную Python-переменную виджету через параметр variable или textvariable. Единственными типами переменных, для которых это работает, являются переменные, являющиеся подклассами класса Variable, определенного в tkinter.

Уже определено много полезных подклассов Variable: StringVar, IntVar, DoubleVar, и BooleanVar. Чтобы прочитать текущее значение такой переменной, вызовите метод get() на ней, а чтобы изменить её значение, вызовите метод set(). Если вы следуете этому протоколу, виджет всегда будет отслеживать значение переменной без дальнейшего вмешательства с вашей стороны.

Например:

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master):
        super().__init__(master)
        self.pack()

        self.entrythingy = tk.Entry()
        self.entrythingy.pack()

        # Create the application variable.
        self.contents = tk.StringVar()
        # Set it to some value.
        self.contents.set("this is a variable")
        # Tell the entry widget to watch this variable.
        self.entrythingy["textvariable"] = self.contents

        # Define a callback for when the user hits return.
        # It prints the current value of the variable.
        self.entrythingy.bind('<Key-Return>',
                             self.print_contents)

    def print_contents(self, event):
        print("Hi. The current entry content is:",
              self.contents.get())

root = tk.Tk()
myapp = App(root)
myapp.mainloop()

Менеджер окон

В Tk есть утилитарная команда wm, для взаимодействия с менеджером окон. Параметры команды wm позволяют управлять такими вещами, как заголовки, расположение, значки и тому подобное. В tkinter эти команды были реализованы как методы класса Wm. Виджеты Toplevel являются подклассами класса Wm и, следовательно, могут вызывать методы Wm напрямую.

Чтобы получить окно toplevel, содержащее заданный виджет, часто достаточно обратиться к родительскому элементу виджета. Конечно, если виджет был упакован в фрейм, родительский элемент не будет представлять окно toplevel. Чтобы получить окно toplevel, содержащее произвольный виджет, вы можете вызвать метод _root(). Этот метод начинается с подчеркивания, чтобы указать, что эта функция является частью реализации, а не интерфейсом к функциональности Tk.

Вот несколько примеров типичного использования:

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.pack()

# create the application
myapp = App()

#
# here are method calls to the window manager class
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# start the program
myapp.mainloop()

Типы данных опций Tk

anchor

Допустимые значения — точки компаса: "n", "ne", "e", "se", "s", "sw", "w", "nw", и также "center".

bitmap

Существует восемь встроенных, именованных битовых изображений: 'error', 'gray25', 'gray50', 'hourglass', 'info', 'questhead', 'question', 'warning'. Для указания имени файла X-битового изображения укажите полный путь к файлу, предварив его @, как в "@/usr/contrib/bitmap/gumby.bit".

boolean

Вы можете передать целые числа 0 или 1 или строки "yes" или "no".

callback

Любая функция Python, которая не принимает аргументов. Например:

def print_it():
    print("hi there")
fred["command"] = print_it

color

Цвета могут быть заданы как имена X-цветов в файле rgb.txt или как строки, представляющие значения RGB в 4-битовом: "#RGB", 8-битовом: "#RRGGBB", 12-битовом: "#RRRGGGBBB", или 16-битовом: "#RRRRGGGGBBBB" диапазонах, где R, G, B здесь представляют любые допустимые шестнадцатеричные цифры. Подробности см. на странице 160 книги Остерхаута.

cursor

Можно использовать стандартные имена курсоров X из cursorfont.h без префикса XC_. Например, чтобы получить курсор в виде руки (XC_hand2), используйте строку "hand2". Также можно указать собственный файл битового изображения и маски. См. страницу 179 книги Остерхаута.

distance

Расстояния на экране можно указывать в пикселях или абсолютных единицах. Пиксели задаются числами, а абсолютные расстояния — строками с заключительным символом, обозначающим единицы: c для сантиметров, i для дюймов, m для миллиметров, p для типографских пунктов. Например, 3,5 дюйма выражаются как "3.5i".

font

Tk использует формат имени шрифта в виде списка, например {courier 10 bold}. Размеры шрифтов с положительными числами измеряются в пунктах; размеры с отрицательными числами — в пикселях.

geometry

Это строка формата widthxheight, где ширина и высота измеряются в пикселях для большинства виджетов (в символах для виджетов, отображающих текст). Например: fred["geometry"] = "200x100".

justify

Допустимые значения — строки: "left", "center", "right", и "fill".

region

Это строка с четырьмя элементами, разделенными пробелами, каждый из которых является допустимым расстоянием (см. выше). Например: "2 3 4 5" и "3i 2i 4.5i 2i" и "3c 2c 4c 10.43c" — все являются допустимыми областями.

relief

Определяет стиль границы виджета. Допустимые значения: "raised", "sunken", "flat", "groove", и "ridge".

scrollcommand

Это почти всегда метод set() некоторого виджета полосы прокрутки, но может быть любым методом виджета, принимающим один аргумент.

wrap

Должно быть одним из: "none", "char", или "word".

Связывания и события

Метод bind из команд виджета позволяет наблюдать за определенными событиями и вызывать функцию обратного вызова при появлении события указанного типа. Формат метода bind:

def bind(self, sequence, func, add=''):

где:

sequence

является строкой, обозначающей целевой тип события. (См. страницу руководства bind(3tk), и страницу 201 книги Джона Остерхаута, Tcl and the Tk Toolkit (2nd edition), для получения подробностей).

func

является функцией Python, принимающей один аргумент, которая вызывается при появлении события. В качестве аргумента передается экземпляр Event. (Функции, используемые таким образом, обычно называются обработчиками событий.)

add

является необязательным, либо '' или '+'. Передача пустой строки означает, что данное связывание должно заменить все другие связывания, связанные с этим событием. Передача '+' означает, что данная функция должна быть добавлена в список функций, связанных с этим типом события.

Например:

def turn_red(self, event):
    event.widget["activeforeground"] = "red"

self.button.bind("<Enter>", self.turn_red)

Обратите внимание, как в обработчике событий turn_red() обращается к полю widget события. Это поле содержит виджет, который получил событие X. В следующей таблице перечислены другие поля событий, к которым можно обратиться, и их обозначение в Tk, что может быть полезно при обращении к страницам руководства Tk.

Параметр index

Ряд виджетов требуют передачи параметров «index». Они используются для указания определенного места в виджете Text, определенных символов в виджете Entry или определенных пунктов меню в виджете Menu.

Индексы виджета Entry (index, view index и т.д.)

Виджеты Entry имеют опции, которые ссылаются на позиции символов в отображаемом тексте. Вы можете использовать эти функции tkinter для доступа к этим специальным точкам в виджетах текста:

Индексы виджета Text

Индексная нотация для виджетов Text очень богата и лучше всего описана в страницах руководства Tk.

Индексы меню (menu.invoke(), menu.entryconfig() и т.д.)

Некоторые опции и методы меню манипулируют определенными пунктами меню. В любой ситуации, когда необходим индекс меню для опции или параметра, можно передать:

• целое число, которое относится к числовой позиции пункта в виджете, считая сверху, начиная с 0;
• строку "active", которая относится к позиции меню, которая в настоящее время находится под курсором;
• строку "last" которая относится к последнему пункту меню;
• целое число, предваряемое @, как в @6, где целое число интерпретируется как координата y в пикселях в системе координат меню;
• строку "none", которая указывает отсутствие пункта меню, чаще всего используется с menu.activate() для деактивации всех пунктов, и, наконец,
• строку текста, которая сопоставляется с меткой пункта меню по образцу, сканируя сверху вниз. Обратите внимание, что этот тип индекса рассматривается после всех остальных, а это значит, что совпадения для пунктов меню с метками last, active, или none могут интерпретироваться как вышеперечисленные литералы вместо этого.

Изображения

Изображения разных форматов могут быть созданы с помощью соответствующего подкласса tkinter.Image:

• BitmapImage для изображений в формате XBM.
• PhotoImage для изображений в форматах PGM, PPM, GIF и PNG. Последний поддерживается начиная с Tk 8.6.

Любой тип изображения создается с помощью опции file или data (есть и другие опции).

Объект изображения затем может использоваться везде, где поддерживается опция image некоторым виджетом (например, метками, кнопками, меню). В таких случаях Tk не будет сохранять ссылку на изображение. При удалении последней ссылки Python на объект изображения данные изображения также удаляются, и Tk отобразит пустой прямоугольник там, где использовалось изображение.