Программное изменение документации для методов

@zewer · Регистрация: 07.01.2011

Студворк — интернет-сервис помощи студентам

Здраствуйте, нуждаюсь в помощи.

Например такой код

Python
1
2
3
4
5
6
7
8
9
10
11
12
class A:
    """
    Class docstring
    """
 
    __doc__ = """123"""
 
    def func(self) -> None:
        pass
 
 
print(A().__doc__)

напечатает

Code
1
2
3
4
D:\Python\python.exe D:/untitled/test_package/test.py
123
 
Process finished with exit code 0

Как с помощью переменной __doc__ установить так же документацию для метода func() ?

@Viktorrus · 29.11.2018, 03:29

Python
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
class A:
    """
    Class docstring
    """
 
    __doc__ = """123"""
 
    def func(self) -> None:
        pass
 
A.func.__doc__ = """456"""
 
 
print(A().__doc__)      # здесь круглые скобки не нужны
print(A.__doc__)
 
print(A.func.__doc__)

Здесь достаточно понимания следующего:
Инструкция class A: создает объект-класс (не путать с экземпляром класса) с именем А. Этот объект имеет атрибуты, в том числе и атрибут __doc__. Создание и присвоение значений атрибутам делает как сам Python, так и возможно вручную инструкцией присваивания = . Но синтаксис зависит от того места, где мы присваиваем. Если присваиваем внутри класса, то пишем __doc__ = """123""". если присваивание идет снаружи класса, то необходимо указывать имя класса и имя атрибута через точку A.__doc__ = """123""". При этом круглые скобки не нужны. Без круглых скобок просто идет ссылка на объект. Круглые скобки у функции вызывают функцию к исполнению. Что делают круглые скобки у класса не знаю, но для обращения к атрибутам класса они не нужны.
Все что я написал для объекта -класса, справедливо для любого другого объекта. Но инструкция def func(self) так же создает объект, но в данном случае объект -функция/метод с именем func. И к этому объекту относится все, что я написал выше про объект -класс. Объект func имеет атрибут __doc__ и ему можно присвоить значение за пределами класса, или внутри класса, тогда имя класса не нужно указывать. Можно ли присваивать внутри функции/метода, я не знаю, проверять не стал. Если для Вас это важно, то проверьте сами. В принципе, если внутри метода не будет работать, то можно будет указать этот атрибут внутри метода как глобальный и все получится.

Добавлено через 21 минуту

Python
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
class A:
    """
    Class docstring
    """
 
    __doc__ = """123"""
 
    def func(self) -> None:
        #__doc__ = """456"""
        pass
    func.__doc__ = """456"""
 
#A.func.__doc__ = """456"""
 
 
print(A().__doc__)      # здесь круглые скобки не нужны
print(A.__doc__)
 
print(A.func.__doc__)

Все таки не поленился и проверил. Внутри функции /метода присвоить значение атрибуту func.__doc__ инструкцией присваивания нельзя, даже объявляя атрибут глобальным. внутри метода указать значение для __doc__ можно только стандартным способом, с помощью строки документирования окаймленной тремя двойными кавычками """.....""" .

Добавлено через 2 минуты

Python
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
class A:
    """
    Class docstring
    """
 
    __doc__ = """123"""
 
    def func(self) -> None:
        """456"""
        #__doc__ = """456"""
        pass
    #func.__doc__ = """456"""
 
#A.func.__doc__ = """456"""
 
 
print(A().__doc__)      # здесь круглые скобки не нужны
print(A.__doc__)
 
print(A.func.__doc__)

Добавлено через 31 минуту

Python
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
class A:
    """
    Class docstring
    """
 
    __doc__ = """123"""
 
    def func(self) -> None:
        __doc__ = """456"""
        #pass
 
x = A()
print(A().__doc__)      # здесь круглые скобки не нужны
print(A.__doc__)
x.func()
print(x.__doc__)

Внутри метода можно присваивать значение атрибуту __doc__ только для экземпляра класса, x.__doc__ .

Добавлено через 6 минут
Кстати я забыл, круглые скобки при вызове класса нужны при создании экземпляра класса:
x = A(). Но , как я и говорил, при обращении к атрибуту объекта-класса, они не нужны A.__doc__ .

@Viktorrus · 29.11.2018, 20:15

Когда Вы пишите print(A().__doc__), то строго говоря Вы получаете значение не атрибута класса, а атрибута некоторого созданного (без имени) экземпляра класса А, хотя его значение равно значению атрибута класса, так как экземпляр наследует это значение у класса.

@zewer · 29.11.2018, 21:16 **[ТС]**

Viktorrus, спасибо

Новые блоги и статьи Все статьи Все блоги /
Подключение Box2D v3 к SDL3 для Android: физика и отрисовка коллайдеров 8Observer8 29.01.2026 Содержание блога Box2D - это библиотека для 2D физики для анимаций и игр. С её помощью можно определять были ли коллизии между конкретными объектами. Версия v3 была полностью переписана на Си, в. . .	Инструменты COM: Сохранение данный из VARIANT в файл и загрузка из файла в VARIANT bedvit 28.01.2026 Сохранение базовых типов COM и массивов (одномерных или двухмерных) любой вложенности (деревья) в файл, с возможностью выбора алгоритмов сжатия и шифрования. Часть библиотеки BedvitCOM Использованы. . .	Загрузка PNG с альфа-каналом на SDL3 для Android: с помощью SDL_LoadPNG (без SDL3_image) 8Observer8 28.01.2026 Содержание блога SDL3 имеет собственные средства для загрузки и отображения PNG-файлов с альфа-каналом и базовой работы с ними. В этой инструкции используется функция SDL_LoadPNG(), которая. . .	Загрузка PNG с альфа-каналом на SDL3 для Android: с помощью SDL3_image 8Observer8 27.01.2026 Содержание блога SDL3_image - это библиотека для загрузки и работы с изображениями. Эта пошаговая инструкция покажет, как загрузить и вывести на экран смартфона картинку с альфа-каналом, то есть с. . .
Влияние грибов на сукцессию anaschu 26.01.2026 Бифуркационные изменения массы гриба происходят тогда, когда мы уменьшаем массу компоста в 10 раз, а скорость прироста биомассы уменьшаем в три раза. Скорость прироста биомассы может уменьшаться за. . .	Воспроизведение звукового файла с помощью SDL3_mixer при касании экрана Android 8Observer8 26.01.2026 Содержание блога SDL3_mixer - это библиотека я для воспроизведения аудио. В отличие от инструкции по добавлению текста код по проигрыванию звука уже содержится в шаблоне примера. Нужно только. . .	Установка Android SDK, NDK, JDK, CMake и т.д. 8Observer8 25.01.2026 Содержание блога Перейдите по ссылке: https:/ / developer. android. com/ studio и в самом низу страницы кликните по архиву "commandlinetools-win-xxxxxx_latest. zip" Извлеките архив и вы увидите. . .	Вывод текста со шрифтом TTF на Android с помощью библиотеки SDL3_ttf 8Observer8 25.01.2026 Содержание блога Если у вас не установлены Android SDK, NDK, JDK, и т. д. то сделайте это по следующей инструкции: Установка Android SDK, NDK, JDK, CMake и т. д. Сборка примера Скачайте. . .

@Viktorrus 1732 / 970 / 199 Регистрация: 22.02.2018 Сообщений: 2,693 Записей в блоге: 6
	29.11.2018, 20:15
	Когда Вы пишите print(A().__doc__), то строго говоря Вы получаете значение не атрибута класса, а атрибута некоторого созданного (без имени) экземпляра класса А, хотя его значение равно значению атрибута класса, так как экземпляр наследует это значение у класса. 0

@zewer 2356 / 1774 / 212 Регистрация: 07.01.2011 Сообщений: 10,342
	29.11.2018, 21:16 [ТС]
	Viktorrus, спасибо 0