Python Help ()

Автор оригинала: Chris.

Как и большинство кодеров, я регулярно просмотрую поисковую систему – да, как будто было много хороших вариантов;) – Чтобы узнать о списках параметров определенных функций Python. Если вы действительно стоите на плечах гигантов, и используйте мощные библиотеки Python, разработанные некоторыми из лучших кодеров в мире, изучая API существующих функций, должна быть элементарным куском вашей ежедневной кодирующей работы.

Встроенный Python Помощь () Функция запускает справочную систему Python. Без аргумента, Помощь () Запускает интерактивный сеанс. Со строковым аргументом Помощь (Имя) Выпадает из названия и печатает страницу справки в оболочку. С бенструйным аргументом Помощь (объект) Распечатает страницу справки на объекте.

>>> help(list)             # Prints the documentation of list
>>> help(dict)             # Prints the documentation of dict
>>> help(int)              # Prints the documentation of int
>>> help('help')           # Prints the documentation of help()
>>> help()                 # Opens an interactive "help" session

Справка синтаксиса ()

Помощь () Объект имеет следующий синтаксис:

Syntax: 
help()               # Opens an interactive help session to explore multiple objects
help(string)         # Looks up the name and prints a help page to the shell
help(object)         # Prints a help page on object

Возврат стоимости справки ()

Помощь (объект) Функция возвращает Нет Отказ

Пример справки () без аргументации

Без аргумента, Помощь () Запускает интерактивный сеанс.

>>> help()

Welcome to Python 3.7's help utility!

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://docs.python.org/3.7/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics".  Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".

help> string
Help on module string:

NAME
    string - A collection of string constants.

DESCRIPTION
    Public module variables:
    

В этом примере вы создали интерактивную справочную сессию и передавали строку имя (что является объектом) в сеансе. Затем Python печатает соответствующую документацию. Вы можете закрыть интерактивную справочную сессию, ударив Ctrl + C или введите Выйти с последующим ударом Введите Отказ

Пример справки () со строковым аргументом

Со строковым аргументом Помощь (Имя) Выпадает из названия и печатает страницу справки в оболочку.

>>> help('help')
	       
Help on module help:

NAME
    help

DESCRIPTION
    help.py: Implement the Idle help menu.
    Contents are subject to revision at any time, without notice.
...

Вы можете спросить: где Python смотрит на объекты, связанные с каждым строковым значением?

Ответ прост: с помощью пространств имен оно выглядит наименованием имен модулей, функций, методов, переменных в путях Python. Учитывая имя, то он может затем получить связанные объекты из отображения памяти – каждое имя указывает на объект в памяти.

Вы можете прочитать больше в наших полных учебниках:

• Python Locals ()
• Глобалы Python ()
• Python Nampespaces сделал простой

Пример справки () с аргументом объекта

С бенструйным аргументом Помощь (объект) Распечатает страницу справки на объекте.

>>> help(print)
	       
Help on built-in function print in module builtins:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
    
    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.

Пропущенный объект функции, связанный с Печать Имя также работает как вход для Помощь () функция. В этом случае не требуется никаких поисков, но документация прошедшего объекта печатается сразу.

Python Help () Функция DOCSTRING

Python’s Помощь (объект) Функция возвращает DOCSTRING, связанную с объектом. DOCSTRING – это строка, которая следует сразу после определения модуля, функции, метода или объекта.

Вот пример определения функции Добавить () с DOCSTRING:

def add(a, b):
    '''Calculates a+b and returns the sum.'''
    return a+b

И вот как вы можете получить доступ к этому в своем коде через Помощь (Добавить) Функция звонка:

>>> help(add)
Help on function add in module __main__:

add(a, b)
    Calculates a+b and returns the sum.

Таким образом, вы можете написать собственную документацию и предоставлять другим кодрам доступ к вашим полезным пониманиям при написании фрагментов кода.

Функция справки Python () на пользовательском классе

Вы также можете позвонить в Помощь () Функция на Классы Отказ Python затем покажет вам доступные методы и их Docstrings Отказ Вот пример:

class Car:
    '''Representing cool cars'''

    def __init__(self, brand, color):
        '''Creates a new car with a brand and color'''
        self.brand = brand
        self.color = color


    def speed():
        '''Returns the speed of the car given brand'''
        if self.brand == 'porsche':
            return 150
        return 100

Каждый метод и сам класс имеет DOCSTRING. Выход при вызове Помощь () Функция на классе Автомобиль следующее:

>>> help(Car)
Help on class Car in module __main__:

class Car(builtins.object)
 |  Car(brand, color)
 |  
 |  Representing cool cars
 |  
 |  Methods defined here:
 |  
 |  __init__(self, brand, color)
 |      Creates a new car with a brand and color
 |  
 |  speed()
 |      Returns the speed of the car given brand
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

Но прежде чем мы будем двигаться дальше, я рад представить вам мою новую книгу Python Python One-listers (Amazon Link).

Если вам нравятся одноклассники, вы будете любить книгу. Это научит вам все, что нужно знать о Одно строка кода Python. Но это тоже Введение в компьютерную науку , наука о данных, машин обучения и алгоритмы. Вселенная в одной строке Python!

Книга была выпущена в 2020 году с помощью книги по программированию мирового класса Nostarch Press (San Francisco).

Ссылка: https://nostarch.com/pythononeliners.

Резюме

Встроенный Python Помощь () Функция Запускает справочную систему Python Отказ

• Без аргумента, Помощь () Запускает интерактивную сессию – см. Следующий фрагмент кода.
• Со строковым аргументом Помощь (Имя) Выпадает из названия и печатает страницу справки в оболочку.
• С бенструйным аргументом Помощь (объект) Распечатает страницу справки на объекте.

>>> help()

Welcome to Python 3.7's help utility!

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://docs.python.org/3.7/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics".  Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".

help> string
Help on module string:

NAME
    string - A collection of string constants.

DESCRIPTION
    Public module variables:
...

Я надеюсь, что вам понравилось статью! Чтобы улучшить свое образование Python, вы можете присоединиться к популярной академии по электронной почте Free Finxter:

Хотите увеличить свои навыки Python в веселой и легкой потребности? Рассмотрим следующие ресурсы и стать магистральным кодером!

Куда пойти отсюда?

Достаточно теории, давайте познакомимся!

Чтобы стать успешным в кодировке, вам нужно выйти туда и решать реальные проблемы для реальных людей. Вот как вы можете легко стать шестифункциональным тренером. И вот как вы польские навыки, которые вам действительно нужны на практике. В конце концов, что такое использование теории обучения, что никто никогда не нуждается?

Практические проекты – это то, как вы обостряете вашу пилу в кодировке!

Вы хотите стать мастером кода, сосредоточившись на практических кодовых проектах, которые фактически зарабатывают вам деньги и решают проблемы для людей?

Затем станьте питоном независимым разработчиком! Это лучший способ приближения к задаче улучшения ваших навыков Python – даже если вы являетесь полным новичком.

Присоединяйтесь к моему бесплатным вебинаре «Как создать свой навык высокого дохода Python» и посмотреть, как я вырос на моем кодированном бизнесе в Интернете и как вы можете, слишком от комфорта вашего собственного дома.

Присоединяйтесь к свободному вебинару сейчас!

Работая в качестве исследователя в распределенных системах, доктор Кристиан Майер нашел свою любовь к учению студентов компьютерных наук.

Чтобы помочь студентам достичь более высоких уровней успеха Python, он основал сайт программирования образования Finxter.com Отказ Он автор популярной книги программирования Python One-listers (Nostarch 2020), Coauthor of Кофе-брейк Python Серия самооставленных книг, энтузиаста компьютерных наук, Фрилансера и владелец одного из лучших 10 крупнейших Питон блоги по всему миру.

Его страсти пишут, чтение и кодирование. Но его величайшая страсть состоит в том, чтобы служить стремлению кодер через Finxter и помогать им повысить свои навыки. Вы можете присоединиться к его бесплатной академии электронной почты здесь.