The correct way to comment code. python

Question

I read PEP8 and some questions about stackoverflow, but was interested in spaces between comments:

will say that I have this code:

class MyBrowser(QWebPage): ''' Settings for the browser.''' def __init__(self): QWebPage.__init__(self) # Specifies whether images are automatically loaded in web pages. self.settings().setAttribute(QWebSettings.AutoLoadImages, True) def userAgentForUrl(self, url): ''' Returns a User Agent that will be seen by the website. ''' return "Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.15 (KHTML, like Gecko) Chrome/24.0.1295.0 Safari/537.15" 

What is the most pythonic way of blank lines between comments and actual code? I want to show my program to some experts. And I want my code to look more professional.

Answer 1

I don't know if this complies with the community standard, but here are the Google Python Style Guides (as they relate to the comments). In particular, the classes:

 class SampleClass(object): """Summary of class here. Longer class information.... Longer class information.... Attributes: likes_spam: A boolean indicating if we like SPAM or not. eggs: An integer count of the eggs we have laid. """ def __init__(self, likes_spam=False): """Inits SampleClass with blah.""" self.likes_spam = likes_spam self.eggs = 0 def public_method(self): """Performs operation blah.""" 

Answer 2

From Zen Python: "Reading is calculated." No matter what your team turns out to be the most read, I will do.

Answer 3

If in doubt, check out the standard library for the model.

Here is an excerpt from the timeit module (written by Guido van Ross himself):

 def print_exc(self, file=None): """Helper to print a traceback from the timed code. Typical use: t = Timer(...) # outside the try/except try: t.timeit(...) # or t.repeat(...) except: t.print_exc() The advantage over the standard traceback is that source lines in the compiled template will be displayed. The optional file argument directs where the traceback is sent; it defaults to sys.stderr. """ import linecache, traceback if self.src is not None: linecache.cache[dummy_src_name] = (len(self.src), None, self.src.split("\n"), dummy_src_name) # else the source is already stored somewhere else traceback.print_exc(file=file)