dublib 0.5.2__tar.gz → 0.6.1__tar.gz

{dublib-0.5.2/src/dublib.egg-info → dublib-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dublib
-Version: 0.5.2
+Version: 0.6.1
 Summary: Коллекция модулей от DUB1401.
 Author-email: DUB1401 <vlad.milosta@outlook.com>
 License: This is free and unencumbered software released into the public domain.
@@ -49,6 +49,8 @@ Requires-Dist: fake_useragent
 Requires-Dist: httpx
 Requires-Dist: httpx[http2]
 Requires-Dist: requests
+Provides-Extra: telebot
+Requires-Dist: pyTelegramBotAPI; extra == "telebot"
 
 # dublib
 **dublib** – это библиотека, поставляющая компоненты, требующиеся в проектах [@DUB1401](https://github.com/DUB1401), написанных на Python.
@@ -58,6 +60,7 @@ Requires-Dist: requests
 * [Methods](https://github.com/DUB1401/dublib/blob/main/docs/Methods.md)
 * [Polyglot](https://github.com/DUB1401/dublib/blob/main/docs/Polyglot.md)
 * [StyledPrinter](https://github.com/DUB1401/dublib/blob/main/docs/StyledPrinter.md)
+* [TelebotUtils](https://github.com/DUB1401/dublib/blob/main/docs/Terminalyzer.md)
 * [Terminalyzer](https://github.com/DUB1401/dublib/blob/main/docs/Terminalyzer.md)
 * [WebRequestor](https://github.com/DUB1401/dublib/blob/main/docs/WebRequestor.md)
 

{dublib-0.5.2 → dublib-0.6.1}/README.md

@@ -6,6 +6,7 @@
 * [Methods](https://github.com/DUB1401/dublib/blob/main/docs/Methods.md)
 * [Polyglot](https://github.com/DUB1401/dublib/blob/main/docs/Polyglot.md)
 * [StyledPrinter](https://github.com/DUB1401/dublib/blob/main/docs/StyledPrinter.md)
+* [TelebotUtils](https://github.com/DUB1401/dublib/blob/main/docs/Terminalyzer.md)
 * [Terminalyzer](https://github.com/DUB1401/dublib/blob/main/docs/Terminalyzer.md)
 * [WebRequestor](https://github.com/DUB1401/dublib/blob/main/docs/WebRequestor.md)
 

{dublib-0.5.2 → dublib-0.6.1}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "cython"]
 
 [project]
 name = "dublib"
-version = "0.5.2"
+version = "0.6.1"
 description = "Коллекция модулей от DUB1401."
 authors = [
 	{name = "DUB1401", email = "vlad.milosta@outlook.com"}
@@ -30,8 +30,13 @@ classifiers = [
 	"Programming Language :: Python :: 3.13"
 ]
 
+[project.optional-dependencies]
+telebot = [
+    "pyTelegramBotAPI"
+]
+
 [project.urls]
 Documentation = "https://github.com/DUB1401/dublib/tree/main/docs"
 "Source Code" = "https://github.com/DUB1401/dublib"
 "Bug Tracker" = "https://github.com/DUB1401/dublib/issues"
-Changelog = "https://github.com/DUB1401/dublib/releases"
+Changelog = "https://github.com/DUB1401/dublib/releases"

dublib-0.6.1/src/dublib/Exceptions/TelebotUtils.py

@@ -0,0 +1,13 @@
+class UpdateByOtherUser(Exception):
+	"""Исключение: использование данных другого пользователя для обновления."""
+
+	def __init__(self):
+		"""Исключение: использование данных другого пользователя для обновления."""
+
+		# Добавление данных в сообщение об ошибке.
+		self.__Message = "Current user ID and ID in updating method differ."
+		# Обеспечение доступа к оригиналу наследованного свойства.
+		super().__init__(self.__Message) 
+			
+	def __str__(self):
+		return self.__Message

{dublib-0.5.2 → dublib-0.6.1}/src/dublib/Methods.py

@@ -96,6 +96,41 @@ def CheckForCyrillicPresence(text: str) -> bool:
 
 	return IsTextContainsCyrillicCharacters
 
+def ChunkList(value: list, length: int) -> list[list]:
+	"""
+	Разделяет список на фрагменты фиксированной длинны.
+		value – обрабатываемое значение;
+		length – длина фрагментов.
+	"""
+
+	# Список списков.
+	Result = list()
+	# Индекс обрезки.
+	CutIndex = 1
+	# Буфер обрезки.
+	Buffer = list()
+
+	# Для каждого элемента.
+	for Index in range(len(value)):
+
+		# Если индекс обрезки совпадает с длиной.
+		if CutIndex == length:
+			# Запись и обнуление буфера.
+			Result.append(Buffer)
+			Buffer = list()
+
+		else:
+			# Запись элемента в буфер.
+			Buffer.append(value[Index])
+
+		# Инкремент индекса обрезки.
+		CutIndex += 1
+
+	# Если в буфере что-то осталось, записать отдельной строкой.
+	if len(Buffer) > 0: Result.append(Buffer)
+
+	return Result
+
 def IsNotAlpha(text: str) -> bool:
 	"""
 	Проверяет, состоит ли строка целиком из небуквенных символов.

dublib-0.6.1/src/dublib/TelebotUtils.py

@@ -0,0 +1,406 @@
+from .Methods import ReadJSON, WriteJSON
+from .Exceptions.TelebotUtils import *
+
+from telebot.types import User
+
+import os
+
+#==========================================================================================#
+# >>>>> УПРАВЛЕНИЕ ПОЛЬЗОВАТЕЛЯМИ <<<<< #
+#==========================================================================================#
+
+class UserData:
+	"""Объектное представление данных пользователя."""
+
+	#==========================================================================================#
+	# >>>>> СВОЙСТВА ТОЛЬКО ДЛЯ ЧТЕНИЯ <<<<< #
+	#==========================================================================================#
+
+	@property
+	def id(self) -> int:
+		"""ID пользователя."""
+
+		return self.__ID
+
+	@property
+	def is_premium(self) -> bool:
+		"""Состояние: есть ли Premium-подписка у пользователя."""
+
+		return self.__Data["premium"]
+
+	@property
+	def language(self) -> str:
+		"""Код используемого клиентом языка по стандарту ISO 639-1."""
+
+		return self.__Data["language"]
+
+	@property
+	def permissions(self) -> list:
+		"""Список прав доступа пользователя."""
+
+		return self.__Data["permissions"]
+
+	@property
+	def username(self) -> str:
+		"""Ник пользователя."""
+
+		return self.__Data["username"]
+
+	#==========================================================================================#
+	# >>>>> ПРИВАТНЫЕ МЕТОДЫ <<<<< #
+	#==========================================================================================#
+
+	def __SaveData(self):
+		"""Записывает данные в локальный файл."""
+
+		# Запись локального файла.
+		WriteJSON(self.__StorageDirectory + f"/{self.__ID}.json", self.__Data)
+
+	#==========================================================================================#
+	# >>>>> ПУБЛИЧНЫЕ МЕТОДЫ <<<<< #
+	#==========================================================================================#
+
+	def __init__(self, storage_dir: str, user_id: int, data: dict | None = None):
+		"""
+		Объектное представление данных пользователя.
+			storage_dir – путь к директории хранения данных;
+			user_id – ID пользователя;
+			data – словарь с описанием данных пользователя для инициализации (если не передан, данные будут загружены из файла).
+		"""
+
+		#---> Генерация динамических свойств.
+		#==========================================================================================#
+		# ID пользователя.
+		self.__ID = user_id
+		# Директория хранилища.
+		self.__StorageDirectory = storage_dir.replace("\\", "/").rstrip("/")
+		# Словарное представление данных пользователя.
+		self.__Data = {
+			"username": None,
+			"language": None,
+			"is_premium": None,
+			"permissions": [],
+			"data": {}
+		}
+
+		# Если переданы данные в виде словаря.
+		if type(data) == dict:
+			# Копирование данных.
+			self.__Data = data
+
+		# Если переданы данные в виде объекта.
+		elif type(data) == User:
+			# Обновление данных.
+			self.update(data)
+
+		# Если существует локальный файл.
+		elif os.path.exists(self.__StorageDirectory + f"/{user_id}.json"):
+			# Чтение файла.
+			self.__Data = ReadJSON(self.__StorageDirectory + f"/{user_id}.json")
+
+		# Создание файла.
+		else:
+			# Сохранение данных.
+			WriteJSON(self.__StorageDirectory + f"/{user_id}.json", self.__Data)
+
+	def add_permissions(self, permissions: list[str] | str):
+		"""
+		Задаёт разрешения.
+			permissions – разрешения.
+		"""
+
+		# Если указано одно разрешение, преобразовать в список.
+		if type(permissions) == str: permissions = [permissions]
+		# Состояние: изменялся ли список разрешений.
+		IsChanged = False
+
+		# Для каждого разрешения.
+		for Permission in permissions:
+
+			# Если разрешение не определено.
+			if Permission not in self.__Data["permissions"]:
+				# Добавление разрешения.
+				self.__Data["permissions"].append(Permission)
+				# Переключение состояния.
+				IsChanged = True
+
+		# Если список разрешений изменён, отсортировать его.
+		if IsChanged: self.__Data["permissions"] = sorted(self.__Data["permissions"])
+		# Сохранение данных.
+		self.__SaveData()
+
+	def create_property(self, key: str, value: any):
+		"""
+		Создаёт свойство пользователя и задаёт ему значение, если такового ещё не существует.
+			key – ключ свойства;
+			value – значение.
+		"""
+		
+		# Если свойства не существует.
+		if key not in self.__Data["data"].keys():
+			# Создание свойства.
+			self.__Data["data"][key] = value
+			# Сохранение данных.
+			self.__SaveData()
+
+	def get_property(self, key: str) -> any:
+		"""
+		Возвращает значение свойства пользователя.
+			key – ключ свойства.
+		"""
+
+		return self.__Data["data"][key]
+
+	def has_permissions(self, permissions: list[str] | str) -> bool:
+		"""
+		Проверяет, имеет ли пользователь все перечисленные разрешения.
+			permissions – разрешения.
+		"""
+
+		# Если указано одно разрешение, преобразовать в список.
+		if type(permissions) == str: permissions = [permissions]
+		# Состояние: имеет ли пользователь все указанные разрешения.
+		IsOwned = True
+
+		# Для каждого разрешения.
+		for Permission in permissions:
+
+			# Если разрешение не определено, переключить состояние.
+			if Permission not in self.__Data["permissions"]: IsOwned = False
+
+		return IsOwned
+
+	def remove(self):
+		"""Удаляет локальный файл пользователя."""
+
+		# Удаление локального файла.
+		os.remove(self.__StorageDirectory + f"/{self.__ID}.json")
+
+	def remove_permissions(self, permissions: list[str] | str):
+		"""
+		Удаляет разрешения.
+			permissions – разрешения.
+		"""
+
+		# Если указано одно разрешение, преобразовать в список.
+		if type(permissions) == str: permissions = [permissions]
+
+		# Для каждого разрешения.
+		for Permission in permissions:
+
+			# Если разрешение определено.
+			if Permission in self.__Data["permissions"]:
+				# Удаление разрешения.
+				self.__Data["permissions"].remove(Permission)
+
+		# Сохранение данных.
+		self.__SaveData()
+
+	def remove_property(self, key: str):
+		"""
+		Удаляет свойство пользователя.
+			key – ключ свойства.
+		"""
+
+		# Если свойство существует.
+		if key in self.__Data["data"].keys():
+			# Удаление свойства.
+			del self.__Data["data"][key]
+			# Сохранение данных.
+			self.__SaveData()
+
+	def set_property(self, key: str, value: any):
+		"""
+		Обновляет значение существующего свойства пользователя.
+			key – ключ свойства;
+			value – значение.
+		"""
+		
+		# Если свойство существует.
+		if key in self.__Data["data"].keys():
+			# Обновление данных.
+			self.__Data["data"][key] = value
+			# Сохранение данных.
+			self.__SaveData()
+
+	def update(self, user: User):
+		"""
+		Обновляет данные пользователя из параметров, содержащихся в сообщении.
+			user – объект представления пользователя.
+		"""
+
+		# Если ID соответствует.
+		if user.id == self.__ID:
+			# Обновление данных.
+			self.__Data["is_premium"] = bool(user.is_premium)
+			self.__Data["language"] = user.language_code
+			self.__Data["username"] = user.username
+			# Сохранение файла.
+			self.__SaveData()
+
+		else: raise UpdateByOtherUser()
+
+class UsersManager:
+	"""Менеджер пользователей."""
+
+	#==========================================================================================#
+	# >>>>> СВОЙСТВА ТОЛЬКО ДЛЯ ЧТЕНИЯ <<<<< #
+	#==========================================================================================#
+
+	@property
+	def admins(self) -> list[UserData]:
+		"""Список пользователей с правами администратора."""
+
+		# Список администраторов.
+		Admins = list()
+
+		# Для каждого пользователя.
+		for UserID in self.__Users.keys():
+			# Добавление пользователя в список.
+			if self.__Users[UserID].is_admin: Admins.append(self.__Users[UserID])
+
+		return Admins
+
+	@property
+	def premium_users(self) -> list[UserData]:
+		"""Список пользователей с Premium подпиской."""
+
+		# Список подписчиков.
+		PremiumUsers = list()
+
+		# Для каждого пользователя.
+		for UserID in self.__Users:
+			# Добавление пользователя в список.
+			if self.__Users[UserID].is_premium: PremiumUsers.append(self.__Users[UserID])
+
+		return PremiumUsers
+
+	@property
+	def users(self) -> list[UserData]:
+		"""Список пользователей."""
+
+		# Список пользователей.
+		Users = list()
+		# Для каждого пользователя записать значение в список.
+		for UserID in self.__Users.keys(): Users.append(self.__Users[UserID])
+
+		return Users
+
+	#==========================================================================================#
+	# >>>>> МЕТОДЫ <<<<< #
+	#==========================================================================================#
+
+	def __LoadUsers(self):
+		"""Загружает данные пользователей."""
+
+		# Получение списка файлов в директории пользователей.
+		Files = os.listdir(self.__StorageDirectory)
+		# Фильтрация только файлов формата JSON.
+		Files = list(filter(lambda List: List.endswith(".json"), Files))
+
+		# Для каждого файла.
+		for File in Files:
+			# Чтение файла.
+			Buffer = ReadJSON(self.__StorageDirectory + f"/{File}")
+			# ID пользователя.
+			UserID = int(File.replace(".json", ""))
+			# Запись пользовательских данных.
+			self.__Users[UserID] = UserData(self.__StorageDirectory, UserID, Buffer)
+
+	def __init__(self, dir: str):
+		"""
+		Менеджер пользователей.
+			dir – путь к директории хранения данных.
+		"""
+
+		#---> Генерация динамических свойств.
+		#==========================================================================================#
+		# Словарь пользователей.
+		self.__Users = dict()
+		# Директория хранилища.
+		self.__StorageDirectory = dir.replace("\\", "/").rstrip("/")
+
+		# Если директория пользователей не существует, создать её.
+		if not os.path.exists(self.__StorageDirectory): os.makedirs(self.__StorageDirectory)
+		# Загрузка данных пользователей.
+		self.__LoadUsers()
+
+	def auth(self, user: User) -> UserData:
+		"""
+		Выполняет идентификацию и обновление данных существующего пользователя или создаёт локальный файл для нового.
+			user – структура описания пользователя Telegram.
+		"""
+		
+		# Текущий пользователь.
+		CurrentUser = None
+
+		# Если пользователь ещё не существует.
+		if user.id not in self.__Users.keys():
+			# Создание нового пользователя.
+			self.__Users[user.id] = UserData(self.__StorageDirectory, user.id, user)
+
+		# Обновление данных пользователя.
+		self.__Users[user.id].update(user)
+		# Установка текущего пользователя.
+		CurrentUser = self.__Users[user.id]
+
+		return CurrentUser
+
+	def get_user(self, user_id: int | str) -> UserData:
+		"""
+		Возвращает объект данных пользователя.
+			user_id – ID пользователя.
+		"""
+		
+		return self.__Users[int(user_id)]
+
+	def get_users(self, include_permissions: list[str] | str | None = None, exclude_permissions: list[str] | str | None = None) -> list[UserData]:
+		"""
+		Возвращает список пользователей, подходящих под переданные фильтры. По умолчанию возвращает список всех пользователей.
+			include_permissions – разрешения, которыми должен обладать пользователь;
+			exclude_permissions – разрешения, которых у пользователя быть не должно.
+		"""
+
+		# Копирование списка пользователей.
+		Users = self.users
+
+		# Если переданы включения разрешений для фильтрации.
+		if include_permissions:
+			# Буфер фильтрации.
+			Buffer = list()
+
+			# Для каждого пользователя.
+			for User in Users: 
+				# Если пользователь имеет все указанные разрешения, записать его.
+				if User.has_permissions(include_permissions): Buffer.append(User)
+
+			# Перезапись списка пользователей буфером.
+			Users = Buffer
+
+		# Если переданы исключения разрешений для фильтрации.
+		if exclude_permissions:
+			# Буфер фильтрации.
+			Buffer = list()
+
+			# Для каждого пользователя.
+			for User in Users: 
+				# Если пользователь не имеет все указанные разрешения, записать его.
+				if not User.has_permissions(exclude_permissions): Buffer.append(User)
+
+			# Перезапись списка пользователей буфером.
+			Users = Buffer
+
+		return Users
+
+	def remove_user(self, user_id: int | str):
+		"""
+		Удаляет пользователя из системы.
+			user_id – ID пользователя.
+		"""
+
+		# Приведение ID пользователя к целочисленному.
+		user_id = int(user_id)
+		# Удаление локального файла.
+		self.__Users[user_id].remove()
+		# Удаление объекта.
+		del self.__Users[user_id]

{dublib-0.5.2 → dublib-0.6.1/src/dublib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dublib
-Version: 0.5.2
+Version: 0.6.1
 Summary: Коллекция модулей от DUB1401.
 Author-email: DUB1401 <vlad.milosta@outlook.com>
 License: This is free and unencumbered software released into the public domain.
@@ -49,6 +49,8 @@ Requires-Dist: fake_useragent
 Requires-Dist: httpx
 Requires-Dist: httpx[http2]
 Requires-Dist: requests
+Provides-Extra: telebot
+Requires-Dist: pyTelegramBotAPI; extra == "telebot"
 
 # dublib
 **dublib** – это библиотека, поставляющая компоненты, требующиеся в проектах [@DUB1401](https://github.com/DUB1401), написанных на Python.
@@ -58,6 +60,7 @@ Requires-Dist: requests
 * [Methods](https://github.com/DUB1401/dublib/blob/main/docs/Methods.md)
 * [Polyglot](https://github.com/DUB1401/dublib/blob/main/docs/Polyglot.md)
 * [StyledPrinter](https://github.com/DUB1401/dublib/blob/main/docs/StyledPrinter.md)
+* [TelebotUtils](https://github.com/DUB1401/dublib/blob/main/docs/Terminalyzer.md)
 * [Terminalyzer](https://github.com/DUB1401/dublib/blob/main/docs/Terminalyzer.md)
 * [WebRequestor](https://github.com/DUB1401/dublib/blob/main/docs/WebRequestor.md)
 

{dublib-0.5.2 → dublib-0.6.1}/src/dublib.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 src/dublib/Methods.py
 src/dublib/Polyglot.py
 src/dublib/StyledPrinter.py
+src/dublib/TelebotUtils.py
 src/dublib/Terminalyzer.py
 src/dublib/WebRequestor.py
 src/dublib/__init__.py
@@ -13,6 +14,7 @@ src/dublib.egg-info/dependency_links.txt
 src/dublib.egg-info/requires.txt
 src/dublib.egg-info/top_level.txt
 src/dublib/Exceptions/StyledPrinter.py
+src/dublib/Exceptions/TelebotUtils.py
 src/dublib/Exceptions/Terminalyzer.py
 src/dublib/Exceptions/WebRequestor.py
 src/dublib/Exceptions/__init__.py

{dublib-0.5.2 → dublib-0.6.1}/src/dublib.egg-info/requires.txt

@@ -3,3 +3,6 @@ fake_useragent
 httpx
 httpx[http2]
 requests
+
+[telebot]
+pyTelegramBotAPI