Mailman 3 July 2017 - Python-checkins

Updated LoggerAdapter.isEnabledFor to take advantage of caching. (GH-2951)
by Vinay Sajip July 30, 2017

July 30, 2017

https://github.com/python/cpython/commit/75f0b5dbac3376a3b36c943ec867c0daed… commit: 75f0b5dbac3376a3b36c943ec867c0daed35eb4f branch: master author: Vinay Sajip <vinay_sajip(a)yahoo.co.uk> committer: GitHub <noreply(a)github.com> date: 2017-07-30T20:15:18+01:00 summary: Updated LoggerAdapter.isEnabledFor to take advantage of caching. (GH-2951) files: M Lib/logging/__init__.py diff --git a/Lib/logging/__init__.py b/Lib/logging/__init__.py index 54d4e883d97..83db8273380 100644 --- … [View More]

1 0

[3.6] bpo-31004: IDLE: Factor out FontPage class from configdialog (step 1) (GH-2905) (#2950)
by Terry Jan Reedy July 30, 2017

July 30, 2017

https://github.com/python/cpython/commit/7582226a92481ca63dedbfe14ef465d134… commit: 7582226a92481ca63dedbfe14ef465d1349d66a9 branch: 3.6 author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: GitHub <noreply(a)github.com> date: 2017-07-30T15:00:50-04:00 summary: [3.6] bpo-31004: IDLE: Factor out FontPage class from configdialog (step 1) (GH-2905) (#2950) The slightly modified tests continue to pass. The General test broken by the switch to Notebook is fixed. Patch mostly by … [View More]Cheryl Sabella. (cherry picked from commit 9397e2a) files: A Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst M Lib/idlelib/configdialog.py M Lib/idlelib/idle_test/test_configdialog.py diff --git a/Lib/idlelib/configdialog.py b/Lib/idlelib/configdialog.py index 67165298a99..92bbc106344 100644 --- a/Lib/idlelib/configdialog.py +++ b/Lib/idlelib/configdialog.py @@ -69,7 +69,7 @@ def __init__(self, parent, title='', _htest=False, _utest=False): self.resizable(height=FALSE, width=FALSE) self.transient(parent) self.protocol("WM_DELETE_WINDOW", self.cancel) - self.fontlist.focus_set() + self.fontpage.fontlist.focus_set() # XXX Decide whether to keep or delete these key bindings. # Key bindings for this dialog. # self.bind('<Escape>', self.Cancel) #dismiss dialog, no save @@ -102,16 +102,16 @@ def create_widgets(self): activate_config_changes: Tell editors to reload. """ self.note = note = Notebook(self, width=450, height=450) - fontpage = self.create_page_font_tab() - highpage = self.create_page_highlight() - keyspage = self.create_page_keys() - genpage = self.create_page_general() - extpage = self.create_page_extensions() - note.add(fontpage, text='Fonts/Tabs') - note.add(highpage, text='Highlights') - note.add(keyspage, text=' Keys ') - note.add(genpage, text=' General ') - note.add(extpage, text='Extensions') + self.highpage = self.create_page_highlight() + self.fontpage = FontPage(note, self.highpage) + self.keyspage = self.create_page_keys() + self.genpage = self.create_page_general() + self.extpage = self.create_page_extensions() + note.add(self.fontpage, text='Fonts/Tabs') + note.add(self.highpage, text='Highlights') + note.add(self.keyspage, text=' Keys ') + note.add(self.genpage, text=' General ') + note.add(self.extpage, text='Extensions') note.enable_traversal() note.pack(side=TOP, expand=TRUE, fill=BOTH) self.create_action_buttons().pack(side=BOTTOM) @@ -129,8 +129,8 @@ def load_configs(self): load_key_cfg load_general_cfg """ - self.load_font_cfg() - self.load_tab_cfg() + #self.load_font_cfg() + #self.load_tab_cfg() self.load_theme_cfg() self.load_key_cfg() self.load_general_cfg() @@ -219,203 +219,6 @@ def help(self): text=help_common+help_pages.get(page, '')) - def create_page_font_tab(self): - """Return frame of widgets for Font/Tabs tab. - - Fonts: Enable users to provisionally change font face, size, or - boldness and to see the consequence of proposed choices. Each - action set 3 options in changes structuree and changes the - corresponding aspect of the font sample on this page and - highlight sample on highlight page. - - Funtion load_font_cfg initializes font vars and widgets from - idleConf entries and tk. - - Fontlist: mouse button 1 click or up or down key invoke - on_fontlist_select(), which sets var font_name. - - Sizelist: clicking the menubutton opens the dropdown menu. A - mouse button 1 click or return key sets var font_size. - - Bold_toggle: clicking the box toggles var font_bold. - - Changing any of the font vars invokes var_changed_font, which - adds all 3 font options to changes and calls set_samples. - Set_samples applies a new font constructed from the font vars to - font_sample and to highlight_sample on the hightlight page. - - Tabs: Enable users to change spaces entered for indent tabs. - Changing indent_scale value with the mouse sets Var space_num, - which invokes the default callback to add an entry to - changes. Load_tab_cfg initializes space_num to default. - - Widget Structure: (*) widgets bound to self - frame (of tab_pages) - frame_font: LabelFrame - frame_font_name: Frame - font_name_title: Label - (*)fontlist: ListBox - font_name - scroll_font: Scrollbar - frame_font_param: Frame - font_size_title: Label - (*)sizelist: DynOptionMenu - font_size - (*)bold_toggle: Checkbutton - font_bold - frame_font_sample: Frame - (*)font_sample: Label - frame_indent: LabelFrame - indent_title: Label - (*)indent_scale: Scale - space_num - """ - parent = self.parent - self.font_name = tracers.add(StringVar(parent), self.var_changed_font) - self.font_size = tracers.add(StringVar(parent), self.var_changed_font) - self.font_bold = tracers.add(BooleanVar(parent), self.var_changed_font) - self.space_num = tracers.add(IntVar(parent), ('main', 'Indent', 'num-spaces')) - - # Create widgets: - # body and body section frames. - frame = Frame(self.note) - frame_font = LabelFrame( - frame, borderwidth=2, relief=GROOVE, text=' Base Editor Font ') - frame_indent = LabelFrame( - frame, borderwidth=2, relief=GROOVE, text=' Indentation Width ') - # frame_font. - frame_font_name = Frame(frame_font) - frame_font_param = Frame(frame_font) - font_name_title = Label( - frame_font_name, justify=LEFT, text='Font Face :') - self.fontlist = Listbox(frame_font_name, height=5, - takefocus=True, exportselection=FALSE) - self.fontlist.bind('<ButtonRelease-1>', self.on_fontlist_select) - self.fontlist.bind('<KeyRelease-Up>', self.on_fontlist_select) - self.fontlist.bind('<KeyRelease-Down>', self.on_fontlist_select) - scroll_font = Scrollbar(frame_font_name) - scroll_font.config(command=self.fontlist.yview) - self.fontlist.config(yscrollcommand=scroll_font.set) - font_size_title = Label(frame_font_param, text='Size :') - self.sizelist = DynOptionMenu(frame_font_param, self.font_size, None) - self.bold_toggle = Checkbutton( - frame_font_param, variable=self.font_bold, - onvalue=1, offvalue=0, text='Bold') - frame_font_sample = Frame(frame_font, relief=SOLID, borderwidth=1) - temp_font = tkFont.Font(parent, ('courier', 10, 'normal')) - self.font_sample = Label( - frame_font_sample, justify=LEFT, font=temp_font, - text='AaBbCcDdEe\nFfGgHhIiJj\n1234567890\n#:+=(){}[]') - # frame_indent. - indent_title = Label( - frame_indent, justify=LEFT, - text='Python Standard: 4 Spaces!') - self.indent_scale = Scale( - frame_indent, variable=self.space_num, - orient='horizontal', tickinterval=2, from_=2, to=16) - - # Pack widgets: - # body. - frame_font.pack(side=LEFT, padx=5, pady=5, expand=TRUE, fill=BOTH) - frame_indent.pack(side=LEFT, padx=5, pady=5, fill=Y) - # frame_font. - frame_font_name.pack(side=TOP, padx=5, pady=5, fill=X) - frame_font_param.pack(side=TOP, padx=5, pady=5, fill=X) - font_name_title.pack(side=TOP, anchor=W) - self.fontlist.pack(side=LEFT, expand=TRUE, fill=X) - scroll_font.pack(side=LEFT, fill=Y) - font_size_title.pack(side=LEFT, anchor=W) - self.sizelist.pack(side=LEFT, anchor=W) - self.bold_toggle.pack(side=LEFT, anchor=W, padx=20) - frame_font_sample.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH) - self.font_sample.pack(expand=TRUE, fill=BOTH) - # frame_indent. - frame_indent.pack(side=TOP, fill=X) - indent_title.pack(side=TOP, anchor=W, padx=5) - self.indent_scale.pack(side=TOP, padx=5, fill=X) - - return frame - - def load_font_cfg(self): - """Load current configuration settings for the font options. - - Retrieve current font with idleConf.GetFont and font families - from tk. Setup fontlist and set font_name. Setup sizelist, - which sets font_size. Set font_bold. Setting font variables - calls set_samples (thrice). - """ - configured_font = idleConf.GetFont(self, 'main', 'EditorWindow') - font_name = configured_font[0].lower() - font_size = configured_font[1] - font_bold = configured_font[2]=='bold' - - # Set editor font selection list and font_name. - fonts = list(tkFont.families(self)) - fonts.sort() - for font in fonts: - self.fontlist.insert(END, font) - self.font_name.set(font_name) - lc_fonts = [s.lower() for s in fonts] - try: - current_font_index = lc_fonts.index(font_name) - self.fontlist.see(current_font_index) - self.fontlist.select_set(current_font_index) - self.fontlist.select_anchor(current_font_index) - self.fontlist.activate(current_font_index) - except ValueError: - pass - # Set font size dropdown. - self.sizelist.SetMenu(('7', '8', '9', '10', '11', '12', '13', '14', - '16', '18', '20', '22', '25', '29', '34', '40'), - font_size) - # Set font weight. - self.font_bold.set(font_bold) - - def var_changed_font(self, *params): - """Store changes to font attributes. - - When one font attribute changes, save them all, as they are - not independent from each other. In particular, when we are - overriding the default font, we need to write out everything. - """ - value = self.font_name.get() - changes.add_option('main', 'EditorWindow', 'font', value) - value = self.font_size.get() - changes.add_option('main', 'EditorWindow', 'font-size', value) - value = self.font_bold.get() - changes.add_option('main', 'EditorWindow', 'font-bold', value) - self.set_samples() - - def on_fontlist_select(self, event): - """Handle selecting a font from the list. - - Event can result from either mouse click or Up or Down key. - Set font_name and example displays to selection. - """ - font = self.fontlist.get( - ACTIVE if event.type.name == 'KeyRelease' else ANCHOR) - self.font_name.set(font.lower()) - - def set_samples(self, event=None): - """Update update both screen samples with the font settings. - - Called on font initialization and change events. - Accesses font_name, font_size, and font_bold Variables. - Updates font_sample and hightlight page highlight_sample. - """ - font_name = self.font_name.get() - font_weight = tkFont.BOLD if self.font_bold.get() else tkFont.NORMAL - new_font = (font_name, self.font_size.get(), font_weight) - self.font_sample['font'] = new_font - self.highlight_sample['font'] = new_font - - def load_tab_cfg(self): - """Load current configuration settings for the tab options. - - Attributes updated: - space_num: Set to value from idleConf. - """ - # Set indent sizes. - space_num = idleConf.GetOption( - 'main', 'Indent', 'num-spaces', default=4, type='int') - self.space_num.set(space_num) - def create_page_highlight(self): """Return frame of widgets for Highlighting tab. @@ -505,7 +308,7 @@ def create_page_highlight(self): frame_theme = LabelFrame(frame, borderwidth=2, relief=GROOVE, text=' Highlighting Theme ') #frame_custom - self.highlight_sample=Text( + text = self.highlight_sample = frame.highlight_sample = Text( frame_custom, relief=SOLID, borderwidth=1, font=('courier', 12, ''), cursor='hand2', width=21, height=13, takefocus=FALSE, highlightthickness=0, wrap=NONE) @@ -1829,6 +1632,219 @@ def save_all_changed_extensions(self): self.ext_userCfg.Save() +class FontPage(Frame): + + def __init__(self, parent, highpage): + super().__init__(parent) + self.parent = parent + self.highlight_sample = highpage.highlight_sample + self.create_page_font_tab() + self.load_font_cfg() + self.load_tab_cfg() + + def create_page_font_tab(self): + """Return frame of widgets for Font/Tabs tab. + + Fonts: Enable users to provisionally change font face, size, or + boldness and to see the consequence of proposed choices. Each + action set 3 options in changes structuree and changes the + corresponding aspect of the font sample on this page and + highlight sample on highlight page. + + Function load_font_cfg initializes font vars and widgets from + idleConf entries and tk. + + Fontlist: mouse button 1 click or up or down key invoke + on_fontlist_select(), which sets var font_name. + + Sizelist: clicking the menubutton opens the dropdown menu. A + mouse button 1 click or return key sets var font_size. + + Bold_toggle: clicking the box toggles var font_bold. + + Changing any of the font vars invokes var_changed_font, which + adds all 3 font options to changes and calls set_samples. + Set_samples applies a new font constructed from the font vars to + font_sample and to highlight_sample on the hightlight page. + + Tabs: Enable users to change spaces entered for indent tabs. + Changing indent_scale value with the mouse sets Var space_num, + which invokes the default callback to add an entry to + changes. Load_tab_cfg initializes space_num to default. + + Widget Structure: (*) widgets bound to self + frame (of tab_pages) + frame_font: LabelFrame + frame_font_name: Frame + font_name_title: Label + (*)fontlist: ListBox - font_name + scroll_font: Scrollbar + frame_font_param: Frame + font_size_title: Label + (*)sizelist: DynOptionMenu - font_size + (*)bold_toggle: Checkbutton - font_bold + frame_font_sample: Frame + (*)font_sample: Label + frame_indent: LabelFrame + indent_title: Label + (*)indent_scale: Scale - space_num + """ + parent = self.parent + self.font_name = tracers.add(StringVar(parent), self.var_changed_font) + self.font_size = tracers.add(StringVar(parent), self.var_changed_font) + self.font_bold = tracers.add(BooleanVar(parent), self.var_changed_font) + self.space_num = tracers.add(IntVar(self), ('main', 'Indent', 'num-spaces')) + + # Create widgets: + # body and body section frames. + frame = self + frame_font = LabelFrame( + frame, borderwidth=2, relief=GROOVE, text=' Base Editor Font ') + frame_indent = LabelFrame( + frame, borderwidth=2, relief=GROOVE, text=' Indentation Width ') + # frame_font. + frame_font_name = Frame(frame_font) + frame_font_param = Frame(frame_font) + font_name_title = Label( + frame_font_name, justify=LEFT, text='Font Face :') + self.fontlist = Listbox(frame_font_name, height=5, + takefocus=True, exportselection=FALSE) + self.fontlist.bind('<ButtonRelease-1>', self.on_fontlist_select) + self.fontlist.bind('<KeyRelease-Up>', self.on_fontlist_select) + self.fontlist.bind('<KeyRelease-Down>', self.on_fontlist_select) + scroll_font = Scrollbar(frame_font_name) + scroll_font.config(command=self.fontlist.yview) + self.fontlist.config(yscrollcommand=scroll_font.set) + font_size_title = Label(frame_font_param, text='Size :') + self.sizelist = DynOptionMenu(frame_font_param, self.font_size, None) + self.bold_toggle = Checkbutton( + frame_font_param, variable=self.font_bold, + onvalue=1, offvalue=0, text='Bold') + frame_font_sample = Frame(frame_font, relief=SOLID, borderwidth=1) + temp_font = tkFont.Font(parent, ('courier', 10, 'normal')) + self.font_sample = Label( + frame_font_sample, justify=LEFT, font=temp_font, + text='AaBbCcDdEe\nFfGgHhIiJj\n1234567890\n#:+=(){}[]') + # frame_indent. + indent_title = Label( + frame_indent, justify=LEFT, + text='Python Standard: 4 Spaces!') + self.indent_scale = Scale( + frame_indent, variable=self.space_num, + orient='horizontal', tickinterval=2, from_=2, to=16) + + # Pack widgets: + # body. + frame_font.pack(side=LEFT, padx=5, pady=5, expand=TRUE, fill=BOTH) + frame_indent.pack(side=LEFT, padx=5, pady=5, fill=Y) + # frame_font. + frame_font_name.pack(side=TOP, padx=5, pady=5, fill=X) + frame_font_param.pack(side=TOP, padx=5, pady=5, fill=X) + font_name_title.pack(side=TOP, anchor=W) + self.fontlist.pack(side=LEFT, expand=TRUE, fill=X) + scroll_font.pack(side=LEFT, fill=Y) + font_size_title.pack(side=LEFT, anchor=W) + self.sizelist.pack(side=LEFT, anchor=W) + self.bold_toggle.pack(side=LEFT, anchor=W, padx=20) + frame_font_sample.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH) + self.font_sample.pack(expand=TRUE, fill=BOTH) + # frame_indent. + frame_indent.pack(side=TOP, fill=X) + indent_title.pack(side=TOP, anchor=W, padx=5) + self.indent_scale.pack(side=TOP, padx=5, fill=X) + + return frame + + def load_font_cfg(self): + """Load current configuration settings for the font options. + + Retrieve current font with idleConf.GetFont and font families + from tk. Setup fontlist and set font_name. Setup sizelist, + which sets font_size. Set font_bold. Call set_samples. + """ + configured_font = idleConf.GetFont(self, 'main', 'EditorWindow') + font_name = configured_font[0].lower() + font_size = configured_font[1] + font_bold = configured_font[2]=='bold' + + # Set editor font selection list and font_name. + fonts = list(tkFont.families(self)) + fonts.sort() + for font in fonts: + self.fontlist.insert(END, font) + self.font_name.set(font_name) + lc_fonts = [s.lower() for s in fonts] + try: + current_font_index = lc_fonts.index(font_name) + self.fontlist.see(current_font_index) + self.fontlist.select_set(current_font_index) + self.fontlist.select_anchor(current_font_index) + self.fontlist.activate(current_font_index) + except ValueError: + pass + # Set font size dropdown. + self.sizelist.SetMenu(('7', '8', '9', '10', '11', '12', '13', '14', + '16', '18', '20', '22', '25', '29', '34', '40'), + font_size) + # Set font weight. + self.font_bold.set(font_bold) + self.set_samples() + + def var_changed_font(self, *params): + """Store changes to font attributes. + + When one font attribute changes, save them all, as they are + not independent from each other. In particular, when we are + overriding the default font, we need to write out everything. + """ + value = self.font_name.get() + changes.add_option('main', 'EditorWindow', 'font', value) + value = self.font_size.get() + changes.add_option('main', 'EditorWindow', 'font-size', value) + value = self.font_bold.get() + changes.add_option('main', 'EditorWindow', 'font-bold', value) + self.set_samples() + + def on_fontlist_select(self, event): + """Handle selecting a font from the list. + + Event can result from either mouse click or Up or Down key. + Set font_name and example displays to selection. + """ + font = self.fontlist.get( + ACTIVE if event.type.name == 'KeyRelease' else ANCHOR) + self.font_name.set(font.lower()) + + def set_samples(self, event=None): + """Update update both screen samples with the font settings. + + Called on font initialization and change events. + Accesses font_name, font_size, and font_bold Variables. + Updates font_sample and hightlight page highlight_sample. + """ + font_name = self.font_name.get() + font_weight = tkFont.BOLD if self.font_bold.get() else tkFont.NORMAL + new_font = (font_name, self.font_size.get(), font_weight) + self.font_sample['font'] = new_font + self.highlight_sample['font'] = new_font + + def load_tab_cfg(self): + """Load current configuration settings for the tab options. + + Attributes updated: + space_num: Set to value from idleConf. + """ + # Set indent sizes. + space_num = idleConf.GetOption( + 'main', 'Indent', 'num-spaces', default=4, type='int') + self.space_num.set(space_num) + + def var_changed_space_num(self, *params): + "Store change to indentation size." + value = self.space_num.get() + changes.add_option('main', 'Indent', 'num-spaces', value) + + class VarTrace: """Maintain Tk variables trace state.""" diff --git a/Lib/idlelib/idle_test/test_configdialog.py b/Lib/idlelib/idle_test/test_configdialog.py index aff3c2fdc3b..8da726b80c0 100644 --- a/Lib/idlelib/idle_test/test_configdialog.py +++ b/Lib/idlelib/idle_test/test_configdialog.py @@ -9,7 +9,7 @@ import unittest from unittest import mock from idlelib.idle_test.mock_idle import Func -from tkinter import Tk, IntVar, BooleanVar, DISABLED, NORMAL +from tkinter import Tk, Frame, IntVar, BooleanVar, DISABLED, NORMAL from idlelib import config from idlelib.configdialog import idleConf, changes, tracers @@ -47,7 +47,7 @@ def tearDownModule(): del root -class FontTest(unittest.TestCase): +class FontPageTest(unittest.TestCase): """Test that font widgets enable users to make font changes. Test that widget actions set vars, that var changes add three @@ -56,11 +56,15 @@ class FontTest(unittest.TestCase): """ @classmethod def setUpClass(cls): - dialog.set_samples = Func() # Mask instance method. + page = cls.page = dialog.fontpage + #dialog.note.insert(0, page, text='copy') + #dialog.note.add(page, text='copyfgfg') + dialog.note.select(page) + page.set_samples = Func() # Mask instance method. @classmethod def tearDownClass(cls): - del dialog.set_samples # Unmask instance method. + del cls.page.set_samples # Unmask instance method. def setUp(self): changes.clear() @@ -68,7 +72,8 @@ def setUp(self): def test_load_font_cfg(self): # Leave widget load test to human visual check. # TODO Improve checks when add IdleConf.get_font_values. - d = dialog + tracers.detach() + d = self.page d.font_name.set('Fake') d.font_size.set('1') d.font_bold.set(True) @@ -77,16 +82,17 @@ def test_load_font_cfg(self): self.assertNotEqual(d.font_name.get(), 'Fake') self.assertNotEqual(d.font_size.get(), '1') self.assertFalse(d.font_bold.get()) - self.assertEqual(d.set_samples.called, 3) + self.assertEqual(d.set_samples.called, 1) + tracers.attach() def test_fontlist_key(self): # Up and Down keys should select a new font. - - if dialog.fontlist.size() < 2: - cls.skipTest('need at least 2 fonts') - fontlist = dialog.fontlist + d = self.page + if d.fontlist.size() < 2: + self.skipTest('need at least 2 fonts') + fontlist = d.fontlist fontlist.activate(0) - font = dialog.fontlist.get('active') + font = d.fontlist.get('active') # Test Down key. fontlist.focus_force() @@ -96,7 +102,7 @@ def test_fontlist_key(self): down_font = fontlist.get('active') self.assertNotEqual(down_font, font) - self.assertIn(dialog.font_name.get(), down_font.lower()) + self.assertIn(d.font_name.get(), down_font.lower()) # Test Up key. fontlist.focus_force() @@ -106,14 +112,14 @@ def test_fontlist_key(self): up_font = fontlist.get('active') self.assertEqual(up_font, font) - self.assertIn(dialog.font_name.get(), up_font.lower()) + self.assertIn(d.font_name.get(), up_font.lower()) def test_fontlist_mouse(self): # Click on item should select that item. - - if dialog.fontlist.size() < 2: + d = self.page + if d.fontlist.size() < 2: cls.skipTest('need at least 2 fonts') - fontlist = dialog.fontlist + fontlist = d.fontlist fontlist.activate(0) # Select next item in listbox @@ -129,17 +135,17 @@ def test_fontlist_mouse(self): font1 = fontlist.get(1) select_font = fontlist.get('anchor') self.assertEqual(select_font, font1) - self.assertIn(dialog.font_name.get(), font1.lower()) + self.assertIn(d.font_name.get(), font1.lower()) def test_sizelist(self): # Click on number shouod select that number - d = dialog + d = self.page d.sizelist.variable.set(40) self.assertEqual(d.font_size.get(), '40') def test_bold_toggle(self): # Click on checkbutton should invert it. - d = dialog + d = self.page d.font_bold.set(False) d.bold_toggle.invoke() self.assertTrue(d.font_bold.get()) @@ -154,7 +160,7 @@ def test_font_set(self): default_font = idleConf.GetFont(root, 'main', 'EditorWindow') default_size = str(default_font[1]) default_bold = default_font[2] == 'bold' - d = dialog + d = self.page d.font_size.set(default_size) d.font_bold.set(default_bold) d.set_samples.called = 0 @@ -183,7 +189,7 @@ def test_font_set(self): self.assertEqual(d.set_samples.called, 3) def test_set_samples(self): - d = dialog + d = self.page del d.set_samples # Unmask method for test d.font_sample, d.highlight_sample = {}, {} d.font_name.set('test') @@ -201,16 +207,21 @@ def test_set_samples(self): class IndentTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.page = dialog.fontpage + def test_load_tab_cfg(self): - d = dialog + d = self.page d.space_num.set(16) d.load_tab_cfg() self.assertEqual(d.space_num.get(), 4) def test_indent_scale(self): + d = self.page changes.clear() - dialog.indent_scale.set(26) - self.assertEqual(dialog.space_num.get(), 16) + d.indent_scale.set(20) + self.assertEqual(d.space_num.get(), 16) self.assertEqual(mainpage, {'Indent': {'num-spaces': '16'}}) @@ -234,8 +245,10 @@ class GeneralTest(unittest.TestCase): """ @classmethod def setUpClass(cls): - # Mask instance methods used by help functions. d = dialog + # Select General tab so can force focus on helplist. + d.note.select(d.genpage) + # Mask instance methods used by help functions. d.set = d.set_add_delete_state = Func() d.upc = d.update_help_changes = Func() @@ -311,9 +324,8 @@ def test_source_selected(self): helplist.event_generate('<Motion>', x=x, y=y) helplist.event_generate('<Button-1>', x=x, y=y) helplist.event_generate('<ButtonRelease-1>', x=x, y=y) - # The following fail after the switch to - # self.assertEqual(helplist.get('anchor'), 'source') - # self.assertTrue(d.set.called) + self.assertEqual(helplist.get('anchor'), 'source') + self.assertTrue(d.set.called) self.assertFalse(d.upc.called) def test_set_add_delete_state(self): diff --git a/Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst b/Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst new file mode 100644 index 00000000000..47fed949d10 --- /dev/null +++ b/Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst @@ -0,0 +1,4 @@ +IDLE - Factor FontPage(Frame) class from ConfigDialog. + +Slightly modified tests continue to pass. Fix General tests. Patch mostly by +Cheryl Sabella. [View Less]

1 0

[3.6] bpo-30928: Update IDLE News.txt. (GH-2948) (#2949)
by Terry Jan Reedy July 30, 2017

July 30, 2017

https://github.com/python/cpython/commit/c9c85321df7803137a413d26db41aaa377… commit: c9c85321df7803137a413d26db41aaa377b13d79 branch: 3.6 author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: GitHub <noreply(a)github.com> date: 2017-07-30T13:35:46-04:00 summary: [3.6] bpo-30928: Update IDLE News.txt. (GH-2948) (#2949) (cherry picked from commit c3aa47f655abe564a2c2fb6d091ab19bdc0113b5) files: M Lib/idlelib/NEWS.txt diff --git a/Lib/idlelib/NEWS.txt b/Lib/idlelib/NEWS.txt index … [View More]3c5cba6af47..35a0115c73b 100644 --- a/Lib/idlelib/NEWS.txt +++ b/Lib/idlelib/NEWS.txt @@ -3,6 +3,44 @@ Released on 2017-09-25? ======================== +bpo-30781: IDLE - Use ttk Notebook in ConfigDialog. +Patch by Terry Jan Reedy. + +bpo-31060: IDLE - Finish rearranging methods of ConfigDialog. +Grouping methods pertaining to each tab and the buttons will aid +writing tests and improving the tabs and will enable splitting the +groups into classes. +Patch by Terry Jan Reedy. + +bpo-30853: IDLE -- Factor a VarTrace class out of ConfigDialog. +Instance tracers manages pairs consisting of a tk variable and a +callback function. When tracing is turned on, setting the variable +calls the function. Test coverage for the new class is 100%. +Patch by Terry Jan Reedy. + +bpo-31003: IDLE: Add more tests for General tab. +Patch by Terry Jan Reedy. + +bpo-30993: IDLE - Improve configdialog font page and tests. +*In configdialog: Document causal pathways in create_font_tab +docstring. Simplify some attribute names. Move set_samples calls to +var_changed_font (idea from Cheryl Sabella). Move related functions to +positions after the create widgets function. +* In test_configdialog: Fix test_font_set so not order dependent. Fix +renamed test_indent_scale so it tests the widget. Adjust tests for +movement of set_samples call. Add tests for load functions. Put all +font tests in one class and tab indent tests in another. Except for +two lines, these tests completely cover the related functions. +Patch by Terry Jan Reedy. + +bpo-30981: IDLE -- Add more configdialog font page tests. + +bpo-28523: IDLE: replace 'colour' with 'color' in configdialog. + +bpo-30917: Add tests for idlelib.config.IdleConf. +Increase coverage from 46% to 96%. +Patch by Louie Lu. + bpo-30913: Document ConfigDialog tk Vars, methods, and widgets in docstrings This will facilitate improving the dialog and splitting up the class. Original patch by Cheryl Sabella. @@ -11,7 +49,7 @@ bpo-30899: Add tests for ConfigParser subclasses in config. Coverage is 100% for those classes and ConfigChanges. Patch by Louie Lu. -bpo-30881: Add docstrings to browser.py. +bpo-30881: Add docstrings to browser.py. Patch by Cheryl Sabella. bpo-30851: Remove unused tk variables in configdialog. @@ -48,7 +86,7 @@ bp0-30723: Make several improvements to parenmatch. * Make 'default' style, which is not default, a synonym for 'opener'. * Make time-delay work the same with all styles. * Add help for config dialog extensions tab, including parenmatch. -* Add new tests. +* Add new tests. Original patch by Charles Wohlganger. Revisions by Terry Jan Reedy bpo-30674: Grep -- Add docstrings. Patch by Cheryl Sabella. [View Less]

1 0

bpo-31004: IDLE: Factor out FontPage class from configdialog (step 1) (#2905)
by Terry Jan Reedy July 30, 2017

July 30, 2017

https://github.com/python/cpython/commit/9397e2a87ed6e0e724ad71a0c751553620… commit: 9397e2a87ed6e0e724ad71a0c751553620cb775e branch: master author: csabella <cheryl.sabella(a)gmail.com> committer: Terry Jan Reedy <tjreedy(a)udel.edu> date: 2017-07-30T13:34:25-04:00 summary: bpo-31004: IDLE: Factor out FontPage class from configdialog (step 1) (#2905) The slightly modified tests continue to pass. The General test broken by the switch to Notebook is fixed. Patch mostly by Cheryl … [View More]Sabella. files: A Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst M Lib/idlelib/configdialog.py M Lib/idlelib/idle_test/test_configdialog.py diff --git a/Lib/idlelib/configdialog.py b/Lib/idlelib/configdialog.py index 67165298a99..92bbc106344 100644 --- a/Lib/idlelib/configdialog.py +++ b/Lib/idlelib/configdialog.py @@ -69,7 +69,7 @@ def __init__(self, parent, title='', _htest=False, _utest=False): self.resizable(height=FALSE, width=FALSE) self.transient(parent) self.protocol("WM_DELETE_WINDOW", self.cancel) - self.fontlist.focus_set() + self.fontpage.fontlist.focus_set() # XXX Decide whether to keep or delete these key bindings. # Key bindings for this dialog. # self.bind('<Escape>', self.Cancel) #dismiss dialog, no save @@ -102,16 +102,16 @@ def create_widgets(self): activate_config_changes: Tell editors to reload. """ self.note = note = Notebook(self, width=450, height=450) - fontpage = self.create_page_font_tab() - highpage = self.create_page_highlight() - keyspage = self.create_page_keys() - genpage = self.create_page_general() - extpage = self.create_page_extensions() - note.add(fontpage, text='Fonts/Tabs') - note.add(highpage, text='Highlights') - note.add(keyspage, text=' Keys ') - note.add(genpage, text=' General ') - note.add(extpage, text='Extensions') + self.highpage = self.create_page_highlight() + self.fontpage = FontPage(note, self.highpage) + self.keyspage = self.create_page_keys() + self.genpage = self.create_page_general() + self.extpage = self.create_page_extensions() + note.add(self.fontpage, text='Fonts/Tabs') + note.add(self.highpage, text='Highlights') + note.add(self.keyspage, text=' Keys ') + note.add(self.genpage, text=' General ') + note.add(self.extpage, text='Extensions') note.enable_traversal() note.pack(side=TOP, expand=TRUE, fill=BOTH) self.create_action_buttons().pack(side=BOTTOM) @@ -129,8 +129,8 @@ def load_configs(self): load_key_cfg load_general_cfg """ - self.load_font_cfg() - self.load_tab_cfg() + #self.load_font_cfg() + #self.load_tab_cfg() self.load_theme_cfg() self.load_key_cfg() self.load_general_cfg() @@ -219,203 +219,6 @@ def help(self): text=help_common+help_pages.get(page, '')) - def create_page_font_tab(self): - """Return frame of widgets for Font/Tabs tab. - - Fonts: Enable users to provisionally change font face, size, or - boldness and to see the consequence of proposed choices. Each - action set 3 options in changes structuree and changes the - corresponding aspect of the font sample on this page and - highlight sample on highlight page. - - Funtion load_font_cfg initializes font vars and widgets from - idleConf entries and tk. - - Fontlist: mouse button 1 click or up or down key invoke - on_fontlist_select(), which sets var font_name. - - Sizelist: clicking the menubutton opens the dropdown menu. A - mouse button 1 click or return key sets var font_size. - - Bold_toggle: clicking the box toggles var font_bold. - - Changing any of the font vars invokes var_changed_font, which - adds all 3 font options to changes and calls set_samples. - Set_samples applies a new font constructed from the font vars to - font_sample and to highlight_sample on the hightlight page. - - Tabs: Enable users to change spaces entered for indent tabs. - Changing indent_scale value with the mouse sets Var space_num, - which invokes the default callback to add an entry to - changes. Load_tab_cfg initializes space_num to default. - - Widget Structure: (*) widgets bound to self - frame (of tab_pages) - frame_font: LabelFrame - frame_font_name: Frame - font_name_title: Label - (*)fontlist: ListBox - font_name - scroll_font: Scrollbar - frame_font_param: Frame - font_size_title: Label - (*)sizelist: DynOptionMenu - font_size - (*)bold_toggle: Checkbutton - font_bold - frame_font_sample: Frame - (*)font_sample: Label - frame_indent: LabelFrame - indent_title: Label - (*)indent_scale: Scale - space_num - """ - parent = self.parent - self.font_name = tracers.add(StringVar(parent), self.var_changed_font) - self.font_size = tracers.add(StringVar(parent), self.var_changed_font) - self.font_bold = tracers.add(BooleanVar(parent), self.var_changed_font) - self.space_num = tracers.add(IntVar(parent), ('main', 'Indent', 'num-spaces')) - - # Create widgets: - # body and body section frames. - frame = Frame(self.note) - frame_font = LabelFrame( - frame, borderwidth=2, relief=GROOVE, text=' Base Editor Font ') - frame_indent = LabelFrame( - frame, borderwidth=2, relief=GROOVE, text=' Indentation Width ') - # frame_font. - frame_font_name = Frame(frame_font) - frame_font_param = Frame(frame_font) - font_name_title = Label( - frame_font_name, justify=LEFT, text='Font Face :') - self.fontlist = Listbox(frame_font_name, height=5, - takefocus=True, exportselection=FALSE) - self.fontlist.bind('<ButtonRelease-1>', self.on_fontlist_select) - self.fontlist.bind('<KeyRelease-Up>', self.on_fontlist_select) - self.fontlist.bind('<KeyRelease-Down>', self.on_fontlist_select) - scroll_font = Scrollbar(frame_font_name) - scroll_font.config(command=self.fontlist.yview) - self.fontlist.config(yscrollcommand=scroll_font.set) - font_size_title = Label(frame_font_param, text='Size :') - self.sizelist = DynOptionMenu(frame_font_param, self.font_size, None) - self.bold_toggle = Checkbutton( - frame_font_param, variable=self.font_bold, - onvalue=1, offvalue=0, text='Bold') - frame_font_sample = Frame(frame_font, relief=SOLID, borderwidth=1) - temp_font = tkFont.Font(parent, ('courier', 10, 'normal')) - self.font_sample = Label( - frame_font_sample, justify=LEFT, font=temp_font, - text='AaBbCcDdEe\nFfGgHhIiJj\n1234567890\n#:+=(){}[]') - # frame_indent. - indent_title = Label( - frame_indent, justify=LEFT, - text='Python Standard: 4 Spaces!') - self.indent_scale = Scale( - frame_indent, variable=self.space_num, - orient='horizontal', tickinterval=2, from_=2, to=16) - - # Pack widgets: - # body. - frame_font.pack(side=LEFT, padx=5, pady=5, expand=TRUE, fill=BOTH) - frame_indent.pack(side=LEFT, padx=5, pady=5, fill=Y) - # frame_font. - frame_font_name.pack(side=TOP, padx=5, pady=5, fill=X) - frame_font_param.pack(side=TOP, padx=5, pady=5, fill=X) - font_name_title.pack(side=TOP, anchor=W) - self.fontlist.pack(side=LEFT, expand=TRUE, fill=X) - scroll_font.pack(side=LEFT, fill=Y) - font_size_title.pack(side=LEFT, anchor=W) - self.sizelist.pack(side=LEFT, anchor=W) - self.bold_toggle.pack(side=LEFT, anchor=W, padx=20) - frame_font_sample.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH) - self.font_sample.pack(expand=TRUE, fill=BOTH) - # frame_indent. - frame_indent.pack(side=TOP, fill=X) - indent_title.pack(side=TOP, anchor=W, padx=5) - self.indent_scale.pack(side=TOP, padx=5, fill=X) - - return frame - - def load_font_cfg(self): - """Load current configuration settings for the font options. - - Retrieve current font with idleConf.GetFont and font families - from tk. Setup fontlist and set font_name. Setup sizelist, - which sets font_size. Set font_bold. Setting font variables - calls set_samples (thrice). - """ - configured_font = idleConf.GetFont(self, 'main', 'EditorWindow') - font_name = configured_font[0].lower() - font_size = configured_font[1] - font_bold = configured_font[2]=='bold' - - # Set editor font selection list and font_name. - fonts = list(tkFont.families(self)) - fonts.sort() - for font in fonts: - self.fontlist.insert(END, font) - self.font_name.set(font_name) - lc_fonts = [s.lower() for s in fonts] - try: - current_font_index = lc_fonts.index(font_name) - self.fontlist.see(current_font_index) - self.fontlist.select_set(current_font_index) - self.fontlist.select_anchor(current_font_index) - self.fontlist.activate(current_font_index) - except ValueError: - pass - # Set font size dropdown. - self.sizelist.SetMenu(('7', '8', '9', '10', '11', '12', '13', '14', - '16', '18', '20', '22', '25', '29', '34', '40'), - font_size) - # Set font weight. - self.font_bold.set(font_bold) - - def var_changed_font(self, *params): - """Store changes to font attributes. - - When one font attribute changes, save them all, as they are - not independent from each other. In particular, when we are - overriding the default font, we need to write out everything. - """ - value = self.font_name.get() - changes.add_option('main', 'EditorWindow', 'font', value) - value = self.font_size.get() - changes.add_option('main', 'EditorWindow', 'font-size', value) - value = self.font_bold.get() - changes.add_option('main', 'EditorWindow', 'font-bold', value) - self.set_samples() - - def on_fontlist_select(self, event): - """Handle selecting a font from the list. - - Event can result from either mouse click or Up or Down key. - Set font_name and example displays to selection. - """ - font = self.fontlist.get( - ACTIVE if event.type.name == 'KeyRelease' else ANCHOR) - self.font_name.set(font.lower()) - - def set_samples(self, event=None): - """Update update both screen samples with the font settings. - - Called on font initialization and change events. - Accesses font_name, font_size, and font_bold Variables. - Updates font_sample and hightlight page highlight_sample. - """ - font_name = self.font_name.get() - font_weight = tkFont.BOLD if self.font_bold.get() else tkFont.NORMAL - new_font = (font_name, self.font_size.get(), font_weight) - self.font_sample['font'] = new_font - self.highlight_sample['font'] = new_font - - def load_tab_cfg(self): - """Load current configuration settings for the tab options. - - Attributes updated: - space_num: Set to value from idleConf. - """ - # Set indent sizes. - space_num = idleConf.GetOption( - 'main', 'Indent', 'num-spaces', default=4, type='int') - self.space_num.set(space_num) - def create_page_highlight(self): """Return frame of widgets for Highlighting tab. @@ -505,7 +308,7 @@ def create_page_highlight(self): frame_theme = LabelFrame(frame, borderwidth=2, relief=GROOVE, text=' Highlighting Theme ') #frame_custom - self.highlight_sample=Text( + text = self.highlight_sample = frame.highlight_sample = Text( frame_custom, relief=SOLID, borderwidth=1, font=('courier', 12, ''), cursor='hand2', width=21, height=13, takefocus=FALSE, highlightthickness=0, wrap=NONE) @@ -1829,6 +1632,219 @@ def save_all_changed_extensions(self): self.ext_userCfg.Save() +class FontPage(Frame): + + def __init__(self, parent, highpage): + super().__init__(parent) + self.parent = parent + self.highlight_sample = highpage.highlight_sample + self.create_page_font_tab() + self.load_font_cfg() + self.load_tab_cfg() + + def create_page_font_tab(self): + """Return frame of widgets for Font/Tabs tab. + + Fonts: Enable users to provisionally change font face, size, or + boldness and to see the consequence of proposed choices. Each + action set 3 options in changes structuree and changes the + corresponding aspect of the font sample on this page and + highlight sample on highlight page. + + Function load_font_cfg initializes font vars and widgets from + idleConf entries and tk. + + Fontlist: mouse button 1 click or up or down key invoke + on_fontlist_select(), which sets var font_name. + + Sizelist: clicking the menubutton opens the dropdown menu. A + mouse button 1 click or return key sets var font_size. + + Bold_toggle: clicking the box toggles var font_bold. + + Changing any of the font vars invokes var_changed_font, which + adds all 3 font options to changes and calls set_samples. + Set_samples applies a new font constructed from the font vars to + font_sample and to highlight_sample on the hightlight page. + + Tabs: Enable users to change spaces entered for indent tabs. + Changing indent_scale value with the mouse sets Var space_num, + which invokes the default callback to add an entry to + changes. Load_tab_cfg initializes space_num to default. + + Widget Structure: (*) widgets bound to self + frame (of tab_pages) + frame_font: LabelFrame + frame_font_name: Frame + font_name_title: Label + (*)fontlist: ListBox - font_name + scroll_font: Scrollbar + frame_font_param: Frame + font_size_title: Label + (*)sizelist: DynOptionMenu - font_size + (*)bold_toggle: Checkbutton - font_bold + frame_font_sample: Frame + (*)font_sample: Label + frame_indent: LabelFrame + indent_title: Label + (*)indent_scale: Scale - space_num + """ + parent = self.parent + self.font_name = tracers.add(StringVar(parent), self.var_changed_font) + self.font_size = tracers.add(StringVar(parent), self.var_changed_font) + self.font_bold = tracers.add(BooleanVar(parent), self.var_changed_font) + self.space_num = tracers.add(IntVar(self), ('main', 'Indent', 'num-spaces')) + + # Create widgets: + # body and body section frames. + frame = self + frame_font = LabelFrame( + frame, borderwidth=2, relief=GROOVE, text=' Base Editor Font ') + frame_indent = LabelFrame( + frame, borderwidth=2, relief=GROOVE, text=' Indentation Width ') + # frame_font. + frame_font_name = Frame(frame_font) + frame_font_param = Frame(frame_font) + font_name_title = Label( + frame_font_name, justify=LEFT, text='Font Face :') + self.fontlist = Listbox(frame_font_name, height=5, + takefocus=True, exportselection=FALSE) + self.fontlist.bind('<ButtonRelease-1>', self.on_fontlist_select) + self.fontlist.bind('<KeyRelease-Up>', self.on_fontlist_select) + self.fontlist.bind('<KeyRelease-Down>', self.on_fontlist_select) + scroll_font = Scrollbar(frame_font_name) + scroll_font.config(command=self.fontlist.yview) + self.fontlist.config(yscrollcommand=scroll_font.set) + font_size_title = Label(frame_font_param, text='Size :') + self.sizelist = DynOptionMenu(frame_font_param, self.font_size, None) + self.bold_toggle = Checkbutton( + frame_font_param, variable=self.font_bold, + onvalue=1, offvalue=0, text='Bold') + frame_font_sample = Frame(frame_font, relief=SOLID, borderwidth=1) + temp_font = tkFont.Font(parent, ('courier', 10, 'normal')) + self.font_sample = Label( + frame_font_sample, justify=LEFT, font=temp_font, + text='AaBbCcDdEe\nFfGgHhIiJj\n1234567890\n#:+=(){}[]') + # frame_indent. + indent_title = Label( + frame_indent, justify=LEFT, + text='Python Standard: 4 Spaces!') + self.indent_scale = Scale( + frame_indent, variable=self.space_num, + orient='horizontal', tickinterval=2, from_=2, to=16) + + # Pack widgets: + # body. + frame_font.pack(side=LEFT, padx=5, pady=5, expand=TRUE, fill=BOTH) + frame_indent.pack(side=LEFT, padx=5, pady=5, fill=Y) + # frame_font. + frame_font_name.pack(side=TOP, padx=5, pady=5, fill=X) + frame_font_param.pack(side=TOP, padx=5, pady=5, fill=X) + font_name_title.pack(side=TOP, anchor=W) + self.fontlist.pack(side=LEFT, expand=TRUE, fill=X) + scroll_font.pack(side=LEFT, fill=Y) + font_size_title.pack(side=LEFT, anchor=W) + self.sizelist.pack(side=LEFT, anchor=W) + self.bold_toggle.pack(side=LEFT, anchor=W, padx=20) + frame_font_sample.pack(side=TOP, padx=5, pady=5, expand=TRUE, fill=BOTH) + self.font_sample.pack(expand=TRUE, fill=BOTH) + # frame_indent. + frame_indent.pack(side=TOP, fill=X) + indent_title.pack(side=TOP, anchor=W, padx=5) + self.indent_scale.pack(side=TOP, padx=5, fill=X) + + return frame + + def load_font_cfg(self): + """Load current configuration settings for the font options. + + Retrieve current font with idleConf.GetFont and font families + from tk. Setup fontlist and set font_name. Setup sizelist, + which sets font_size. Set font_bold. Call set_samples. + """ + configured_font = idleConf.GetFont(self, 'main', 'EditorWindow') + font_name = configured_font[0].lower() + font_size = configured_font[1] + font_bold = configured_font[2]=='bold' + + # Set editor font selection list and font_name. + fonts = list(tkFont.families(self)) + fonts.sort() + for font in fonts: + self.fontlist.insert(END, font) + self.font_name.set(font_name) + lc_fonts = [s.lower() for s in fonts] + try: + current_font_index = lc_fonts.index(font_name) + self.fontlist.see(current_font_index) + self.fontlist.select_set(current_font_index) + self.fontlist.select_anchor(current_font_index) + self.fontlist.activate(current_font_index) + except ValueError: + pass + # Set font size dropdown. + self.sizelist.SetMenu(('7', '8', '9', '10', '11', '12', '13', '14', + '16', '18', '20', '22', '25', '29', '34', '40'), + font_size) + # Set font weight. + self.font_bold.set(font_bold) + self.set_samples() + + def var_changed_font(self, *params): + """Store changes to font attributes. + + When one font attribute changes, save them all, as they are + not independent from each other. In particular, when we are + overriding the default font, we need to write out everything. + """ + value = self.font_name.get() + changes.add_option('main', 'EditorWindow', 'font', value) + value = self.font_size.get() + changes.add_option('main', 'EditorWindow', 'font-size', value) + value = self.font_bold.get() + changes.add_option('main', 'EditorWindow', 'font-bold', value) + self.set_samples() + + def on_fontlist_select(self, event): + """Handle selecting a font from the list. + + Event can result from either mouse click or Up or Down key. + Set font_name and example displays to selection. + """ + font = self.fontlist.get( + ACTIVE if event.type.name == 'KeyRelease' else ANCHOR) + self.font_name.set(font.lower()) + + def set_samples(self, event=None): + """Update update both screen samples with the font settings. + + Called on font initialization and change events. + Accesses font_name, font_size, and font_bold Variables. + Updates font_sample and hightlight page highlight_sample. + """ + font_name = self.font_name.get() + font_weight = tkFont.BOLD if self.font_bold.get() else tkFont.NORMAL + new_font = (font_name, self.font_size.get(), font_weight) + self.font_sample['font'] = new_font + self.highlight_sample['font'] = new_font + + def load_tab_cfg(self): + """Load current configuration settings for the tab options. + + Attributes updated: + space_num: Set to value from idleConf. + """ + # Set indent sizes. + space_num = idleConf.GetOption( + 'main', 'Indent', 'num-spaces', default=4, type='int') + self.space_num.set(space_num) + + def var_changed_space_num(self, *params): + "Store change to indentation size." + value = self.space_num.get() + changes.add_option('main', 'Indent', 'num-spaces', value) + + class VarTrace: """Maintain Tk variables trace state.""" diff --git a/Lib/idlelib/idle_test/test_configdialog.py b/Lib/idlelib/idle_test/test_configdialog.py index aff3c2fdc3b..8da726b80c0 100644 --- a/Lib/idlelib/idle_test/test_configdialog.py +++ b/Lib/idlelib/idle_test/test_configdialog.py @@ -9,7 +9,7 @@ import unittest from unittest import mock from idlelib.idle_test.mock_idle import Func -from tkinter import Tk, IntVar, BooleanVar, DISABLED, NORMAL +from tkinter import Tk, Frame, IntVar, BooleanVar, DISABLED, NORMAL from idlelib import config from idlelib.configdialog import idleConf, changes, tracers @@ -47,7 +47,7 @@ def tearDownModule(): del root -class FontTest(unittest.TestCase): +class FontPageTest(unittest.TestCase): """Test that font widgets enable users to make font changes. Test that widget actions set vars, that var changes add three @@ -56,11 +56,15 @@ class FontTest(unittest.TestCase): """ @classmethod def setUpClass(cls): - dialog.set_samples = Func() # Mask instance method. + page = cls.page = dialog.fontpage + #dialog.note.insert(0, page, text='copy') + #dialog.note.add(page, text='copyfgfg') + dialog.note.select(page) + page.set_samples = Func() # Mask instance method. @classmethod def tearDownClass(cls): - del dialog.set_samples # Unmask instance method. + del cls.page.set_samples # Unmask instance method. def setUp(self): changes.clear() @@ -68,7 +72,8 @@ def setUp(self): def test_load_font_cfg(self): # Leave widget load test to human visual check. # TODO Improve checks when add IdleConf.get_font_values. - d = dialog + tracers.detach() + d = self.page d.font_name.set('Fake') d.font_size.set('1') d.font_bold.set(True) @@ -77,16 +82,17 @@ def test_load_font_cfg(self): self.assertNotEqual(d.font_name.get(), 'Fake') self.assertNotEqual(d.font_size.get(), '1') self.assertFalse(d.font_bold.get()) - self.assertEqual(d.set_samples.called, 3) + self.assertEqual(d.set_samples.called, 1) + tracers.attach() def test_fontlist_key(self): # Up and Down keys should select a new font. - - if dialog.fontlist.size() < 2: - cls.skipTest('need at least 2 fonts') - fontlist = dialog.fontlist + d = self.page + if d.fontlist.size() < 2: + self.skipTest('need at least 2 fonts') + fontlist = d.fontlist fontlist.activate(0) - font = dialog.fontlist.get('active') + font = d.fontlist.get('active') # Test Down key. fontlist.focus_force() @@ -96,7 +102,7 @@ def test_fontlist_key(self): down_font = fontlist.get('active') self.assertNotEqual(down_font, font) - self.assertIn(dialog.font_name.get(), down_font.lower()) + self.assertIn(d.font_name.get(), down_font.lower()) # Test Up key. fontlist.focus_force() @@ -106,14 +112,14 @@ def test_fontlist_key(self): up_font = fontlist.get('active') self.assertEqual(up_font, font) - self.assertIn(dialog.font_name.get(), up_font.lower()) + self.assertIn(d.font_name.get(), up_font.lower()) def test_fontlist_mouse(self): # Click on item should select that item. - - if dialog.fontlist.size() < 2: + d = self.page + if d.fontlist.size() < 2: cls.skipTest('need at least 2 fonts') - fontlist = dialog.fontlist + fontlist = d.fontlist fontlist.activate(0) # Select next item in listbox @@ -129,17 +135,17 @@ def test_fontlist_mouse(self): font1 = fontlist.get(1) select_font = fontlist.get('anchor') self.assertEqual(select_font, font1) - self.assertIn(dialog.font_name.get(), font1.lower()) + self.assertIn(d.font_name.get(), font1.lower()) def test_sizelist(self): # Click on number shouod select that number - d = dialog + d = self.page d.sizelist.variable.set(40) self.assertEqual(d.font_size.get(), '40') def test_bold_toggle(self): # Click on checkbutton should invert it. - d = dialog + d = self.page d.font_bold.set(False) d.bold_toggle.invoke() self.assertTrue(d.font_bold.get()) @@ -154,7 +160,7 @@ def test_font_set(self): default_font = idleConf.GetFont(root, 'main', 'EditorWindow') default_size = str(default_font[1]) default_bold = default_font[2] == 'bold' - d = dialog + d = self.page d.font_size.set(default_size) d.font_bold.set(default_bold) d.set_samples.called = 0 @@ -183,7 +189,7 @@ def test_font_set(self): self.assertEqual(d.set_samples.called, 3) def test_set_samples(self): - d = dialog + d = self.page del d.set_samples # Unmask method for test d.font_sample, d.highlight_sample = {}, {} d.font_name.set('test') @@ -201,16 +207,21 @@ def test_set_samples(self): class IndentTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.page = dialog.fontpage + def test_load_tab_cfg(self): - d = dialog + d = self.page d.space_num.set(16) d.load_tab_cfg() self.assertEqual(d.space_num.get(), 4) def test_indent_scale(self): + d = self.page changes.clear() - dialog.indent_scale.set(26) - self.assertEqual(dialog.space_num.get(), 16) + d.indent_scale.set(20) + self.assertEqual(d.space_num.get(), 16) self.assertEqual(mainpage, {'Indent': {'num-spaces': '16'}}) @@ -234,8 +245,10 @@ class GeneralTest(unittest.TestCase): """ @classmethod def setUpClass(cls): - # Mask instance methods used by help functions. d = dialog + # Select General tab so can force focus on helplist. + d.note.select(d.genpage) + # Mask instance methods used by help functions. d.set = d.set_add_delete_state = Func() d.upc = d.update_help_changes = Func() @@ -311,9 +324,8 @@ def test_source_selected(self): helplist.event_generate('<Motion>', x=x, y=y) helplist.event_generate('<Button-1>', x=x, y=y) helplist.event_generate('<ButtonRelease-1>', x=x, y=y) - # The following fail after the switch to - # self.assertEqual(helplist.get('anchor'), 'source') - # self.assertTrue(d.set.called) + self.assertEqual(helplist.get('anchor'), 'source') + self.assertTrue(d.set.called) self.assertFalse(d.upc.called) def test_set_add_delete_state(self): diff --git a/Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst b/Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst new file mode 100644 index 00000000000..47fed949d10 --- /dev/null +++ b/Misc/NEWS.d/next/IDLE/2017-07-30-01-00-58.bpo-31004.m8cc1t.rst @@ -0,0 +1,4 @@ +IDLE - Factor FontPage(Frame) class from ConfigDialog. + +Slightly modified tests continue to pass. Fix General tests. Patch mostly by +Cheryl Sabella. [View Less]

1 0

bpo-30928: Update IDLE News.txt. (#2948)
by Terry Jan Reedy July 30, 2017

July 30, 2017

https://github.com/python/cpython/commit/c3aa47f655abe564a2c2fb6d091ab19bdc… commit: c3aa47f655abe564a2c2fb6d091ab19bdc0113b5 branch: master author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: GitHub <noreply(a)github.com> date: 2017-07-30T06:25:22-04:00 summary: bpo-30928: Update IDLE News.txt. (#2948) files: M Lib/idlelib/NEWS.txt diff --git a/Lib/idlelib/NEWS.txt b/Lib/idlelib/NEWS.txt index 9cde4a6bc5b..7d6d362e2d5 100644 --- a/Lib/idlelib/NEWS.txt +++ b/Lib/idlelib/NEWS.… [View More]txt @@ -3,6 +3,44 @@ Released on 2018-06-18? ======================== +bpo-30781: IDLE - Use ttk Notebook in ConfigDialog. +Patch by Terry Jan Reedy. + +bpo-31060: IDLE - Finish rearranging methods of ConfigDialog. +Grouping methods pertaining to each tab and the buttons will aid +writing tests and improving the tabs and will enable splitting the +groups into classes. +Patch by Terry Jan Reedy. + +bpo-30853: IDLE -- Factor a VarTrace class out of ConfigDialog. +Instance tracers manages pairs consisting of a tk variable and a +callback function. When tracing is turned on, setting the variable +calls the function. Test coverage for the new class is 100%. +Patch by Terry Jan Reedy. + +bpo-31003: IDLE: Add more tests for General tab. +Patch by Terry Jan Reedy. + +bpo-30993: IDLE - Improve configdialog font page and tests. +*In configdialog: Document causal pathways in create_font_tab +docstring. Simplify some attribute names. Move set_samples calls to +var_changed_font (idea from Cheryl Sabella). Move related functions to +positions after the create widgets function. +* In test_configdialog: Fix test_font_set so not order dependent. Fix +renamed test_indent_scale so it tests the widget. Adjust tests for +movement of set_samples call. Add tests for load functions. Put all +font tests in one class and tab indent tests in another. Except for +two lines, these tests completely cover the related functions. +Patch by Terry Jan Reedy. + +bpo-30981: IDLE -- Add more configdialog font page tests. + +bpo-28523: IDLE: replace 'colour' with 'color' in configdialog. + +bpo-30917: Add tests for idlelib.config.IdleConf. +Increase coverage from 46% to 96%. +Patch by Louie Lu. + bpo-30913: Document ConfigDialog tk Vars, methods, and widgets in docstrings This will facilitate improving the dialog and splitting up the class. Original patch by Cheryl Sabella. @@ -11,7 +49,7 @@ bpo-30899: Add tests for ConfigParser subclasses in config. Coverage is 100% for those classes and ConfigChanges. Patch by Louie Lu. -bpo-30881: Add docstrings to browser.py. +bpo-30881: Add docstrings to browser.py. Patch by Cheryl Sabella. bpo-30851: Remove unused tk variables in configdialog. @@ -48,7 +86,7 @@ bp0-30723: Make several improvements to parenmatch. * Make 'default' style, which is not default, a synonym for 'opener'. * Make time-delay work the same with all styles. * Add help for config dialog extensions tab, including parenmatch. -* Add new tests. +* Add new tests. Original patch by Charles Wohlganger. Revisions by Terry Jan Reedy bpo-30674: Grep -- Add docstrings. Patch by Cheryl Sabella. [View Less]

1 0

bpo-30522: Implemented a method to allow setting a logging.StreamHander's stream. (GH-2921)
by Vinay Sajip July 30, 2017

July 30, 2017

https://github.com/python/cpython/commit/2543f50033208c1a8df04999082b11aa09… commit: 2543f50033208c1a8df04999082b11aa09e82a04 branch: master author: Vinay Sajip <vinay_sajip(a)yahoo.co.uk> committer: GitHub <noreply(a)github.com> date: 2017-07-30T10:41:45+01:00 summary: bpo-30522: Implemented a method to allow setting a logging.StreamHander's stream. (GH-2921) files: A Misc/NEWS.d/next/Library/2017-07-30-10-07-58.bpo-30522.gAX1N-.rst M Doc/library/logging.handlers.rst M Lib/… [View More]logging/__init__.py M Lib/test/test_logging.py diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst index f13f765c019..0974286e55d 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -59,6 +59,18 @@ and :meth:`flush` methods). :meth:`close` method is inherited from :class:`~logging.Handler` and so does no output, so an explicit :meth:`flush` call may be needed at times. + .. method:: setStream(stream) + + Sets the instance's stream to the specified value, if it is different. + The old stream is flushed before the new stream is set. + + :param stream: The stream that the handler should use. + + :return: the old stream, if the stream was changed, or *None* if it wasn't. + + .. versionadded:: 3.7 + + .. versionchanged:: 3.2 The ``StreamHandler`` class now has a ``terminator`` attribute, default value ``'\n'``, which is used as the terminator when writing a formatted @@ -66,6 +78,7 @@ and :meth:`flush` methods). set the handler instance's ``terminator`` attribute to the empty string. In earlier versions, the terminator was hardcoded as ``'\n'``. + .. _file-handler: FileHandler diff --git a/Lib/logging/__init__.py b/Lib/logging/__init__.py index f9bfb79ae66..54d4e883d97 100644 --- a/Lib/logging/__init__.py +++ b/Lib/logging/__init__.py @@ -997,6 +997,26 @@ def emit(self, record): except Exception: self.handleError(record) + def setStream(self, stream): + """ + Sets the StreamHandler's stream to the specified value, + if it is different. + + Returns the old stream, if the stream was changed, or None + if it wasn't. + """ + if stream is self.stream: + result = None + else: + result = self.stream + self.acquire() + try: + self.flush() + self.stream = stream + finally: + self.release() + return result + def __repr__(self): level = getLevelName(self.level) name = getattr(self.stream, 'name', '') diff --git a/Lib/test/test_logging.py b/Lib/test/test_logging.py index 88845629614..6d0b23441ba 100644 --- a/Lib/test/test_logging.py +++ b/Lib/test/test_logging.py @@ -698,6 +698,20 @@ def test_error_handling(self): finally: logging.raiseExceptions = old_raise + def test_stream_setting(self): + """ + Test setting the handler's stream + """ + h = logging.StreamHandler() + stream = io.StringIO() + old = h.setStream(stream) + self.assertIs(old, sys.stderr) + actual = h.setStream(old) + self.assertIs(actual, stream) + # test that setting to existing value returns None + actual = h.setStream(old) + self.assertIsNone(actual) + # -- The following section could be moved into a server_helper.py module # -- if it proves to be of wider utility than just test_logging diff --git a/Misc/NEWS.d/next/Library/2017-07-30-10-07-58.bpo-30522.gAX1N-.rst b/Misc/NEWS.d/next/Library/2017-07-30-10-07-58.bpo-30522.gAX1N-.rst new file mode 100644 index 00000000000..214f98e101c --- /dev/null +++ b/Misc/NEWS.d/next/Library/2017-07-30-10-07-58.bpo-30522.gAX1N-.rst @@ -0,0 +1,2 @@ +Added a ``setStream`` method to ``logging.StreamHandler`` to allow the +stream to be set after creation. [View Less]

1 0

bpo-30962: Added caching to Logger.isEnabledFor() (GH-2752)
by Vinay Sajip July 30, 2017

July 30, 2017

https://github.com/python/cpython/commit/78c18a9b9a1445f7c755929917a790ba02… commit: 78c18a9b9a1445f7c755929917a790ba02b4a5e0 branch: master author: Avram Lubkin <git_hub(a)avram.us> committer: Vinay Sajip <vinay_sajip(a)yahoo.co.uk> date: 2017-07-30T10:36:33+01:00 summary: bpo-30962: Added caching to Logger.isEnabledFor() (GH-2752) files: M Lib/logging/__init__.py M Lib/test/test_logging.py diff --git a/Lib/logging/__init__.py b/Lib/logging/__init__.py index 64e24eef50e..… [View More]f9bfb79ae66 100644 --- a/Lib/logging/__init__.py +++ b/Lib/logging/__init__.py @@ -1244,6 +1244,19 @@ def _fixupChildren(self, ph, alogger): alogger.parent = c.parent c.parent = alogger + def _clear_cache(self): + """ + Clear the cache for all loggers in loggerDict + Called when level changes are made + """ + + _acquireLock() + for logger in self.loggerDict.values(): + if isinstance(logger, Logger): + logger._cache.clear() + self.root._cache.clear() + _releaseLock() + #--------------------------------------------------------------------------- # Logger classes and functions #--------------------------------------------------------------------------- @@ -1274,12 +1287,14 @@ def __init__(self, name, level=NOTSET): self.propagate = True self.handlers = [] self.disabled = False + self._cache = {} def setLevel(self, level): """ Set the logging level of this logger. level must be an int or a str. """ self.level = _checkLevel(level) + self.manager._clear_cache() def debug(self, msg, *args, **kwargs): """ @@ -1543,9 +1558,17 @@ def isEnabledFor(self, level): """ Is this logger enabled for level 'level'? """ - if self.manager.disable >= level: - return False - return level >= self.getEffectiveLevel() + try: + return self._cache[level] + except KeyError: + _acquireLock() + if self.manager.disable >= level: + is_enabled = self._cache[level] = False + else: + is_enabled = self._cache[level] = level >= self.getEffectiveLevel() + _releaseLock() + + return is_enabled def getChild(self, suffix): """ @@ -1910,6 +1933,7 @@ def disable(level=CRITICAL): Disable all logging calls of severity 'level' and below. """ root.manager.disable = level + root.manager._clear_cache() def shutdown(handlerList=_handlerList): """ diff --git a/Lib/test/test_logging.py b/Lib/test/test_logging.py index 880f4e89fb0..88845629614 100644 --- a/Lib/test/test_logging.py +++ b/Lib/test/test_logging.py @@ -135,7 +135,9 @@ def tearDown(self): logging._handlers.clear() logging._handlers.update(self.saved_handlers) logging._handlerList[:] = self.saved_handler_list - loggerDict = logging.getLogger().manager.loggerDict + manager = logging.getLogger().manager + manager.disable = 0 + loggerDict = manager.loggerDict loggerDict.clear() loggerDict.update(self.saved_loggers) logger_states = self.logger_states @@ -4094,6 +4096,62 @@ def test_pickling(self): unpickled = pickle.loads(s) self.assertIs(unpickled, logger) + def test_caching(self): + root = self.root_logger + logger1 = logging.getLogger("abc") + logger2 = logging.getLogger("abc.def") + + # Set root logger level and ensure cache is empty + root.setLevel(logging.ERROR) + self.assertEqual(logger2.getEffectiveLevel(), logging.ERROR) + self.assertEqual(logger2._cache, {}) + + # Ensure cache is populated and calls are consistent + self.assertTrue(logger2.isEnabledFor(logging.ERROR)) + self.assertFalse(logger2.isEnabledFor(logging.DEBUG)) + self.assertEqual(logger2._cache, {logging.ERROR: True, logging.DEBUG: False}) + self.assertEqual(root._cache, {}) + self.assertTrue(logger2.isEnabledFor(logging.ERROR)) + + # Ensure root cache gets populated + self.assertEqual(root._cache, {}) + self.assertTrue(root.isEnabledFor(logging.ERROR)) + self.assertEqual(root._cache, {logging.ERROR: True}) + + # Set parent logger level and ensure caches are emptied + logger1.setLevel(logging.CRITICAL) + self.assertEqual(logger2.getEffectiveLevel(), logging.CRITICAL) + self.assertEqual(logger2._cache, {}) + + # Ensure logger2 uses parent logger's effective level + self.assertFalse(logger2.isEnabledFor(logging.ERROR)) + + # Set level to NOTSET and ensure caches are empty + logger2.setLevel(logging.NOTSET) + self.assertEqual(logger2.getEffectiveLevel(), logging.CRITICAL) + self.assertEqual(logger2._cache, {}) + self.assertEqual(logger1._cache, {}) + self.assertEqual(root._cache, {}) + + # Verify logger2 follows parent and not root + self.assertFalse(logger2.isEnabledFor(logging.ERROR)) + self.assertTrue(logger2.isEnabledFor(logging.CRITICAL)) + self.assertFalse(logger1.isEnabledFor(logging.ERROR)) + self.assertTrue(logger1.isEnabledFor(logging.CRITICAL)) + self.assertTrue(root.isEnabledFor(logging.ERROR)) + + # Disable logging in manager and ensure caches are clear + logging.disable() + self.assertEqual(logger2.getEffectiveLevel(), logging.CRITICAL) + self.assertEqual(logger2._cache, {}) + self.assertEqual(logger1._cache, {}) + self.assertEqual(root._cache, {}) + + # Ensure no loggers are enabled + self.assertFalse(logger1.isEnabledFor(logging.CRITICAL)) + self.assertFalse(logger2.isEnabledFor(logging.CRITICAL)) + self.assertFalse(root.isEnabledFor(logging.CRITICAL)) + class BaseFileTest(BaseTest): "Base class for handler tests that write log files" [View Less]

1 0

Daily reference leaks (4243df51fe43): sum=5
by solipsis＠pitrou.net July 30, 2017

July 30, 2017

results for 4243df51fe43 on branch "default" -------------------------------------------- test_asyncio leaked [0, 0, 3] memory blocks, sum=3 test_collections leaked [0, 7, -7] memory blocks, sum=0 test_functools leaked [0, 3, 1] memory blocks, sum=4 test_multiprocessing_forkserver leaked [0, 0, -2] memory blocks, sum=-2 Command line was: ['./python', '-m', 'test.regrtest', '-uall', '-R', '3:3:/home/psf-users/antoine/refleaks/reflogSklKPW', '--timeout', '7200']

1 0

[3.6] bpo-30803: clarify truth value testing documentation (GH-2508) (#2946)
by Terry Jan Reedy July 29, 2017

July 29, 2017

https://github.com/python/cpython/commit/4c7b368de7bcabdd821059c023c46c9d85… commit: 4c7b368de7bcabdd821059c023c46c9d85668d3f branch: 3.6 author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: GitHub <noreply(a)github.com> date: 2017-07-29T18:56:06-04:00 summary: [3.6] bpo-30803: clarify truth value testing documentation (GH-2508) (#2946) Initial patch by Peter Thomassen. (cherry picked from commit caa1280) files: A Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.… [View More]6hutqQ.rst M Doc/library/stdtypes.rst diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index e929f0b6876..b8c4d59363d 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -39,31 +39,26 @@ Truth Value Testing single: false Any object can be tested for truth value, for use in an :keyword:`if` or -:keyword:`while` condition or as operand of the Boolean operations below. The -following values are considered false: +:keyword:`while` condition or as operand of the Boolean operations below. - .. index:: single: None (Built-in object) - -* ``None`` - - .. index:: single: False (Built-in object) - -* ``False`` - -* zero of any numeric type, for example, ``0``, ``0.0``, ``0j``. +.. index:: single: true -* any empty sequence, for example, ``''``, ``()``, ``[]``. +By default, an object is considered true unless its class defines either a +:meth:`__bool__` method that returns ``False`` or a :meth:`__len__` method that +returns zero, when called with the object. [1]_ Here are most of the built-in +objects considered false: -* any empty mapping, for example, ``{}``. + .. index:: + single: None (Built-in object) + single: False (Built-in object) -* instances of user-defined classes, if the class defines a :meth:`__bool__` or - :meth:`__len__` method, when that method returns the integer zero or - :class:`bool` value ``False``. [1]_ +* constants defined to be false: ``None`` and ``False``. -.. index:: single: true +* zero of any numeric type: ``0``, ``0.0``, ``0j``, ``Decimal(0)``, + ``Fraction(0, 1)`` -All other values are considered true --- so objects of many types are always -true. +* empty sequences and collections: ``''``, ``()``, ``[]``, ``{}``, ``set()``, + ``range(0)`` .. index:: operator: or diff --git a/Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.6hutqQ.rst b/Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.6hutqQ.rst new file mode 100644 index 00000000000..4699713ee6e --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.6hutqQ.rst @@ -0,0 +1 @@ +Clarify doc on truth value testing. Original patch by Peter Thomassen. [View Less]

1 0

bpo-30803: clarify truth value testing documentation (#2508)
by Terry Jan Reedy July 29, 2017

July 29, 2017

https://github.com/python/cpython/commit/caa1280d1ee5f828f346b585169a759237… commit: caa1280d1ee5f828f346b585169a7592371d3faa branch: master author: Peter Thomassen <peterthomassen(a)users.noreply.github.com> committer: Terry Jan Reedy <tjreedy(a)udel.edu> date: 2017-07-29T15:18:13-04:00 summary: bpo-30803: clarify truth value testing documentation (#2508) Initial patch by Peter Thomassen. files: A Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.6hutqQ.rst M Doc/… [View More]library/stdtypes.rst diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index 564579e70c5..2fce851e2e0 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -39,31 +39,26 @@ Truth Value Testing single: false Any object can be tested for truth value, for use in an :keyword:`if` or -:keyword:`while` condition or as operand of the Boolean operations below. The -following values are considered false: +:keyword:`while` condition or as operand of the Boolean operations below. - .. index:: single: None (Built-in object) - -* ``None`` - - .. index:: single: False (Built-in object) - -* ``False`` - -* zero of any numeric type, for example, ``0``, ``0.0``, ``0j``. +.. index:: single: true -* any empty sequence, for example, ``''``, ``()``, ``[]``. +By default, an object is considered true unless its class defines either a +:meth:`__bool__` method that returns ``False`` or a :meth:`__len__` method that +returns zero, when called with the object. [1]_ Here are most of the built-in +objects considered false: -* any empty mapping, for example, ``{}``. + .. index:: + single: None (Built-in object) + single: False (Built-in object) -* instances of user-defined classes, if the class defines a :meth:`__bool__` or - :meth:`__len__` method, when that method returns the integer zero or - :class:`bool` value ``False``. [1]_ +* constants defined to be false: ``None`` and ``False``. -.. index:: single: true +* zero of any numeric type: ``0``, ``0.0``, ``0j``, ``Decimal(0)``, + ``Fraction(0, 1)`` -All other values are considered true --- so objects of many types are always -true. +* empty sequences and collections: ``''``, ``()``, ``[]``, ``{}``, ``set()``, + ``range(0)`` .. index:: operator: or diff --git a/Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.6hutqQ.rst b/Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.6hutqQ.rst new file mode 100644 index 00000000000..4699713ee6e --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2017-07-29-14-55-50.bpo-30803.6hutqQ.rst @@ -0,0 +1 @@ +Clarify doc on truth value testing. Original patch by Peter Thomassen. [View Less]

1 0