Python модуль документации - PullRequest
Новая
       16

Python модуль документации

0 голосов
/ 10 апреля 2020

Как мне распечатать строку документации моего файла модуля python из моего основного файла? Допустим, у меня есть файл модуля python с именем Projectile.py, который определяет внутри него класс с именем Projectile. Затем у меня есть еще один python файл с именем main.py. В основном, я хочу получить доступ к docstring уровня модуля. Как мне это сделать?
Я знаю, как напечатать строку документации для класса и методов. Например, чтобы напечатать строку документации уровня класса из моего основного файла, это было бы просто: 

print(Projectile.__doc__)

Output:  This is the class docstring:  Simulates the flight of simple projectiles near the earth's surface, ignoring wind resistance. Tracking is done in two dimensions, height (y) and distance (x).

Но как напечатать строку документа уровня модуля ?? Спасибо! 

     """This is the module docstring"""
        from graphics import *
        from math import *

        class Projectile:
            """This is the class docstring:  Simulates the flight of simple projectiles near the earth's surface, 
               ignoring wind resistance. Tracking is done in two dimensions, height (y) and distance (x)."""

            # Constructor - TO INITIALIZE INSTANCE VARIABLES
            """This is the constructor docstring"""
            def __init__(self, angle, velocity, height):
                self.initialVelocity = velocity
                self.xpos = 0.0

1 Ответ

0 голосов
/ 10 апреля 2020

Вы можете получить строку документации, используя поле __doc__: 

import x; print(x.__doc__)

Или используйте функцию help для получения интерактивной справки: 

import x; help(x)
...