Как наиболее принято разработчиками обозначать начало/конец метода комментариями в Python

Question

Хм, интересно. Сейчас задумался как лучше или как принято обозначать начало/конец метода или класса комментариями.

Я сделал вот так

#обработка изображений, что бы были картинки в админке, а не ссылки
def image_tag(self):
    if self.image:
        return mark_safe('<img src="%s" style="width: 45px; height:45px;" />' % self.image.url)
    else:
        return 'No Image Found'

# -- обработка изображений, что бы была картинки в админке, а не ссылки

Или лучше так?

# start обработка изображений, что бы были картинки в админке, а не ссылки
def image_tag(self):
    if self.image:
        return mark_safe('<img src="%s" style="width: 45px; height:45px;" />' % self.image.url)
    else:
        return 'No Image Found'

# end обработка изображений, что бы была картинки в админке, а не ссылки

Есть ли какой либо стандарт этого? А можно ли каким-то образом сделать что бы коммент-конец автоматически прописался в конце выделенной области?

Answer 1

Принято делать так:

def image_tag(self):
    '''обработка изображений, что бы были картинки в админке, а не ссылки'''

    if self.image:
        return mark_safe('<img src="%s" style="width: 45px; height:45px;" />' % self.image.url)
    else:
        return 'No Image Found'

# пустая строчка

Конец метода не обозначается - это не нужно потому, как в глаза и так бросается лесенка влево

 def xxx:
     xxx:
         xxx
     xxx
     return xxx

 def yyy:
     yyy

БЛОГ НА HUSL

Как наиболее принято разработчиками обозначать начало/конец метода комментариями в Python

Ответы (1 шт):