#docstring #функции #модули

Что такое Docstrings в Python?
Docstrings (документационные строки) — это строковые литералы, которые размещаются сразу после определения функции, метода, класса или модуля в Python. Они служат для документирования кода и предоставляют информацию о том, что делает данный элемент кода.Основные характеристики docstrings:

Расположение: Docstring должен быть первой строкой в теле функции, класса или модуля. Это позволяет Python распознавать его как документацию для данного элемента.

Формат: Docstrings обычно заключаются в тройные кавычки (одинарные или двойные), что позволяет им занимать несколько строк, если это необходимо. Это делает их удобными для более подробного описания.

Цель: В отличие от обычных комментариев, которые могут объяснять отдельные строки кода, docstrings предоставляют высокоуровневое описание того, что делает функция, класс или модуль. Это помогает другим разработчикам (или вам самим в будущем) быстро понять назначение и использование кода.

#lambda #docstring #СортировкиСписка

Пример кода на Python, который включает в себя использование lambda для сортировки списка, функцию с описанием через docstring, а также пояснения и комментарии:

def sort_list(input_list, reverse=False):
"""
Сортирует список чисел или строк в порядке возрастания или убывания.

Аргументы:
input_list (list): Список элементов (чисел или строк), которые нужно отсортировать.
reverse (bool): Если True, сортировка будет в порядке убывания. По умолчанию False.

Возвращает:
list: Отсортированный список.

Пример:
>>> sort_list([3, 1, 4, 1, 5, 9])
[1, 1, 3, 4, 5, 9]
>>> sort_list(["apple", "banana", "cherry"], reverse=True)
['cherry', 'banana', 'apple']
"""
# Используем встроенную функцию sorted() с ключом сортировки, заданным через lambda
# Если reverse=True, список сортируется в обратном порядке
return sorted(input_list, key=lambda x: x, reverse=reverse)


# Пример использования функции
if __name__ == "__main__":
# Список чисел
numbers = [3, 1, 4, 1, 5, 9]
print("Сортировка чисел по возрастанию:", sort_list(numbers))
print("Сортировка чисел по убыванию:", sort_list(numbers, reverse=True))

# Список строк
words = ["apple", "banana", "cherry"]
print("Сортировка строк по возрастанию:", sort_list(words))
print("Сортировка строк по убыванию:", sort_list(words, reverse=True))

Пояснения к коду:

Функция sort_list:
Принимает два аргумента:
input_list: список элементов (чисел или строк), которые нужно отсортировать.
reverse: логический флаг, указывающий, нужно ли сортировать в обратном порядке.
Использует встроенную функцию sorted() для сортировки.
В качестве ключа сортировки используется lambda x: x, что означает, что элементы сортируются "как есть".

Lambda-функция:
lambda x: x — это анонимная функция, которая просто возвращает элемент x. Она используется как ключ сортировки.

Docstring:
Описание функции написано в формате docstring, чтобы можно было получить справку через help(sort_list).

Комментарии:
В коде добавлены комментарии, поясняющие, что делает каждая часть.

Пример использования:
В блоке if name == "main": показано, как использовать функцию для сортировки чисел и строк.


Как проверить описание функции:

После запуска кода в Python, вы можете вызвать help(sort_list) для получения справки:

>>> help(sort_list)


Вывод будет таким:

Help on function sort_list in module __main__:

sort_list(input_list, reverse=False)
Сортирует список чисел или строк в порядке возрастания или убывания.

Аргументы:
input_list (list): Список элементов (чисел или строк), которые нужно отсортировать.
reverse (bool): Если True, сортировка будет в порядке убывания. По умолчанию False.

Возвращает:
list: Отсортированный список.

Пример:
>>> sort_list([3, 1, 4, 1, 5, 9])
[1, 1, 3, 4, 5, 9]
>>> sort_list(["apple", "banana", "cherry"], reverse=True)
['cherry', 'banana', 'apple']

Этот код универсален и подходит для сортировки как чисел, так и строк.

🥸 Знаешь с кем поделиться? 👀📚📃