Skip to content

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

59 Commits

Folders and files

Repository files navigation

SP_project

Данный ReadMe предназначен для разработчиков парсеров.

Для работы с базой данных(далее - БД) я написал для вас следующие классы:

SPTable

Данный класс предназначен для простых таблиц БД, имеющих два атрибута, таких как ID(типа Integer) и Title(типа Text или Varchar), т.к. таких таблиц достаточно много в БД.

Импорт класса

Для взаимодействия с данным классом необходимо в самом парсере его импортировать

from PyScripts.TableClasses.PublicClasses.SPTable import SPTable

Объявление

Для того, чтобы работать с самим классом, необходимо объявить его объект. Класс SPTable принимает следующие аргументы:

  • table_name - Название таблицы в БД
  • table_title - Название колонны title этой таблицы
  • cur - объект для взаимодействия с БД (получается из parser_init())
  • conn - аналогично cur
  • schema - Необязательный аргумент, если вы работаете с таблицы из public схемы

Методы класса SPTable

Название метода Его устройство
get_id_by_name(title) Возвращает id объекта по его title, иначе False
get_name_by_id(id) Возвращает title объекта по его id, иначе False
add(title) Проверяет на наличие и вносит новое значение в таблицу, вовращает id объекта в любом случае
delete(title/id) Удаляет значение из таблицы по title или id(по id желательно)
commit() Подтверждение изменений, таких как add и delete

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

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

img.png

Мы понимаем, что она подходит условиям класса SPTable и создаем объект этого класса (не заполняем аргумент schema, т.к. она public)

ResponseObj = SPTable('response_obj', 'response_obj', cur, conn)

Внести новый объект в таблицу можно так:

ResponseObj.add(title)

ВАЖНО: Метод add проверяет на наличие данный объект в таблице, и НЕ будет его вносить, если он там уже присутствует. А id будет прописан АВТОМАТИЧЕСКИ

Если нам необходим id созданного объекта, мы можем после добавления ее получить с помощью метода get_id_by_name(title) или же сразу получить при внесении в таблицу:

id = ResponseObj.add(title) # Получили id сразу
id = ResponseObj.get_id_by_name(title) # Получили id через метод

С помощью же get_name_by_id(id) мы можем получить title объекта по id

title = ResponseObj.get_name_by_id(id)

SPTableArbitrary

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

Импорт класса

Для взаимодействия с данным классом необходимо в самом парсере его импортировать

from PyScripts.TableClasses.PublicClasses.SPTableArbitrary import SPTableArbitrary

Объявление

Для того, чтобы работать с самим классом, необходимо объявить его объект. Класс SPTable принимает следующие аргументы:

  • table_name - Название таблицы в БД
  • table_title - Название колонны title этой таблицы
  • cur - объект для взаимодействия с БД (получается из parser_init())
  • conn - аналогично cur
  • schema - Необязательный аргумент, если вы работаете с таблицы из public схемы

Методы класса SPTableArbitrary

Название метода Его устройство
get_id_by_name(title) Возвращает id объекта по его title, иначе False
get_by_id(id) Возвращает список всех элементов объекта по его id, иначе False
add(title) Проверяет на наличие и вносит новое значение в таблицу, возвращает id объекта в любом случае
delete(title/id) Удаляет значение из таблицы по title или id(по id желательно)
commit() Подтверждение изменений, таких как add и delete
get_name_by_id(id) НЕ РАБОТАЕТ ДЛЯ ДАННОГО КЛАССА И ВЫЗОВЕТ ОШИБКУ, ЧТО ЗАВЕРШИТ ПРОГРАММУ

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

Возьмем в пример таблицу контрольных событий за 2020 год отрасли Развития образования. Её структура выглядит следующим образом:

img.png

Мы понимаем, что она не удовлетворят условиям класса SPTable и создаем объект класса SPTableArbitrary (заполняем аргумент schema, т.к. она из Education)

ControlEvent2020 = SPTableArbitrary('control_event2020', 'control_event', cur, conn, schema='Education')

Внести новый объект в таблицу можно так:

ControlEvent2020.add(id, title1, title2, title3...)

ВАЖНО: Метод add проверяет на наличие данный объект в таблице, и НЕ будет его вносить, если он там уже присутствует. А id НЕ будет прописан АВТОМАТИЧЕСКИ

Если нам необходим id созданного объекта, мы можем после добавления ее получить с помощью метода get_id_by_name(title) или же сразу получить при внесении в таблицу:

id = ControlEvent2020.add(id, title1, title2, title3...) # Получили id сразу
id = ControlEvent2020.get_id_by_name(title) # Получили id через метод

С помощью же get_by_id(id) мы можем получить список элементов объекта по id

title = ResponseObj.get_name_by_id(id)

ВАЖНО: get_name_by_id(id) НЕ работает для данного класса и выдаст ошибку

По любым вопросам касательно этих классов и кода писать https://vk.com/g4st3r7

В дальнейшем эти классы будут дорабатываться и обновляться.

Спасибо за внимание и приятного кодинга)

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages