Как работать с БД из другого класса?

Question

[Stas_VTK]

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

work.py

import db
class SomeJob:
   # часть телеграм бота, запущена постоянно,
   #  ждет сообщения
   ..........
   async def handle_update(....)
      # пришло сообщение, обрабатывается
      # необходимо выполнить запрос к ms sql серверу
      request = db.Sql()
      msg = request.result("строка-параметр")
      ...........
      await ... отправили сформированное сообщение
      что происходит с объектом request в этот момент?

db.py

import pyodbc
import ......

class Sql:
   def __init__(self, param: str):
      self.param = param
      self.connect_str = "....."
      self.conn = pyodbc.connect(connect_str)
      self.cursor = conn.cursor()
   
   def result(self.param):
	# тут анализируется self.param и на его основании выполняется запрос
        sql_str = "......"
        self.cursor.execute(sql_str)
        ...........................
        # завершение обработки
        self.cursor(close)
        self.conn(close)
        return(результат запроса)

Comments

[Александр Нестеров]

Оформите код согласно правилам ресурса.

[Stas_VTK]

Александр Нестеров, так я его отредактировал уже, может вы первый вариант видели? Или просто скажите, чего там не хватает - я поправлю

[Александр Нестеров]

вы первый вариант видели?

Именно его.

Answer 1

[Сергей П]

Из приведённого кода не понятно для чего вообще выделен класс Sql.
Фактически вы используете только один метод этого класса, а содержимое конструктора можно разместить в том же методе.
Бессмысленно и беспощадно.
Самое правильное - это делать всё как можно проще.
Вот два очень полезных принципа в разработке:
- https://ru.wikipedia.org/wiki/KISS_(принцип)
- https://ru.wikipedia.org/wiki/Бритва_Оккама

В приведённом вами куске кода не нужен класс sql, достаточно сделать всё внутри одной функции, ведь вы не используете созданный обьект больше никак.
Другой вопрос, если вам нужно делать много запросов в рамках одного подключения к БД. На подключение тратяся некоторые накладные расходы по времени и трафику, иногда логично вынести подключение и хранить его в выделенном персистентном состоянии, которое будет создано один раз и переиспольовано для множества запросов. В этом случае закрывать коннект после запроса нельзя.
Прочитайте вот: https://pavel-karateev.gitbook.io/intermediate-pyt...
Обычно коннект к БД уже является менеджером контекста. Для чего вы делаете вот эту бессмысленную обёртку вокруг - не ясно.
В соответствии с хоошим стилем прогаммирования нужно, чтобы действие любой функции можно было охарактеризовать простой короткой фразой без союзов, без "и" и "или", без "если".
Иначе эту функцию стоило бы разбить на более мелкие и простые функции.
Вот ознакомьтесь с концепцией чистой функции: https://dvmn.org/encyclopedia/clean_code/decomposi...

Comments

[Stas_VTK]

Я не стал описывать более подробно. Но в двух словах: в work.py описаны класы, которые создаются на каждое сообщение и собираются в очередь. Их м.б. много, но не всем нужны данные из sql сервера. При обработке очереди сообщений если необходимы эти данные тогда и создается экземпляр Sql и конкретно это сообщение получает данные. Ввиду этого я и вынес работу с бд отдельно.
А то, что в классе всего один метод - пусть будет:) Я, как бы, учусь еще этому и проверяю - как и что работает. И, кстати, та логика, что описана мной в вопросе - работает!!! Правда чуток запутался с self, но потом разгадал! Спасибо за ссылки.

[Сергей П]

Правильность программы определяется не только её работоспособностью. В первую очередь вы пишете программу не для компьютера, а для человека, который будет её читать с различными целями от ревью до дебага, от рефакторинга до внедрения новых фич. Комп умеет понимать всякую кашу вроде машинных кодов или кода на брейнфаке, а все эти ООП, языки высокого уровня с утиной типизацией, синтаксический сахар - всё это чделано для людей, чтобы разделять сложность на части и что никто не подавился.

но не всем нужны данные из sql сервера.

Не сочтите меня душнилой занудным, но что вы называете "данными" в этом контексте? Данные лежат в БД, вы не храните их ни в классе ни в его экземпляре.
В данном случае вы просто написали лишнего кода и наделали лишних структур. Тут не нужен класс, достаточно функции в отдельном модуле.
Писаь код "про запас" с рассчетом, что он когда-нибудь пригодится - это одна из типичных ошибок новичка.
Читайте больше чужого хорошего кода, чтобы учиться писать свой.

Answer 2

[Давид Чак]

Посмотри в сторону паттерна singleton, смысл его ипользования в создании единого экземпляра и использования этого экземпляра везде где нужно!
Должно получиться что-то типо такого, останется дописать методы выполнения запроса

import sqlite3

class Db(object):
  
    def __new__(cls, *args, **kwargs):
        if not hasattr(cls, 'instance') or not cls.instance:
          cls.instance = super().__new__(cls)
        return cls.instance

    def __init__(self, connection_args):
        self.connector = sqlite3.connect(connection_args)

Comments

[Сергей П]

Мне кажется рано учить новичка плохому. У него и так оверинженеринг. Делает классы ради классов, сораняет состояние там, где оно не нужно, переусложняет.
Для его примера не требтся выносить работу с БД в отдельный класс.
В большинстве случаев достаточно сделать один коннект при инициализации приложения и хранитьего в контексте Application, что уже есть у бота. Причем объект, который возвращает pyodbc.connect, уже достаточно хорош для этого. Зачем его заворачивать в сотню тонких и бессмысленных обёрточек? Чтобы понизить прозрачность и читаемость кода?

[Stas_VTK]

Спасибо. Пока ваш совет несколько сложен для моего понимания. Почему я вынес работу с бд отдельно? Я не хочу держать коннект постоянно. Если запросов к боту (требующих работы с бд) нет - то и коннект не нужен. С другой стороны - если их много, то будет много коннектов. Возможно это плохо, но (пока!) пусть с этим разбирается ms sql server.:)

[Сергей П]

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