Как написать свой модуль python

>>> import os
>>> os.getcwd()
'C:\Python33'

>>> import time, random
>>> time.time()
1376047104.056417
>>> random.random()
0.9874550833306869

>>> import math
>>> math.e
2.718281828459045

>>> import notexist
Traceback (most recent call last):
  File "", line 1, in
    import notexist
ImportError: No module named 'notexist'
>>> import math
>>> math.Ё
Traceback (most recent call last):
  File "", line 1, in
    math.Ё
AttributeError: 'module' object has no attribute 'Ё'

>>> import math as m
>>> m.e
2.718281828459045

from <Название модуля> import <Атрибут 1> [ as <Псевдоним 1> ], [<Атрибут 2> [ as <Псевдоним 2> ] ...]
from <Название модуля> import *

>>> from math import e, ceil as c
>>> e
2.718281828459045
>>> c(4.6)
5

>>> from math import (sin, cos,
...           tan, atan)

>>> from sys import *
>>> version
'3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)]'
>>> version_info
sys.version_info(major=3, minor=3, micro=2, releaselevel='final', serial=0)

def hello():
    print('Hello, world!')

def fib(n):
    a = b = 1
    for i in range(n - 2):
        a, b = b, a + b
    return b

import mymodule

mymodule.hello()
print(mymodule.fib(10))

Hello, world!
55

def hello():
    print('Hello, world!')

def fib(n):
    a = b = 1
    for i in range(n - 2):
        a, b = b, a + b
    return b

if __name__ == "__main__":
    hello()
    for i in range(10):
        print(fib(i))

Для вставки кода на Python в комментарий заключайте его в теги <pre><code class=»python3″>Ваш код</code></pre>

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

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

Модулем Python называется файл Python, содержащий различные утверждения и определения. В нем могут быть переменные, классы и различные функции. Как и простой скрипт Python, исполняемый код Python также присутствует внутри модуля Python.

Модуль Python становится более полезным, когда мы группируем связанный код и используем его как модуль внутри программы Python. С помощью модуля Python можно даже сделать код логически организованным. Мы можем использовать модуль Python внутри программы Python, просто применив оператор import.

Пример:

 
import module 

Предположим, что в модуле Python, то есть в модуле 1, присутствуют три функции, и мы хотим использовать только одну из них в нашем коде, тогда мы также можем импортировать только одну функцию, используя оператор from и import, как мы использовали ниже:

Пример:

 
import function1 from module1 

Поскольку мы узнали о модуле Python и получили общее представление о том, как модуль Python работает и импортируется в программу, теперь мы перейдем к его написанию.

Написание модуля Python

В этом разделе мы собираемся написать модуль Python и понять, как мы можем использовать модуль, который мы написали внутри программы Python.

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

Итак, давайте сначала создадим скрипт Python, сохраним его с расширением .py и сохраним в том же месте, где присутствует Python. Чтобы написать и создать простой модуль Python, необходимо выполнить следующие действия:

Шаг 1. Написание работающей программы

Во-первых, мы должны написать исполняемую программу внутри оболочки Python, открыв в ней новый файл. Например, мы напишем следующую программу функции сложения внутри файла Python:

 
# A default Python function for performing addition 
def addition(x, y): # Two variables as parameters 
    # Adding two variables and storing results in another variable 
    addValue = x + y 
    # Returning the addition result for two numbers 
    return addValue 

Шаг 2. Сохранение файла

Теперь, после написания программы сложения, как указано в первом шаге, мы сохраним файл с именем add.py в каталоге по умолчанию, назначенном Python.

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

 
# Importing the adding module in the program 
import adding 
# Taking two input variables from the user 
a1 = int(input("Enter first integer variable: ")) 
a2 = int(input("Enter second integer variable: ")) 
# Adding the variables with the function of 'adding' module 
addResult = addition(a1, a2) 
# Printing the result in the output 
print("The sum of two integer variables given by you is: ", addResult) 

Вывод:

Enter first integer variable: 26 
Enter second integer variable: 24 
The sum of two integer variables given by you is: 50 

Объяснение:

В приведенной выше программе мы выполнили операцию сложения двух входных переменных, которые мы взяли у пользователя. Мы использовали функцию adding модуля, импортировав этот модуль внутри программы. Наконец, мы напечатали результат сложения двух переменных в выходных данных и завершили программу.

Вывод

Мы можем создать или написать модуль Python, просто написав программу с функциями и классами в ней, а затем мы можем использовать созданный модуль внутри другой программы, просто импортировав его внутри программы. Мы даже можем использовать одну функцию из программы, используя дополнительное ключевое слово from с оператором импорта.

С помощью модуля Python мы можем сделать наш код логически организованным и сгруппировать аналогичный код в один модуль.

Modules are simply python code having functions, classes, variables. Any python file with .py extension can be referenced as a module. Although there are some modules available through the python standard library which are installed through python installation, Other modules can be installed using the pip installer, We can also create our own python module.

In this article, we will see how to create modules in python. 

Writing The Module

Any python code consisting of functions, classes, variables can be termed as a module. We will be writing a simple module that will be having a function, a class, and a variable.

Here in the above module, we have defined a class ‘Age’ having a __init__() and getAge() method which will be used to initialize the class object and getting the age of the object that would be passed, We have also defined a function hello() which will print ‘hello geeks!’ and also a string s which is ‘I love python!’.

We will name the above module made as mod.py and save it.

Importing The Module

Now we will discuss how to import a module and use its various functions, classes, variables from other python files. For this, we will make a file main.py in the same directory as mod.py. 

We will import the module with an import statement and use the functions, classes, variable as following:-

Using functions

For using the function from a module we will first import it and then will call the function with module_name.function_name(). For example, if we want to call the function hello() of mod.py in main.py we will first import mod.py and then call it with mod.hello().

Output:

hello geeks!

Note: Please make sure that the main.py and mod.py are in the same directory.

We can also import only a separate function from a module to use it by writing: from module_name import function_name

And then call it directly. For example, if we want to call the function hello() of mod.py in main.py using the above method we will write the following code in main.py.

Output:

hello geeks!

Using Classes

We can use the classes to make various objects by module_name.class_name(). For example, if we want to create an object in main.py by the name ‘jack’ of class Age present in mod.py. We will write the following code in main.py:

Output:

The age of jack is 21

The way we imported only a particular function in the same way we can import only a particular class. The code for this will be:

Output:

The age of jack is 21

Using Variables

For getting any variable from a module we have to first import the module, and then we can simply get it by module_name.variable_name. For example, if we want to print the variable with name s present in our mod.py module we will write the following code:

Output:

I love python!

As we did for functions and classes in the same way we can import a particular variable from a module. For printing variable ‘s’ by this method the code will be:

Output:

I love python!

Импорт и создание модулей

Содержание

• Импорт модулей стандартной библиотеки
  • Использование псевдонимов
  • Импорт нескольких модулей
  • Инструкция from
• Создание своего модуля питон
• Задача: составление анаграмм
• Домашнее задание

Импорт модулей стандартной библиотеки

Питон включает в себя обширную библиотеку модулей, в которых реализовано множество полезных функций. Далее в этом курсе мы будем применять и другие полезные модули: re для регулярных выражений, collections, содержащий множество удобных структур данных, os и shutil для управления файлами и папками.

Для использования модуля его нужно импортировать — попросить питон загрузить его и сделать его функции доступными для использования. Импорт осуществляется с помощью оператора import. Например, модуль random используется для генерации “случайных” чисел.

>>> import random
>>> # Теперь мы можем вызывать функции из модуля random, указав их имя после "random." с точкой
>>> random.randint(0, 5)  # выводит случайное целое число между 0 и 5 включительно
2
>>> random.choice('abcdef')  # выберает случайный элемент коллекции
'c'
>>> random.random()  # Выводит случайное число на полуинтервале [0, 1)
0.9131300358342321

Ещё один пример: модуль math, содержащий различные математические функции и константы

>>> math.cos(0)  # ошибка, модуль ещё не импортирован
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-4-9cdcc157d079> in <module>()
----> 1 math.cos(0)

NameError: name 'math' is not defined
>>> import math
>>> math.cos(0)
1.0
>>> math.asin(1)
1.5707963267948966
>>> math.e
2.718281828459045

Использование псевдонимов

Если название модуля слишком длинное и вы не хотите его писать каждый раз, когда используете какую-то функцию, вы можете импортировать этот модуль под псевдонимом с помощью as:

>>> import math as m
>>> m.factorial(5)
120

Импорт нескольких модулей

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

>>> import random, math
>>> math.sqrt(random.randint(0, 5))
2.23606797749979

Или:

import random
import math

>>> math.sqrt(random.randint(0, 5))
2.0

Инструкция from

Иногда в модуле бывает много разных функций, а вам нужно использовать только что-то одно (и, например, использовать много раз), тогда проще импортировать какую-то определенную функцию из этого модуля и (1) чуть-чуть сэкономить память, (2) короче синтаксис. Тогда синтаксис импорта будет следующий:

>>> from math import ceil, floor
>>> ceil(145.3)
146
>>> floor(145.6)
145

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

>>> from math import *
>>> sqrt(144)
12.0
>>> pi
3.141592653589793

Однако, это очень плохая практика так как в двух разных модулях могут быть одинаковые функции и при импорте вы просто не будете знать, какую используете.

Правило хорошего тона — импортировать модули вначале вашей программы, до любого другого кода и функций.

Создание своего модуля питон

Любой файл с исходным кодом на Python — модуль! Это значит, что любая программа может выступать в роли модуля для другой и импортироваться.

Давайте напишем скрипт с парой функций и импортируем эти функции в другую программу.

Создадим программу mymodule.py:

def avg(numbers):
    if not numbers:
        return 0
    return sum(numbers) / len(numbers)


def myfactorial(n):
    if n == 1:
        return n
    elif n < 1:
        return ("NA")
    else:
        return n * myfactorial(n-1)

В ней мы прописали две математические функции: среднее и факториал. Предположим теперь мы хотим воспользоваться ими в какой-нибудь другой программе myscript.py. Тогда мы положим эти два файла в одну директорию, чтобы импорт работал. И в результате мы сможем ипмортировать эти функции в новую программу.

Файл myscript.py:

import mymodule

n = input("Введите число: ")
my_list = [1] * (int(n)/2) + [2] * (int(n)/2)

print(mymodule.avg(my_list))
print(mymodule.myfactorial(int(n)))

Кстати, найдите баг в этом коде:

>>> [1] * (5/2)
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-35-f37e9b720bb2> in <module>
----> 1 [1] * (5/2)

TypeError: can't multiply sequence by non-int of type 'float'
>>> [1] * (5//2)
[1, 1]

Задача: составление анаграмм

В качестве примера использования функций и модуля стандартной библиотеки random рассмотрим задачу составления анаграмм. В качестве входного файла будем использовать любой текст, из которого мы выберем слова. Пусть текст находится в файле text.txt и имеет следующее содержание (из Яндекс.Рефератов):

Субъект вызывает мелодический импульс. Пласт параллельно понимает понимающий
эриксоновский гипноз, следовательно тенденция к конформизму связана с менее
низким интеллектом. Дифференциация, по определению, дает звукорядный
бихевиоризм.

Задача состоит в том, что необходимо составить файл формата TSV, состоящий из 4 колонок: слово из файла и три его случайных анаграммы. Для простоты анаграммы могут совпадать с самим словом или друг с другом. В итоге требуется получить файл table.tsv, который будет начинаться следующим образом:

субъект	ъсукебт	кутесъб	кеубътс
вызывает	езтавыыв	аыезыввт	ывеаывзт
мелодический	скйчмеелидио	диимечеслйок	мкееийлчосид
импульс	млсупьи	уьмипсл	льмпиус
пласт	сатпл	таслп	тпалс
...

Полный код для решения этой задачи может выглядеть следующим образом:

"""Эта программа собирает слова из text.txt и составляет список анаграмм из
них в таблице table.tsv"""

# Здесь мы импортируем модуль стандартной библиотеки random, в котором
# содержаться функции для работы с псевдослучайными числами.
# Правило хорошего тона — делать все импорты в начале вашей программы.
import random


def words_from_file(filename):
    """Принимает имя файла, а точнее его системный путь, и возвращает
    список слов в нем
    """
    with open(filename, encoding='utf-8') as f:  # открвываем файл
        text = f.read()  # прочитываем весь файл в строковую переменную
    text = text.replace('-', '')  # удаляем дефисы
    text = text.replace(',', '').replace('.', '')  # удаляем запятые и точки
    # Тут можно было почистить текст еще лучше
    text = text.lower()  # заменяем все заглавные на строчные
    words = text.split()  # получаем список слов
    return words  # возвращаем список слов


def anа(word):
    """Возвращает случайную анаграмму word"""
    # Функция random.sample(sequence, count) возвращает список из count
    # уникальных элементов последовательности (например списка или строки)
    # взятых в случайном порядке. Заметим, что каждый элемент не может быть
    # больше одного раза, а также напомним, что элементами строки являются
    # односимвольные строки.
    a = random.sample(word, len(word))  # получаем список перемешанных букв
    new_word = ''.join(a)  # объединяем элементы списка из букв в одну строку
    return new_word  # возвращаем анаграмму


def create_tsv_table(table_filename, words, n_anа):
    """Создает TSV-файл с именем table_filename со строками типа
    слово→анаграмма→анаграмма,...
    где список слов задается аргументом words, а число анаграмм — n_ana
    """
    with open(table_filename, 'w', encoding='utf-8') as f:  # открываем файл для записи
        for x in words:  # перебираем слова в переменной x
            f.write(x)  # запишем слово в файл
            for i in range(n_ana):  # n_ana раз создадим и запишем анаграмму
                f.write('t')  # запишем разделитель
                f.write(ana(x))  # запишем случайную анаграмму
            f.write('n')  # не забудем поставить символ конца строки перед следующей строкой

def main():
    words = words_from_file('text.txt')  # получаем список слов
    create_tsv_table('table.tsv', words, 3)  # создаем таблицу с тремя анаграммами в каждой строке


if __name__ == '__main__':
    main()

Домашнее задание

Пусть какая-то функция получает на вход список из 30 случайных целых чисел от 0 до 100, сгенерированных с помощью модуля random. В вариантах описана функция.

+1 балл для всех: ответьте коротко на вопрос “Почему модуль random на самом деле НЕ генерирует случайные числа?”

1. Функция берёт два случайных числа из этого списка (с помощью модуля random) и считает по ним количество всевозможных сочетаний этих чисел с точки зрения теории вероятности, С из n по k (использовать функцию из модуля math – factorial). Количество сочетаний (в формате float) печатается. k должно быть меньше n

2. Функция возвращает произведение значений списка. Нужно пользоваться модулем math. Руководствоваться надо тем, что exp(log(a) + log(b)) = a * b

3. Функция возвращает строку из 30 букв. Список, полученный на вход, задает порядок букв в строке по номеру буквы в алфавите.

4. Функция берёт из списка 4 случайных числа, условно принимает их за две точки в двумерном пространстве и возвращает евклидово расстояние между этими точками. Использовать модули random и math.

5. Функция перемешивает список с помощью random.shuffle(), сравнивает его с исходным списком и возвращает количество индексов, значение элемента по которым поменялось. Запустите функцию в цикле 100 раз и напечатайте в скольки процентов случаев меняются все элементы списка.

6. Функция возвращает среднее геометрическое списка. Вомпользуйтесь модулем math. Отдельно вне функции покажите, что ее результат лежит между минимальным и максимальным значениями списка для 20 случаев. (Для это нужно на каждой итерации генерировать подаваемый на вход список заново)

7. Функция возвращает среднее арифметическое элементов списка, округлённое вверх. Используйте модуль math.

Введение

Модули в Python – это файлы с расширением “.py”, написанные коды на языке Python. На любой файл написанный в Python можно ссылаться как на модуль.
Несколько модулей доступны после установки языка Python. Некоторые модули приходится устанавливать вручную.

Установку модулей вручную мы рассматривали в нашем руководстве про Импорт модулей в Python 3.
С помощью этого руководство вы поймёте как:

• Написать модуль;
•  Доступ к модулям из других директорий;
• Использование переменной среды;
• Модуль в переменной среде Python 3.

Подготовка к работе

У вас должен быть настроен дистрибутив под управлением Debian/Ubuntu/CentOS, настройка пользователя с правами sudo. Настроенная виртуальная среда языка Python. Рекомендуем заранее подготовиться перед приступлением к работе.

Написание и импортирование модулей

Первым делом стоит проверить версию Python с помощью:

python3 --version

На текущий момент актуальная версия 3.10.6. Если у вас старая версия, то обновите индекс пакетов и пакетов программного обеспечения с помощью:

sudo apt update && apt upgrade -y

Запустим виртуальную среду и с помощью текстового редактора Vim создадим новый файл с названием testingFile.py и добавим следующие строчки кода в самом начале указав шебанг. Шебанг – с помощью #! указываем путь к интерпретатору Python, подробнее рассмотрено в нашей инструкции.

#!/usr/bin/env python
# Определение функции
def test():
print(“This is test file”)

Если запустим с помощью:

python3 testingFile.py

То получим пустой результат. Необходимо создать второй файл и назовём test2.py и откроем с помощью vim и импортируем testingFile.py в файл test2.py и вызовем функцию test.

vim test2.py
#!/usr/bin/env python3
#Импорт файла
import testingFile
#Вызов функции из файла testingFile
testingFile.test()

Получим следующий результат, как на рисунке 1.

Мы импортируем модуль без использования “from testingFile import test”, нам необходимо вызывать функцию с помощью использованием названия модуля. Использование from … import можно рассмотреть в нашей инструкции.

Рассмотрим использование переменных в нашем модуле, добавим строчку в самом низу:

#!/usr/bin/env python3
# Определение функции
def test():
print("This is test file")
#Присвоение значения переменной
name = "serverspace"


Далее в файле test2.py в конце добавим строку изменив наш код в следующий вид:

#!/usr/bin/env python3
#Импорт файла
import testingFile
#Вызов функции из файла testingFile
testingFile.test()
#Вызов функции печати с использованием переменной
print(testingFile.name)

Результат приведён на рисунке 2.

Когда рассмотрели вызов функции печати и переменной, рассмотрим создание класса и добавим в класс несколько атрибутов использовав следующие команды.

#!/usr/bin/env python3
# Определение функции
def test():
print("This is test file")
#Присвоение значения переменной
name = "serverspace"
#Определение класса
class TestingClass:
def __init__ (self, name, age):
self.name = name
self.age = age
def tell_me_about_TestingClass(self):
print("this class is " + self.name + ".")
print(self.name + " is the testing's name")

Теперь с помощью файла test2.py вызовем функцию инициализации и информацию о классе:

#!/usr/bin/env python3
#Импорт модуля
import testingFile
#Вызов функции
testingFile.test()
#Вывод информации из другого модуля
print(testingFile.name)
#Вызов функций из класса
server = testingFile.TestingClass("testingserver", "30 y.o.")
server.tell_me_about_TestingClass()

Результат приведён на рисунке 3.

Для начала создаём переменную с названием “server”, вызываем класс из модуля testingFile.py, присваиваем значения для переменной name “testingserver” и значение “30 y.o.” для переменной age.

Важно иметь ввиду, что модуль является определением, но в то же время можно реализовывать код. Рассмотрим новый пример модуля в файле test3.py

#!/usr/bin/env python3
def TestHello():
print(“Testing Hello, World!”)
#Вызов функции в модуле
TestHello()

Импортируем модуль в файл test4.py и проверим вызов функции TestHello:

#!/usr/bin/env python3
import test3

Получим результат в соответствии с рисунком 4.

Причина простая, внутри файла test3.py, создаём функцию с названием TestHello и внутри него реализуем функцию печати текста. Затем вызываем созданную функцию и импортируем в файл test4.py. Таким образом с помощью запуска test4.py вызываем функцию печать текста из функции TestHello.

Доступ к модулям из других директорий

Иногда некоторые модули полезны не только для одного проекта, но и для других проектов. По этой причине не обязательно хранить модуль в одной директории проекта. Можно создать для общего использования и ссылаться на эту директорию использовав несколько методов.

Использование переменной среды

Если модуль находится вне проекта, используем модуль sys и с его помощи укажем путь к среде, где находится файл с нужным модулем. Например, находясь в домашней директории создав файл test5.py, мы не сможем импортировать файл test3.py, который находится в директории с виртуальной средой. Рассмотрим, как указывать путь к файлу test3.py:

import sys
sys.path.append(‘/root/testing/’)
import test3

И получим успешный результат, как показано на рисунке 5.

Успешный результат можем получить при указании правильного пути к файлу test3.

Модуль в переменной среде Python 3

Данный метод считается эффективным решением, модуль получает доступность для всей среды и системы. Проверим какой путь проверяет Python с помощью команд

python3
import sys
print(sys.path)

Получим в результате пути проверки интерпретатора Python, как показано на рисунке 6.

Выбираем нужный путь и скопируем файл test3.py в нужный путь.

cp testing/test3.py /usr/lib/python3.10
python3 test5.py

В файле test5.py удалим импортирование модуля sys. Запустим код:


cat test5.py # чтобы удостовериться, что строка с импортированием sys удалён либо закомментирован
python3 test5.py

Получим результат как на рисунке 7.

Копирование модуля в общий путь проверки интерпретатора Python оказалось наиболее эффективным. Причина в том, чтобы каждый раз не импортировать модуль sys в файлах кодов и указывать путь к нужному модулю, стоит скопировать нужный модуль в общий путь. Не стоит забывать о резервной копии нужных модулей, никто не исключает удаление нестандартных модулей после обновления пакетов Python.

Выводы

В данной инструкции мы рассмотрели такие возможности как:

• Создание модуля;
• Импортирование созданного модуля;
• Ссылаться на модуль с помощью импортирования модуля sys из находясь в другой директории;
• Добавление созданного модуля в общий путь интерпретатора Python;
• Получили информацию об общих путях при поиске модуля с помощью командного интерпретатора Python.