Ebben az oktatóanyagban megismerhetjük a Python docstringeket. Pontosabban, példák segítségével megtudhatjuk, hogyan és miért használják a docstringeket.
A Python-utasítások azok a karakterlánc-literálok, amelyek közvetlenül egy függvény, módszer, osztály vagy modul meghatározása után jelennek meg. Vegyünk egy példát.
1. példa: Docstrings
def square(n): '''Takes in a number n, returns the square of n''' return n**2
Itt a karakterlánc:
'' 'Egy n számot vesz fel, az n' 'négyzetét adja vissza
A hármas idézőjelek belsejében található a függvény docstringje, amely square()közvetlenül a definíciója után jelenik meg.
Megjegyzés: Hármas """idézeteket is használhatunk docstringek létrehozására.
Python Comments vs Docstrings
Python megjegyzések
A megjegyzések olyan leírások, amelyek segítenek a programozóknak jobban megérteni a program szándékát és funkcionalitását. A Python tolmács teljesen figyelmen kívül hagyja őket.
A Pythonban a hash szimbólumot használjuk #egysoros megjegyzés írásához. Például,
# Program to print "Hello World" print("Hello World")
A Python megjegyzéseket karakterláncokkal használ
Ha egyetlen változóhoz sem rendelünk sztringet, akkor ezek megjegyzésekként működnek. Például,
"I am a single-line comment" ''' I am a multi-line comment! ''' print("Hello World")
Megjegyzés: Hármas idézőjeleket használunk a többsoros karakterláncokhoz.
Python-utasítások
Mint fent említettük, a Python-parancssorok olyan karakterláncok, amelyeket közvetlenül egy függvény, módszer, osztály vagy modul meghatározása után használnak (például az 1. példában ). A kódunk dokumentálására szolgálnak.
Ezeket az utasításokat az __doc__attribútummal érhetjük el .
Python __doc__ attribútum
Ha a karakterlánc-literálok éppen egy függvény, modul, osztály vagy módszer meghatározása után vannak jelen, akkor az objektumhoz társítják őket __doc__attribútumként. Később használhatjuk ezt az attribútumot a docstring lekérésére.
2. példa: Dokumentumstring nyomtatása
def square(n): '''Takes in a number n, returns the square of n''' return n**2 print(square.__doc__)
Kimenet
Az n számot beveszi, az n négyzetét adja vissza
Itt a square()funkciónk dokumentációja az __doc__attribútummal érhető el .
Most nézzük meg a beépített függvény docstringjeit print():
3. példa: Parancssorok a beépített print () függvényhez
print(print.__doc__)
Kimenet
nyomtatás (érték,…, sep = '', end = ' n', file = sys.stdout, flush = hamis) Alapértelmezés szerint az értékeket kiírja egy adatfolyamba vagy a sys.stdout fájlba. Opcionális kulcsszó argumentumok: fájl: fájlszerű objektum (adatfolyam); alapértelmezés szerint az aktuális sys.stdout. szep: az értékek közé beillesztett karakterlánc, alapértelmezés szerint szóköz. end: string az utolsó érték után, alapértelmezés szerint új sor. öblítés: a patak erőszakos átöblítése.
Itt láthatjuk, hogy a print()függvény dokumentációja jelen __doc__van ennek a függvénynek az attribútumaként.
Egysoros docstringek a Pythonban
Az egysoros docstringek azok a dokumentumok, amelyek egy sorba illeszkednek.
Egysoros utasítások írásának szokásos konvenciói:
- Annak ellenére, hogy egysorosak, mégis használjuk a hármas idézeteket ezeken a utasításokon, mivel később könnyebben kibővíthetők.
- A záró idézetek ugyanazon a soron vannak, mint a nyitó idézetek.
- Sem a dokstring előtt, sem után nincs üres sor.
- Nem szabad, hogy leíró jellegűek legyenek, inkább követniük kell a „Csináld, tedd vissza” struktúrát, amely periódussal zárul.
Vegyünk egy példát.
4. példa: Írjon egysoros utasításokat egy függvényhez
def multiplier(a, b): """Takes in two numbers, returns their product.""" return a*b
Többsoros Docstrings a Pythonban
A többsoros docstringek egy összefoglaló sorból állnak, csakúgy, mint az egysoros docstringek, amelyet egy üres sor követ, majd egy részletesebb leírás.
A PEP 257 dokumentum tartalmazza a szabványos konvenciókat, amelyek különféle objektumokhoz írnak többsoros utasításokat.
Néhányat az alábbiakban soroltunk fel:
1. Instrukciók Python modulokhoz
- A Python-modulok utasításainak fel kell sorolniuk az összes elérhető osztályt, függvényt, objektumot és kivételt, amelyet a modul importálásakor importálnak.
- 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
Dokumentumokat is előállíthatunk docstringekből olyan eszközökkel, mint a Sphinx. Ha többet szeretne megtudni, keresse fel a Hivatalos Szfinx Dokumentációt
