It's based on ttkcalendar.py. But the internals are totally changed.I don't use for example the Treeview widget. I added more features also:
- On mouse over, the day label changes the background
- The selected day has an outstanding style
- Added support for many hotkeys
These are the default bindings:
Click button 1 on entry: Show calendar
Click button 1 outside entry and calendar: Hide calendar
Escape: Hide calendar
CTRL + PAGE UP: Move to the previous month.
CTRL + PAGE DOWN: Move to the next month.
CTRL + SHIFT + PAGE UP: Move to the previous year.
CTRL + SHIFT + PAGE DOWN: Move to the next year.
CTRL + LEFT: Move to the previous day.
CTRL + RIGHT: Move to the next day.
CTRL + UP: Move to the previous week.
CTRL + DOWN: Move to the next week.
CTRL + END: Close the datepicker and erase the date.
CTRL + HOME: Move to the current month.
CTRL + SPACE: Show date on calendar
CTRL + Return: Set current selection to entry
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 | # Author: Miguel Martinez Lopez
#
# Version: 1.0.7
#
# Uncomment the next line to see my email
# print("Author's email: %s"%"61706c69636163696f6e616d656469646140676d61696c2e636f6d".decode("hex"))
"""
These are the default bindings:
Click button 1 on entry: Show calendar
Click button 1 outsite calendar and entry: Hide calendar
Escape: Hide calendar
CTRL + PAGE UP: Move to the previous month.
CTRL + PAGE DOWN: Move to the next month.
CTRL + SHIFT + PAGE UP: Move to the previous year.
CTRL + SHIFT + PAGE DOWN: Move to the next year.
CTRL + LEFT: Move to the previous day.
CTRL + RIGHT: Move to the next day.
CTRL + UP: Move to the previous week.
CTRL + DOWN: Move to the next week.
CTRL + END: Close the datepicker and erase the date.
CTRL + HOME: Move to the current month.
CTRL + SPACE: Show date on calendar
CTRL + Return: Set current selection to entry
"""
import calendar
import datetime
try:
import Tkinter
import tkFont
import ttk
from Tkconstants import CENTER, LEFT, N, E, W, S
from Tkinter import StringVar
except ImportError: # py3k
import tkinter as Tkinter
import tkinter.font as tkFont
import tkinter.ttk as ttk
from tkinter.constants import CENTER, LEFT, N, E, W, S
from tkinter import StringVar
def get_calendar(locale, fwday):
# instantiate proper calendar class
if locale is None:
return calendar.TextCalendar(fwday)
else:
return calendar.LocaleTextCalendar(fwday, locale)
class Calendar(ttk.Frame):
datetime = calendar.datetime.datetime
timedelta = calendar.datetime.timedelta
def __init__(self, master=None, year=None, month=None, firstweekday=calendar.MONDAY, locale=None, activebackground='#b1dcfb', activeforeground='black', selectbackground='#003eff', selectforeground='white', command=None, borderwidth=1, relief="solid", on_click_month_button=None):
"""
WIDGET OPTIONS
locale, firstweekday, year, month, selectbackground,
selectforeground, activebackground, activeforeground,
command, borderwidth, relief, on_click_month_button
"""
if year is None:
year = self.datetime.now().year
if month is None:
month = self.datetime.now().month
self._selected_date = None
self._sel_bg = selectbackground
self._sel_fg = selectforeground
self._act_bg = activebackground
self._act_fg = activeforeground
self.on_click_month_button = on_click_month_button
self._selection_is_visible = False
self._command = command
ttk.Frame.__init__(self, master, borderwidth=borderwidth, relief=relief)
self.bind("<FocusIn>", lambda event:self.event_generate('<<DatePickerFocusIn>>'))
self.bind("<FocusOut>", lambda event:self.event_generate('<<DatePickerFocusOut>>'))
self._cal = get_calendar(locale, firstweekday)
# custom ttk styles
style = ttk.Style()
style.layout('L.TButton', (
[('Button.focus', {'children': [('Button.leftarrow', None)]})]
))
style.layout('R.TButton', (
[('Button.focus', {'children': [('Button.rightarrow', None)]})]
))
self._font = tkFont.Font()
self._header_var = StringVar()
# header frame and its widgets
hframe = ttk.Frame(self)
lbtn = ttk.Button(hframe, style='L.TButton', command=self._on_press_left_button)
lbtn.pack(side=LEFT)
self._header = ttk.Label(hframe, width=15, anchor=CENTER, textvariable=self._header_var)
self._header.pack(side=LEFT, padx=12)
rbtn = ttk.Button(hframe, style='R.TButton', command=self._on_press_right_button)
rbtn.pack(side=LEFT)
hframe.grid(columnspan=7, pady=4)
self._day_labels = {}
days_of_the_week = self._cal.formatweekheader(3).split()
for i, day_of_the_week in enumerate(days_of_the_week):
Tkinter.Label(self, text=day_of_the_week, background='grey90').grid(row=1, column=i, sticky=N+E+W+S)
for i in range(6):
for j in range(7):
self._day_labels[i,j] = label = Tkinter.Label(self, background = "white")
label.grid(row=i+2, column=j, sticky=N+E+W+S)
label.bind("<Enter>", lambda event: event.widget.configure(background=self._act_bg, foreground=self._act_fg))
label.bind("<Leave>", lambda event: event.widget.configure(background="white"))
label.bind("<1>", self._pressed)
# adjust its columns width
font = tkFont.Font()
maxwidth = max(font.measure(text) for text in days_of_the_week)
for i in range(7):
self.grid_columnconfigure(i, minsize=maxwidth, weight=1)
self._year = None
self._month = None
# insert dates in the currently empty calendar
self._build_calendar(year, month)
def _build_calendar(self, year, month):
if not( self._year == year and self._month == month):
self._year = year
self._month = month
# update header text (Month, YEAR)
header = self._cal.formatmonthname(year, month, 0)
self._header_var.set(header.title())
# update calendar shown dates
cal = self._cal.monthdayscalendar(year, month)
for i in range(len(cal)):
week = cal[i]
fmt_week = [('%02d' % day) if day else '' for day in week]
for j, day_number in enumerate(fmt_week):
self._day_labels[i,j]["text"] = day_number
if len(cal) < 6:
for j in range(7):
self._day_labels[5,j]["text"] = ""
if self._selected_date is not None and self._selected_date.year == self._year and self._selected_date.month == self._month:
self._show_selection()
def _find_label_coordinates(self, date):
first_weekday_of_the_month = (date.weekday() - date.day) % 7
return divmod((first_weekday_of_the_month - self._cal.firstweekday)%7 + date.day, 7)
def _show_selection(self):
"""Show a new selection."""
i,j = self._find_label_coordinates(self._selected_date)
label = self._day_labels[i,j]
label.configure(background=self._sel_bg, foreground=self._sel_fg)
label.unbind("<Enter>")
label.unbind("<Leave>")
self._selection_is_visible = True
def _clear_selection(self):
"""Show a new selection."""
i,j = self._find_label_coordinates(self._selected_date)
label = self._day_labels[i,j]
label.configure(background= "white", foreground="black")
label.bind("<Enter>", lambda event: event.widget.configure(background=self._act_bg, foreground=self._act_fg))
label.bind("<Leave>", lambda event: event.widget.configure(background="white"))
self._selection_is_visible = False
# Callback
def _pressed(self, evt):
"""Clicked somewhere in the calendar."""
text = evt.widget["text"]
if text == "":
return
day_number = int(text)
new_selected_date = datetime.datetime(self._year, self._month, day_number)
if self._selected_date != new_selected_date:
if self._selected_date is not None:
self._clear_selection()
self._selected_date = new_selected_date
self._show_selection()
if self._command:
self._command(self._selected_date)
def _on_press_left_button(self):
self.prev_month()
if self.on_click_month_button is not None:
self.on_click_month_button()
def _on_press_right_button(self):
self.next_month()
if self.on_click_month_button is not None:
self.on_click_month_button()
def select_prev_day(self):
"""Updated calendar to show the previous day."""
if self._selected_date is None:
self._selected_date = datetime.datetime(self._year, self._month, 1)
else:
self._clear_selection()
self._selected_date = self._selected_date - self.timedelta(days=1)
self._build_calendar(self._selected_date.year, self._selected_date.month) # reconstruct calendar
def select_next_day(self):
"""Update calendar to show the next day."""
if self._selected_date is None:
self._selected_date = datetime.datetime(self._year, self._month, 1)
else:
self._clear_selection()
self._selected_date = self._selected_date + self.timedelta(days=1)
self._build_calendar(self._selected_date.year, self._selected_date.month) # reconstruct calendar
def select_prev_week_day(self):
"""Updated calendar to show the previous week."""
if self._selected_date is None:
self._selected_date = datetime.datetime(self._year, self._month, 1)
else:
self._clear_selection()
self._selected_date = self._selected_date - self.timedelta(days=7)
self._build_calendar(self._selected_date.year, self._selected_date.month) # reconstruct calendar
def select_next_week_day(self):
"""Update calendar to show the next week."""
if self._selected_date is None:
self._selected_date = datetime.datetime(self._year, self._month, 1)
else:
self._clear_selection()
self._selected_date = self._selected_date + self.timedelta(days=7)
self._build_calendar(self._selected_date.year, self._selected_date.month) # reconstruct calendar
def select_current_date(self):
"""Update calendar to current date."""
if self._selection_is_visible: self._clear_selection()
self._selected_date = datetime.datetime.now()
self._build_calendar(self._selected_date.year, self._selected_date.month)
def prev_month(self):
"""Updated calendar to show the previous week."""
if self._selection_is_visible: self._clear_selection()
date = self.datetime(self._year, self._month, 1) - self.timedelta(days=1)
self._build_calendar(date.year, date.month) # reconstuct calendar
def next_month(self):
"""Update calendar to show the next month."""
if self._selection_is_visible: self._clear_selection()
date = self.datetime(self._year, self._month, 1) + \
self.timedelta(days=calendar.monthrange(self._year, self._month)[1] + 1)
self._build_calendar(date.year, date.month) # reconstuct calendar
def prev_year(self):
"""Updated calendar to show the previous year."""
if self._selection_is_visible: self._clear_selection()
self._build_calendar(self._year-1, self._month) # reconstruct calendar
def next_year(self):
"""Update calendar to show the next year."""
if self._selection_is_visible: self._clear_selection()
self._build_calendar(self._year+1, self._month) # reconstruct calendar
def get_selection(self):
"""Return a datetime representing the current selected date."""
return self._selected_date
selection = get_selection
def set_selection(self, date):
"""Set the selected date."""
if self._selected_date is not None and self._selected_date != date:
self._clear_selection()
self._selected_date = date
self._build_calendar(date.year, date.month) # reconstruct calendar
# see this URL for date format information:
# https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
class Datepicker(ttk.Entry):
def __init__(self, master, entrywidth=None, entrystyle=None, datevar=None, dateformat="%Y-%m-%d", onselect=None, firstweekday=calendar.MONDAY, locale=None, activebackground='#b1dcfb', activeforeground='black', selectbackground='#003eff', selectforeground='white', borderwidth=1, relief="solid"):
if datevar is not None:
self.date_var = datevar
else:
self.date_var = Tkinter.StringVar()
entry_config = {}
if entrywidth is not None:
entry_config["width"] = entrywidth
if entrystyle is not None:
entry_config["style"] = entrystyle
ttk.Entry.__init__(self, master, textvariable=self.date_var, **entry_config)
self.date_format = dateformat
self._is_calendar_visible = False
self._on_select_date_command = onselect
self.calendar_frame = Calendar(self.winfo_toplevel(), firstweekday=firstweekday, locale=locale, activebackground=activebackground, activeforeground=activeforeground, selectbackground=selectbackground, selectforeground=selectforeground, command=self._on_selected_date, on_click_month_button=lambda: self.focus())
self.bind_all("<1>", self._on_click, "+")
self.bind("<FocusOut>", lambda event: self._on_entry_focus_out())
self.bind("<Escape>", lambda event: self.hide_calendar())
self.calendar_frame.bind("<<DatePickerFocusOut>>", lambda event: self._on_calendar_focus_out())
# CTRL + PAGE UP: Move to the previous month.
self.bind("<Control-Prior>", lambda event: self.calendar_frame.prev_month())
# CTRL + PAGE DOWN: Move to the next month.
self.bind("<Control-Next>", lambda event: self.calendar_frame.next_month())
# CTRL + SHIFT + PAGE UP: Move to the previous year.
self.bind("<Control-Shift-Prior>", lambda event: self.calendar_frame.prev_year())
# CTRL + SHIFT + PAGE DOWN: Move to the next year.
self.bind("<Control-Shift-Next>", lambda event: self.calendar_frame.next_year())
# CTRL + LEFT: Move to the previous day.
self.bind("<Control-Left>", lambda event: self.calendar_frame.select_prev_day())
# CTRL + RIGHT: Move to the next day.
self.bind("<Control-Right>", lambda event: self.calendar_frame.select_next_day())
# CTRL + UP: Move to the previous week.
self.bind("<Control-Up>", lambda event: self.calendar_frame.select_prev_week_day())
# CTRL + DOWN: Move to the next week.
self.bind("<Control-Down>", lambda event: self.calendar_frame.select_next_week_day())
# CTRL + END: Close the datepicker and erase the date.
self.bind("<Control-End>", lambda event: self.erase())
# CTRL + HOME: Move to the current month.
self.bind("<Control-Home>", lambda event: self.calendar_frame.select_current_date())
# CTRL + SPACE: Show date on calendar
self.bind("<Control-space>", lambda event: self.show_date_on_calendar())
# CTRL + Return: Set to entry current selection
self.bind("<Control-Return>", lambda event: self.set_date_from_calendar())
def set_date_from_calendar(self):
if self.is_calendar_visible:
selected_date = self.calendar_frame.selection()
if selected_date is not None:
self.date_var.set(selected_date.strftime(self.date_format))
if self._on_select_date_command is not None:
self._on_select_date_command(selected_date)
self.hide_calendar()
@property
def current_text(self):
return self.date_var.get()
@current_text.setter
def current_text(self, text):
return self.date_var.set(text)
@property
def current_date(self):
try:
date = datetime.datetime.strptime(self.date_var.get(), self.date_format)
return date
except ValueError:
return None
@current_date.setter
def current_date(self, date):
self.date_var.set(date.strftime(self.date_format))
@property
def is_valid_date(self):
if self.current_date is None:
return False
else:
return True
def show_date_on_calendar(self):
date = self.current_date
if date is not None:
self.calendar_frame.set_selection(date)
self.show_calendar()
def show_calendar(self):
if not self._is_calendar_visible:
self.calendar_frame.place(in_=self, relx=0, rely=1)
self.calendar_frame.lift()
self._is_calendar_visible = True
def hide_calendar(self):
if self._is_calendar_visible:
self.calendar_frame.place_forget()
self._is_calendar_visible = False
def erase(self):
self.hide_calendar()
self.date_var.set("")
@property
def is_calendar_visible(self):
return self._is_calendar_visible
def _on_entry_focus_out(self):
if not str(self.focus_get()).startswith(str(self.calendar_frame)):
self.hide_calendar()
def _on_calendar_focus_out(self):
if self.focus_get() != self:
self.hide_calendar()
def _on_selected_date(self, date):
self.date_var.set(date.strftime(self.date_format))
self.hide_calendar()
if self._on_select_date_command is not None:
self._on_select_date_command(date)
def _on_click(self, event):
str_widget = str(event.widget)
if str_widget == str(self):
if not self._is_calendar_visible:
self.show_date_on_calendar()
else:
if not str_widget.startswith(str(self.calendar_frame)) and self._is_calendar_visible:
self.hide_calendar()
if __name__ == "__main__":
import sys
try:
from Tkinter import Tk, Frame, Label
except ImportError:
from tkinter import Tk, Frame, Label
root = Tk()
root.geometry("500x600")
main =Frame(root, pady =15, padx=15)
main.pack(expand=True, fill="both")
Label(main, justify="left", text=__doc__).pack(anchor="w", pady=(0,15))
Datepicker(main).pack(anchor="w")
if 'win' not in sys.platform:
style = ttk.Style()
style.theme_use('clam')
root.mainloop()
|