disable a block of code

[Skaperen]

while doing some initial testing, i want to disable a block of code. many other languages have a specific comment start and end symbol. but Python doesn't.

can i achieve this by adding a line with ''' before and after the code to be disabled as long as the indentation resumes at the same depth? i tried and it works. but i don't what pitfalls there are, besides some other existing use of '''.

[micseydel]

Yes, Python uses tripe-quotes for block comments as well as strings.

[Gribouillis]

while doing some initial testing, i want to disable a block of code.

In a good editor, such as Kate, you can select a block of code and comment it out with a keyboard shortcut.

[Skaperen]

i see """ used in lots of places but i never see ''' used. early on i even thought """ was the only allowed way to do triple quoting until i was curious enough to actually try it. so my thought is that i will use ''' since it is less likely to run into a legit string literal using ''' than the others. even so, it would have been nice to have something for block comments like /* in a few other languages. and, IMHO, making it nestable would be a plus (though arguments against that can be easily made).

[metulburr]

When do you actually put that many comments into code?

the triple quotes of docstrings handle descriptions for every piece of code. If you wanted to use it for block comments, you could do that also.

and i always use single quotes for everything in python, unless im trying to avoid escaping one by using double quotes.

i want to disable a block of code.

besides triple quotes, depending on what i want to switch off and on, I will put my code into a class and just comment out the creation of the instance (assuming that is not referred to again). However thats if it called for being in a class in the first place.

Example

I would just comment out line 36 if i want to comment out all the MenuBar code.

import wx

class MenuBar(wx.MenuBar):
    def __init__(self, root):
        wx.MenuBar.__init__(self)

        menu = wx.Menu()
        m_exit = menu.Append(wx.ID_EXIT, "E&xit\tCtrl+Q", "Close window and exit program.")
        root.Bind(wx.EVT_MENU, root.on_close, m_exit)
        self.Append(menu, "&File")
        
        menu = wx.Menu()
        m_about = menu.Append(wx.ID_ABOUT, "&About", "Information about this program")
        root.Bind(wx.EVT_MENU, self.on_about, m_about)
        self.Append(menu, "&Help")
        
        self.about_box = wx.AboutDialogInfo()
        self.about_box.Name = 'My About Box'
        self.about_box.Version = '0.0.1 Beta'
        self.about_box.Copyright = 'No Copyright'
        self.about_box.Description = 'This is an example application that shows how to create different kinds of About Boxes using wxPython!'
        self.about_box.WebSite = ('https://www.python-forum.io', 'Forums')
        self.about_box.Developers = ['metulburr', 'Jack the Ripper']
        self.about_box.License = "Completely and totally open source!"
        
        
        root.SetMenuBar(self)
        
    def on_about(self, event):
        wx.AboutBox(self.about_box)

class Control(wx.Frame):
    def __init__(self, title):
        wx.Frame.__init__(self, None, title=title)
        self.Bind(wx.EVT_CLOSE, self.on_close)
        MenuBar(self)

    def on_close(self, event):
        self.Destroy()

app = wx.App()
Control('WxPython').Show()
app.MainLoop()

[Skaperen]

i comment my code as i write it and/or as i rewrite it. but less then 5% is commented. i am trying to increase that percentage, particularly for what i (intend to) release to the public.