Python-käskyt (esimerkkejä)

Tässä opetusohjelmassa opit Python-komentosarjoista. Tarkemmin sanottuna opimme kuinka ja miksi käskyjä käytetään esimerkkien avulla.

Python-käskysarjat ovat merkkijonolitraaleja, jotka näkyvät heti funktion, menetelmän, luokan tai moduulin määrityksen jälkeen. Otetaan esimerkki.

Esimerkki 1: Ohjeet

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

Tässä merkkijono kirjaimellinen:

 '' 'Sisältää luvun n, palauttaa n: n neliön' ''

Kolminkertaisten lainausmerkkien sisällä on funktion komento , square()koska se näkyy heti määritelmän jälkeen.

Huomaa: Voimme käyttää myös kolminkertaisia """lainauksia komentojonojen luomiseen.

Python-kommentit vs Docstrings

Python-kommentit

Kommentit ovat kuvauksia, jotka auttavat ohjelmoijia ymmärtämään paremmin ohjelman tarkoituksen ja toiminnallisuuden. Python-tulkki jättää ne täysin huomiotta.

Pythonissa käytetään hash-symbolia #yksirivisen kommentin kirjoittamiseen. Esimerkiksi,

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

Python kommentoi merkkijonoja

Jos emme määritä jonoja mihinkään muuttujaan, ne toimivat kommentteina. Esimerkiksi,

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

Huomaa: Käytämme kolmoisia lainausmerkkejä monirivijonoille.

Python-käskyt

Kuten edellä mainittiin, Python-käskyt ovat merkkijonoja, joita käytetään heti funktion, menetelmän, luokan tai moduulin määrityksen jälkeen (kuten esimerkissä 1 ). Niitä käytetään koodin dokumentointiin.

Voimme käyttää näitä käskyjä __doc__määritteen avulla.

Python __doc__ -attribuutti

Aina kun merkkijonolitraaleja esiintyy juuri funktion, moduulin, luokan tai menetelmän määrityksen jälkeen, ne liitetään objektiin __doc__attribuuttina. Voimme myöhemmin käyttää tätä määritettä tämän käskyn hakemiseen.

Esimerkki 2: Asiakirjojen tulostaminen

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

Tuotos

 Ottaa luvun n, palauttaa n: n neliön

Täällä square()toiminnon dokumentaatio on käytettävissä __doc__attribuutin avulla.

Katsotaan nyt sisäänrakennetun toiminnon käskyjä print():

Esimerkki 3: Sisäisen print () -toiminnon ohjeet

 print(print.__doc__)

Tuotos

tulosta (arvo,…, sep = '', loppu = ' n', tiedosto = sys.stdout, huuhtelu = epätosi) Tulostaa arvot virtaan tai sys.stdoutiin oletuksena. Valinnaiset avainsana-argumentit: tiedosto: tiedostomainen objekti (virta); oletuksena nykyinen sys.stdout. sep: merkkijono lisätty arvojen väliin, oletusarvoisesti välilyönti. end: merkkijono lisätään viimeisen arvon jälkeen, oletusarvoisesti uusi rivi. huuhtelu: huuhdellaanko virta väkisin.

Täällä voimme nähdä, että print()funktion dokumentaatio on läsnä __doc__tämän funktion attribuuttina.

Yksiriviset käskyt Pythonissa

Yhden rivin käskyt ovat asiakirjoja, jotka sopivat yhteen riviin.

Vakiokäytännöt yksirivisten käskyjen kirjoittamiseksi:

  • Vaikka ne ovat yksirivisiä, käytämme silti kolmoisia lainauksia näiden käskyjen ympärillä, koska niitä voidaan helposti laajentaa myöhemmin.
  • Viimeiset lainausmerkit ovat samalla rivillä kuin alkulainaukset.
  • Tyhjää riviä ei ole ennen komentoa tai sen jälkeen.
  • Niiden ei pitäisi olla kuvailevia, vaan niiden on noudatettava "Tee tämä, palauta tuo" -rakennetta, joka päättyy pisteeseen.

Otetaan esimerkki.

Esimerkki 4: Kirjoita yksiriviset käskyt funktiolle

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

Moniriviset käskyt Pythonissa

Moniriviset käskyt koostuvat yhteenvetorivistä aivan kuten yksiriviset käskyt, jota seuraa tyhjä rivi ja sen jälkeen yksityiskohtaisempi kuvaus.

PEP 257 -asiakirja tarjoaa vakiokäytännöt monirivisten komentosarjojen kirjoittamiseksi eri kohteille.

Jotkut on lueteltu alla:

1. Python-moduulien käskyt

  • Python-moduulien käskyjen tulisi luetella kaikki käytettävissä olevat luokat, toiminnot, objektit ja poikkeukset, jotka tuodaan moduulin tuonnin yhteydessä.
  • 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

Voimme myös luoda dokumentaatiota käskyistä käyttämällä Sphinxin kaltaisia ​​työkaluja. Lisätietoja on virallisessa sfinksi-dokumentaatiossa

Mielenkiintoisia artikkeleita...