database_module #17

Merged
Miroslavsckaya merged 20 commits from database_interaction into master 2022-05-29 20:19:18 +00:00
2 changed files with 79 additions and 0 deletions

3
.gitignore vendored
View File

@ -3,3 +3,6 @@
# Python
/.venv
# Database
/*.db
skobkin marked this conversation as resolved Outdated

I think we'll have not only subscribers data in this database, so it's pretty safe to just call it something like database.db/bot.db/database.sqlite.

I think we'll have not only subscribers data in this database, so it's pretty safe to just call it something like `database.db`/`bot.db`/`database.sqlite`.

76
database.py Normal file
View File

@ -0,0 +1,76 @@
import sqlite3
"""
Classes:
Database - implement intercaction with the database.
"""
class Database():
"""Implement intercaction with the database."""
skobkin marked this conversation as resolved Outdated

subscribes

subscriptions

You can also add unique index on user_id, feed_id to make it impossible to accidentally subscribe one user to the same feed twice.
This index will also be automatically used when selecting feeds for user in the method returning user's feeds.

> `subscribes` `subscriptions` You can also add unique index on `user_id, feed_id` to make it impossible to accidentally subscribe one user to the same feed twice. This index will also be automatically used when selecting feeds for user in the method returning user's feeds.
def __init__(self, path: str) -> None:
"""Create a database file if not exists."""
self.conn = sqlite3.connect(path)
self.cur = self.conn.cursor()
self.cur.execute('CREATE TABLE IF NOT EXISTS users (id INTEGER, telegram_id NUMERIC NOT NULL UNIQUE, PRIMARY KEY(id))')
self.cur.execute('CREATE TABLE IF NOT EXISTS feeds (id INTEGER, url TEXT NOT NULL UNIQUE, PRIMARY KEY(id))')
self.cur.execute('CREATE TABLE IF NOT EXISTS subscriptions (user_id INTEGER, feed_id INTEGER, UNIQUE (user_id, feed_id), FOREIGN KEY(user_id) REFERENCES users(id), FOREIGN KEY(feed_id) REFERENCES feeds(id))')
self.cur.execute('CREATE TABLE IF NOT EXISTS feeds_last_items (feed_id INTEGER, url TEXT NOT NULL UNIQUE, title TEXT, description TEXT, date NUMERIC, FOREIGN KEY(feed_id) REFERENCES feeds(id))')
def add_user(self, telegram_id: str) -> int:
"""Add a user's telegram id to the database and return its database id."""
self.cur.execute('INSERT INTO users (telegram_id) VALUES (?)', [telegram_id])
self.conn.commit()
return self.cur.lastrowid
skobkin marked this conversation as resolved Outdated

It's better to have consistency in the code style.

Here you have trailing comma, but you don't have it in the subscribe_user() in the list of parameters.
So either remove it here, or add it there.

This is not critical in this project in any way. But in real projects such rules are enforced and CI most likely will reject your code if it's not following team guidelines. But you likely will have tools to check if your code is following the rules of the company/team/project.

I just didn't setup anything like that here 🤷 We only have pylama here 😄

It's better to have consistency in the code style. Here you have trailing comma, but you don't have it in the `subscribe_user()` in the list of parameters. So either remove it here, or add it there. This is not critical in this project in any way. But in real projects such rules are enforced and CI most likely will reject your code if it's not following team guidelines. But you likely will have tools to check if your code is following the rules of the company/team/project. I just didn't setup anything like that here 🤷 We only have `pylama` here 😄
def find_user(self, telegram_id: str) -> int | None:
"""Get a user's telegram id and return its database id."""
self.cur.execute('SELECT id FROM users WHERE telegram_id = ?', [telegram_id])
row = self.cur.fetchone()
if row is None:
return None
return row[0]
def add_feed(self, url: str) -> int:
"""Add a feed to the database and return its id."""
self.cur.execute('INSERT INTO feeds (url) VALUES (?)', [url])
self.conn.commit()
return self.cur.lastrowid
def subscribe_user(self, user_id: int, feed_id: int) -> None:
"""Subscribe a user to the feed."""
self.cur.execute('INSERT INTO subscriptions (user_id, feed_id) VALUES (?, ?)', [user_id, feed_id])
self.conn.commit()
def unsubscribe_user(self, user_id: int, feed_id: int) -> None:
skobkin marked this conversation as resolved Outdated

subscribes is a verb. "User subscribes to the feed".

It's better to use "subscriptions" here.

`subscribes` is a verb. "User subscribes to the feed". It's better to use "subscriptions" here.

By the way as you're selecting not subscriptions themselves but the feeds user subscribed to it could be better to call this something like get_user_feeds() or even find_user_feeds().

By the way as you're selecting not subscriptions themselves but the feeds user subscribed to it could be better to call this something like `get_user_feeds()` or even `find_user_feeds()`.
"""Unsubscribe a user from the feed."""
self.cur.execute('DELETE FROM subscriptions WHERE feed_id = ? AND user_id = ?', [feed_id, user_id])
self.conn.commit()
def delete_feed(self, feed_id: int) -> None:
"""Delete a feed."""
self.cur.execute('DELETE FROM feeds WHERE id = ?', [feed_id])
self.conn.commit()
def find_feeds(self) -> list:
"""Get a list of feeds."""
self.cur.execute('SELECT * FROM feeds')
return self.cur.fetchall()
def find_user_feeds(self, user_id: int) -> list:
"""Return a list of feeds the user is subscribed to."""
self.cur.execute('SELECT * FROM feeds WHERE id IN (SELECT feed_id FROM subscriptions WHERE user_id = ?)', [user_id])
return self.cur.fetchall()
def find_feed_items(self, feed_id: int) -> list:
"""Get last feed items."""
self.cur.execute('SELECT * FROM feeds_last_items WHERE feed_id = ?', [feed_id])
return self.cur.fetchall()
def update_feed_items(self, feed_id: int, new_items: list) -> None:
"""Replace last feed items with a list items that receive."""
for i in range(len(new_items)):
new_items[i] = (feed_id,) + new_items[i]
self.cur.execute('DELETE FROM feeds_last_items WHERE feed_id = ?', [feed_id])
self.cur.executemany('INSERT INTO feeds_last_items (feed_id, url, title, description, date) VALUES (?, ?, ?, ?, ?)', new_items)
self.conn.commit()