Python Docstrings (с примери)

В този урок ще научим за документите на Python. По-конкретно, ще научим как и защо се използват документите с помощта на примери.

Python docstrings са низовите литерали, които се появяват веднага след дефиницията на функция, метод, клас или модул. Да вземем пример.

Пример 1: Документи

 def square(n): '''Takes in a number n, returns the square of n''' return n**2

Тук низният литерал:

 '' 'Взима число n, връща квадрата на n' ''

Вътре в тройните кавички е документът на функцията, square()както се появява веднага след нейното дефиниране.

Забележка: Можем да използваме и тройни """кавички, за да създаваме докстринги.

Коментари на Python срещу Docstrings

Коментари на Python

Коментарите са описания, които помагат на програмистите да разберат по-добре намерението и функционалността на програмата. Те са напълно игнорирани от интерпретатора на Python.

В Python използваме символа хеш, за #да напишем едноредов коментар. Например,

 # Program to print "Hello World" print("Hello World")

Python коментира с помощта на низове

Ако не присвоим низове на която и да е променлива, те действат като коментари. Например,

 "I am a single-line comment" ''' I am a multi-line comment! ''' print("Hello World")

Забележка: Използваме тройни кавички за многоредови низове.

Доктринг на Python

Както бе споменато по-горе, Python документите са низове, използвани веднага след дефиницията на функция, метод, клас или модул (както в Пример 1 ). Те се използват за документиране на нашия код.

Можем да осъществим достъп до тези докстрини, използвайки __doc__атрибута.

Python __doc__ атрибут

Когато низови литерали присъстват непосредствено след дефиницията на функция, модул, клас или метод, те се свързват с обекта като техен __doc__атрибут. По-късно можем да използваме този атрибут, за да извлечем този документ.

Пример 2: Отпечатване на документация

 def square(n): '''Takes in a number n, returns the square of n''' return n**2 print(square.__doc__)

Изход

 Взима число n, връща квадрата на n

Тук документацията на нашата square()функция може да бъде достъпна с помощта на __doc__атрибута.

Сега, нека разгледаме документите за вградената функция print():

Пример 3: Документи за вградената функция print ()

 print(print.__doc__)

Изход

print (value, …, sep = '', end = ' n', file = sys.stdout, flush = False) Отпечатва стойностите в поток или в sys.stdout по подразбиране. Незадължителни аргументи на ключови думи: файл: обект, подобен на файл (поток); по подразбиране е текущата sys.stdout. sep: низ, вмъкнат между стойности, по подразбиране интервал. end: низ, добавен след последната стойност, по подразбиране нов ред. флъш: дали да се промива принудително потока.

Тук можем да видим, че документацията на print()функцията присъства като __doc__атрибут на тази функция.

Едноредови документи в Python

Едноредови документите са документите, които се побират в един ред.

Стандартни конвенции за писане на едноредови докстрини:

  • Въпреки че са еднолинейни, все още използваме тройните кавички около тези документи, тъй като те могат лесно да бъдат разширени по-късно.
  • Затварящите котировки са на същия ред като началните котировки.
  • Няма празен ред нито преди, нито след документа.
  • Те не трябва да са описателни, а трябва да следват структурата „Направи това, върни това“, завършваща с точка.

Да вземем пример.

Пример 4: Напишете едноредови документи за функция

 def multiplier(a, b): """Takes in two numbers, returns their product.""" return a*b

Многоредови документи в Python

Многоредови документи се състоят от обобщаващ ред точно като едноредов документ, последван от празен ред, последван от по-сложно описание.

Документът PEP 257 предоставя стандартните конвенции за писане на многоредови документи за различни обекти.

Някои са изброени по-долу:

1. Докстринг за Python модули

  • В документите за модули на Python трябва да се изброят всички налични класове, функции, обекти и изключения, които се импортират при импортиране на модула.
  • They should also have a one-line summary for each item.

They are written at the beginning of the Python file.

Let's look at the docstrings for the builtin module in Python called pickle.

Example 4: Docstrings of Python module

 import pickle print(pickle.__doc__)

Output

 Create portable serialized representations of Python objects. See module copyreg for a mechanism for registering custom picklers. See module pickletools source for extensive comments. Classes: Pickler Unpickler Functions: dump(object, file) dumps(object) -> string load(file) -> object loads(string) -> object Misc variables: __version__ format_version compatible_formats

Here, we can see that the docstring written at the beginning of the pickle.py module file can be accessed as its docstring.

2. Docstrings for Python Functions

  • The docstring for a function or method should summarize its behavior and document its arguments and return values.
  • It should also list all the exceptions that can be raised and other optional arguments.

Example 5: Docstrings for Python functions

 def add_binary(a, b): ''' Returns the sum of two decimal numbers in binary digits. Parameters: a (int): A decimal integer b (int): Another decimal integer Returns: binary_sum (str): Binary string of the sum of a and b ''' binary_sum = bin(a+b)(2:) return binary_sum print(add_binary.__doc__)

Output

 Returns the sum of two decimal numbers in binary digits. Parameters: a (int): A decimal integer b (int): Another decimal integer Returns: binary_sum (str): Binary string of the sum of a and b

As you can see, we have included a short description of what the function does, the parameter it takes in and the value it returns. The string literal is embedded to the function add_binary as its __doc__ attribute.

3. Docstrings for Python Classes

  • The docstrings for classes should summarize its behavior and list the public methods and instance variables.
  • The subclasses, constructors, and methods should each have their own docstrings.

Example 6: Docstrings for Python class

Suppose we have a Person.py file with the following code:

 class Person: """ A class to represent a person.… Attributes ---------- name : str first name of the person surname : str family name of the person age : int age of the person Methods ------- info(additional=""): Prints the person's name and age. """ def __init__(self, name, surname, age): """ Constructs all the necessary attributes for the person object. Parameters ---------- name : str first name of the person surname : str family name of the person age : int age of the person """ self.name = name self.surname = surname self.age = age def info(self, additional=""): """ Prints the person's name and age. If the argument 'additional' is passed, then it is appended after the main info. Parameters ---------- additional : str, optional More info to be displayed (default is None) Returns ------- None """ print(f'My name is (self.name) (self.surname). I am (self.age) years old.' + additional)

Here, we can use the following code to access only the docstrings of the Person class:

 print(Person.__doc__)

Output

 A class to represent a person.… Attributes ---------- name : str first name of the person surname : str family name of the person age : int age of the person Methods ------- info(additional=""): Prints the person's name and age

Using the help() Function for Docstrings

We can also use the help() function to read the docstrings associated with various objects.

Example 7: Read Docstrings with the help() function

We can use the help() function on the class Person in Example 6 as:

 help(Person)

Output

 Help on class Person in module __main__: class Person(builtins.object) | Person(name, surname, age) | | A class to represent a person. | |… | | Attributes | ---------- | name : str | first name of the person | surname : str | family name of the person | age : int | age of the person | | Methods | ------- | info(additional=""): | Prints the person's name and age. | | Methods defined here: | | __init__(self, name, surname, age) | Constructs all the necessary attributes for the person object. | | Parameters | ---------- | name : str | first name of the person | surname : str | family name of the person | age : int | age of the person | | info(self, additional='') | Prints the person's name and age. | | If the argument 'additional' is passed, then it is appended after the main info. | | Parameters | ---------- | additional : str, optional | More info to be displayed (default is None) | | Returns | ------- | None | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined)

Here, we can see that the help() function retrieves the docstrings of the Person class along with the methods associated with that class.

4. Docstrings for Python Scripts

  • The docstrings for Python script should document the script's functions and command-line syntax as a usable message.
  • It should serve as a quick reference to all the functions and arguments.

5. Docstrings for Python Packages

The docstrings for a Python package is written in the package's __init__.py file.

  • It should contain all the available modules and sub-packages exported by the package.

Docstring Formats

We can write docstring in many formats like the reStructured text (reST) format, Google format or the NumPy documentation format. To learn more, visit Popular Docstring Formats

Също така можем да генерираме документация от документите, като използваме инструменти като Sphinx. За да научите повече, посетете официалната документация на сфинкса

Интересни статии...