dublib 0.2.0__tar.gz → 0.3.0__tar.gz

{dublib-0.2.0/src/dublib.egg-info → dublib-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dublib
-Version: 0.2.0
+Version: 0.3.0
 Summary: Коллекция модулей от DUB1401.
 Author-email: DUB1401 <vlad.milosta@outlook.com>
 License: This is free and unencumbered software released into the public domain.
@@ -54,8 +54,26 @@ Requires-Dist: requests
 # Поставляемые компоненты
 Библиотека включает следующие модули:
 * [Methods](docs/Methods.md)
-* [Terminalyzer](docs/Terminalyzer.md)
+* [Polyglot](docs/Polyglot.md)
 * [StyledPrinter](docs/StyledPrinter.md)
+* [Terminalyzer](docs/Terminalyzer.md)
 * [WebRequestor](docs/WebRequestor.md)
 
-_Copyright © DUB1401. 2023._
+# Установка
+Библиотека поддерживает установку из двух типов репозиториев:
+* **PyPI** – стабильные выпуски (с возможностью выбора конкретной версии);
+* **GitHub** – канал разработки со всеми последними изменениями и исправлениями.
+
+_**Примечание:**_ Для установки библиотеки из репозитория GitHub на вашем устройстве должна присутствовать система контроля версий Git.
+```
+# Установка из PyPi.
+pip install dublib
+
+# Установка конкретной версии из PyPi.
+pip install dublib=={version}
+
+# Установка из GitHub.
+pip install git+https://github.com/DUB1401/dublib
+```
+
+_Copyright © DUB1401. 2023-2024._

dublib-0.3.0/README.md

@@ -0,0 +1,29 @@
+# dublib
+**dublib** – это библиотека, поставляющая компоненты, требующиеся в проектах [@DUB1401](https://github.com/DUB1401), написанных на Python.
+
+# Поставляемые компоненты
+Библиотека включает следующие модули:
+* [Methods](docs/Methods.md)
+* [Polyglot](docs/Polyglot.md)
+* [StyledPrinter](docs/StyledPrinter.md)
+* [Terminalyzer](docs/Terminalyzer.md)
+* [WebRequestor](docs/WebRequestor.md)
+
+# Установка
+Библиотека поддерживает установку из двух типов репозиториев:
+* **PyPI** – стабильные выпуски (с возможностью выбора конкретной версии);
+* **GitHub** – канал разработки со всеми последними изменениями и исправлениями.
+
+_**Примечание:**_ Для установки библиотеки из репозитория GitHub на вашем устройстве должна присутствовать система контроля версий Git.
+```
+# Установка из PyPi.
+pip install dublib
+
+# Установка конкретной версии из PyPi.
+pip install dublib=={version}
+
+# Установка из GitHub.
+pip install git+https://github.com/DUB1401/dublib
+```
+
+_Copyright © DUB1401. 2023-2024._

{dublib-0.2.0 → dublib-0.3.0}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "cython"]
 
 [project]
 name = "dublib"
-version = "0.2.0"
+version = "0.3.0"
 description = "Коллекция модулей от DUB1401."
 authors = [
 	{name = "DUB1401", email="vlad.milosta@outlook.com"}

{dublib-0.2.0 → dublib-0.3.0}/src/dublib/Exceptions/StyledPrinter.py

@@ -3,7 +3,6 @@ class DuplicatedStyles(Exception):
 	Исключение: использованы оба способа указания стилей.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
 	def __init__(self):
 		"""
 		Исключение: использованы оба способа указания стилей.
@@ -14,6 +13,5 @@ class DuplicatedStyles(Exception):
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message)
 			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message

{dublib-0.2.0 → dublib-0.3.0}/src/dublib/Exceptions/Terminalyzer.py

@@ -1,20 +1,38 @@
+class IdenticalIndicators(Exception):
+	"""
+	Исключение: попытка установки одинаковых индикаторов ключей и флагов.
+	"""
+
+	def __init__(self):
+		"""
+		Исключение: попытка установки одинаковых индикаторов ключей и флагов.
+		"""
+
+		# Добавление данных в сообщение об ошибке.
+		self.__Message = "Cannot set same indicators for keys and flags."
+		# Обеспечение доступа к оригиналу наследованного свойства.
+		super().__init__(self.__Message) 
+			
+	def __str__(self):
+		return self.__Message
+
 class InvalidArgumentType(Exception):
 	"""
-	Исключение: неверный тип аргумента.
+	Исключение: неверное значение аргумента.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
-	def __init__(self, Value: str, Type: str):
+	def __init__(self, value: str, type_name: str):
 		"""
-		Исключение: неверный тип аргумента.
+		Исключение: неверное значение аргумента.
+			value – значение аргумента;
+			type_name – название ожидаемого типа.
 		"""
 
 		# Добавление данных в сообщение об ошибке.
-		self.__Message = "\"" + Value + "\" isn't \"" + Type + "\"."
+		self.__Message = "\"" + value + "\" isn't \"" + type_name + "\"."
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message) 
 			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message
 
@@ -23,18 +41,17 @@ class MutuallyExclusiveFlags(Exception):
 	Исключение: активированы взаимоисключающие флаги.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
-	def __init__(self, Command: str):
+	def __init__(self, command: str):
 		"""
 		Исключение: активированы взаимоисключающие флаги.
+			command – команда, вызвавшая исключение.
 		"""
 
 		# Добавление данных в сообщение об ошибке.
-		self.__Message = "\"" + Command + "\"."
+		self.__Message = "\"" + command + "\"."
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message) 
 			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message
 
@@ -43,19 +60,18 @@ class MutuallyExclusiveKeys(Exception):
 	Исключение: активированы взаимоисключающие ключи.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
-	def __init__(self, Command: str):
+	def __init__(self, command: str):
 		"""
 		Исключение: активированы взаимоисключающие ключи.
+			command – команда, вызвавшая исключение.
 		"""
 
 		# Добавление данных в сообщение об ошибке.
-		self.__Message = "\"" + Command + "\"."
+		self.__Message = "\"" + command + "\"."
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message) 
 		
 			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message
 	
@@ -64,19 +80,17 @@ class MutuallyExclusivePositions(Exception):
 	Исключение: активированы разные позиции на одном слое.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
-	def __init__(self, Command: str): 
+	def __init__(self, command: str): 
 		"""
 		Исключение: активированы разные позиции на одном слое.
+			command – команда, вызвавшая исключение.
 		"""
 
 		# Добавление данных в сообщение об ошибке.
-		self.__Message = "\"" + Command + "\"."
+		self.__Message = "\"" + command + "\"."
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message) 
 		
-			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message
 
@@ -85,18 +99,17 @@ class NotEnoughArguments(Exception):
 	Исключение: недостаточно аргументов.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
-	def __init__(self, Command: str):
+	def __init__(self, command: str):
 		"""
 		Исключение: недостаточно аргументов.
+			command – команда, вызвавшая исключение.
 		"""
 
 		# Добавление данных в сообщение об ошибке.
-		self.__Message = "\"" + Command + "\"."
+		self.__Message = "\"" + command + "\"."
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message) 
 
-	# Информатор: вызывается при выводе исключения в консоль.
 	def __str__(self):
 		return self.__Message
 
@@ -105,18 +118,17 @@ class TooManyArguments(Exception):
 	Исключение: слишком много аргументов.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
-	def __init__(self, Command: str):
+	def __init__(self, command: str):
 		"""
 		Исключение: слишком много аргументов.
+			command – команда, вызвавшая исключение.
 		"""
 
 		# Добавление данных в сообщение об ошибке.
-		self.__Message = "\"" + Command + "\"."
+		self.__Message = "\"" + command + "\"."
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message) 
 			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message
 
@@ -125,18 +137,16 @@ class UnknownCommand(Exception):
 	Исключение: неизвестная комманда.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
-	def __init__(self, Command: str):
+	def __init__(self, command: str):
 		"""
 		Исключение: неизвестная комманда.
+			command – команда, вызвавшая исключение.
 		"""
 		
 		# Добавление данных в сообщение об ошибке.
-		self.__Message = "\"" + Command + "\"."
+		self.__Message = "\"" + command + "\"."
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message) 
 		
-			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message

{dublib-0.2.0 → dublib-0.3.0}/src/dublib/Exceptions/WebRequestor.py

@@ -3,7 +3,6 @@ class ConfigRequired(Exception):
 	Исключение: не задана конфигурация.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
 	def __init__(self):
 		"""
 		Исключение: не задана конфигурация.
@@ -14,7 +13,6 @@ class ConfigRequired(Exception):
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message)
 			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message
 
@@ -23,7 +21,6 @@ class SeleniumRequired(Exception):
 	Исключение: не инициализирован или не установлен Selenium.
 	"""
 
-	# Конструктор: вызывается при обработке исключения.
 	def __init__(self):
 		"""
 		Исключение: не инициализирован или не установлен Selenium.
@@ -34,6 +31,5 @@ class SeleniumRequired(Exception):
 		# Обеспечение доступа к оригиналу наследованного свойства.
 		super().__init__(self.__Message)
 			
-	# Преобразователь: представляет содержимое класса как строку.
 	def __str__(self):
 		return self.__Message

dublib-0.3.0/src/dublib/Methods.py

@@ -0,0 +1,211 @@
+import shutil
+import html
+import json
+import sys
+import os
+import re
+
+#==========================================================================================#
+# >>>>> ФУНКЦИИ РАБОТЫ С СИСТЕМОЙ <<<<< #
+#==========================================================================================#
+
+def CheckPythonMinimalVersion(major: int, minor: int, raise_exception: bool = True) -> bool:
+	"""
+	Проверяет, соответствует ли используемая версия Python минимальной требуемой.
+		major – идентификатор Major-версии Python;
+		minor – идентификатор Minor-версии Python;
+		raise_exception – указывает, как поступать при несоответствии версии: выбрасывать исключение или возвращать значение.
+	"""
+
+	# Состояние: корректна ли версия.
+	IsVersionCorrect = True
+	
+	# Если версия Python старше минимальной требуемой.
+	if sys.version_info < (major, minor): 
+		
+		# Если указано выбросить исключение.
+		if raise_exception == True:
+			# Выброс исключения.
+			raise RuntimeError(f"Python {major}.{minor} or newer is required.")
+
+		else: 
+			# Переключение статуса проверки.
+			IsVersionCorrect = False
+
+	return IsVersionCorrect
+
+def Cls():
+	"""
+	Очищает консоль.
+	"""
+
+	os.system("cls" if os.name == "nt" else "clear")
+
+def MakeRootDirectories(directories: list[str]):
+	"""
+	Создаёт каталоги в текущей корневой директории скрипта.
+		directories – список названий каталогов.
+	"""
+	
+	# Для каждого названия каталога.
+	for Name in directories:
+		# Если каталог не существует, то создать его.
+		if os.path.exists(Name) == False: os.makedirs(Name)
+
+def RemoveFolderContent(path: str):
+	"""
+	Удаляет всё содержимое каталога.
+		path – путь к каталогу.
+	"""
+
+	# Список содержимого в папке.
+	FolderContent = os.listdir(path)
+
+	# Для каждого элемента.
+	for Item in FolderContent:
+
+		# Если элемент является каталогом.
+		if os.path.isdir(path + "/" + Item):
+			# Удаление каталога.
+			shutil.rmtree(path + "/" + Item)
+
+		else:
+			# Удаление файла.
+			os.remove(path + "/" + Item)
+
+def Shutdown():
+	"""
+	Выключает устройство.
+	"""
+
+	# Если устройство работает под управлением ОС семейства Linux.
+	if sys.platform in ["linux", "linux2"]: os.system("sudo shutdown now")
+	# Если устройство работает под управлением ОС семейства Windows.
+	if sys.platform == "win32": os.system("shutdown /s")
+
+#==========================================================================================#
+# >>>>> ФУНКЦИИ ОБРАБОТКИ ТИПОВ ДАННЫХ <<<<< #
+#==========================================================================================#
+
+def CheckForCyrillicPresence(text: str) -> bool:
+	"""
+	Проверяет, имеются ли кирилические символы в строке.
+		text – проверяемая строка.
+	"""
+
+	# Русский алфавит в нижнем регистре.
+	Alphabet = set("абвгдеёжзийклмнопрстуфхцчшщъыьэюя")
+	# Состояние: содержит ли строка кирилические символы.
+	IsTextContainsCyrillicCharacters = not Alphabet.isdisjoint(text.lower())
+
+	return IsTextContainsCyrillicCharacters
+
+def MergeDictionaries(base_dictionary: dict, mergeable_dictionary: dict, overwrite: bool = False) -> dict:
+	"""
+	Объединяет словари.
+		base_dictionary – словарь, в который идёт копирование;
+		mergeable_dictionary – словарь, из котрого идёт копирование;
+		overwrite – указывает, нужно ли перезаписывать значения конфликтующих ключей базового словаря.
+	"""
+
+	# Для каждого ключа.
+	for Key in mergeable_dictionary.keys():
+
+		# Если перезапись отключена и ключ отсутствует в базовом словаре.
+		if overwrite == False and Key not in base_dictionary.keys():
+			# Копирование в базовый словарь ключа и его значения из объединяемого.
+			base_dictionary[Key] = mergeable_dictionary[Key]
+
+		# Если перезапись включена.
+		elif overwrite == True:
+			# Копирование в базовый словарь ключа и его значения из объединяемого.
+			base_dictionary[Key] = mergeable_dictionary[Key]
+
+	return base_dictionary
+
+def RemoveRecurringSubstrings(string: str, substring: str) -> str:
+	"""
+	Удаляет из строки подряд идущие повторяющиеся подстроки.
+		string – строка, из которой удаляются повторы;
+		Substring – удаляемая подстрока.
+	"""
+
+	# Пока в строке находятся повторы указанного символа, удалять их.
+	while substring + substring in string: string = string.replace(substring + substring, substring)
+
+	return string
+
+def ReplaceDictionaryKey(dictionary: dict, old_key: any, new_key: any) -> dict:
+	"""
+	Заменяет ключ в словаре, сохраняя исходный порядок элементов.
+		dictionary – обрабатываемый словарь;
+		old_key – старое название ключа;
+		new_key – новое название ключа.
+	"""
+	
+	# Результат выполнения.
+	Result = dict()
+	# Если ключ не найден, выбросить исключение.
+	if old_key not in dictionary.keys(): raise KeyError(str(old_key))
+
+	# Для каждого ключа.
+	for Key in dictionary.keys():
+
+		# Если текущий ключ совпадает с искомым.
+		if Key == old_key:
+			# Замена ключа новым.
+			Result[new_key] = dictionary[old_key]
+
+		else:
+			# Копирование старой пары ключ-значение.
+			Result[Key] = dictionary[Key]
+
+	return Result
+
+def ReplaceRegexSubstring(origin: str, regex: str, substring: str) -> str:
+	"""
+	Заменяет все вхождения регулярного выражения в строке на подстроку.
+		origin – обрабатываемая строка;
+		regex – регулярное выражение для поиска подстрок;
+		substring – вставляемая подстрока.
+	"""
+
+	# Список совпадений.
+	RegexSubstring = list()
+
+	while re.findall(regex, origin) != []:
+		# Буфер.
+		RegexSubstring = re.findall(regex, origin)
+		# Поиск всех совпадений.
+		RegexSubstring = RegexSubstring[0] if len(RegexSubstring) > 0 else None
+		# Удаление подстроки.
+		if RegexSubstring != None: origin = origin.replace(RegexSubstring, substring)
+
+	return origin
+
+#==========================================================================================#
+# >>>>> ФУНКЦИИ РАБОТЫ С JSON <<<<< #
+#==========================================================================================#
+
+def ReadJSON(path: str) -> dict:
+	"""
+	Читает файл JSON и конвертирует его в словарь.
+		path – путь к файлу.
+	"""
+
+	# Словарь для преобразования.
+	JSON = dict()
+	# Открытие и чтение файла JSON.
+	with open(path, encoding = "utf-8") as FileRead: JSON = json.load(FileRead)
+
+	return JSON
+
+def WriteJSON(path: str, dictionary: dict):
+	"""
+	Записывает стандартизированный JSON файл. Для отступов используются символы табуляции.
+		path – путь к файлу;
+		dictionary – словарь, конвертируемый в формат JSON.
+	"""
+
+	# Запись словаря в JSON файл.
+	with open(path, "w", encoding = "utf-8") as FileWrite: json.dump(dictionary, FileWrite, ensure_ascii = False, indent = '\t', separators = (",", ": "))

dublib-0.3.0/src/dublib/Polyglot.py

@@ -0,0 +1,127 @@
+from dublib.Methods import ReplaceRegexSubstring
+
+import html
+import re
+
+class HTML:
+	"""
+	Объектная реализация обработчика HTML.
+	"""
+
+	#==========================================================================================#
+	# >>>>> СВОЙСТВА ТОЛЬКО ДЛЯ ЧТЕНИЯ <<<<< #
+	#==========================================================================================#
+
+	@property
+	def text(self) -> str:
+		"""
+		Текст.
+		"""
+
+		return self.__Text
+
+	@property
+	def plain_text(self) -> str:
+		"""
+		Текст без тегов и спецсимволов HTML.
+		"""
+		
+		# Конвертирование спецсимволов HTML в Unicode.
+		PlainText = html.unescape(self.__Text)
+		# Удаление найденных по регулярному выражению тегов.
+		PlainText = str(re.sub(self.__AllTagsRegex, "", PlainText))
+
+		return PlainText
+
+	#==========================================================================================#
+	# >>>>> МЕТОДЫ <<<<< #
+	#==========================================================================================#
+
+	def __init__(self, text: str):
+		"""
+		Объектная реализация обработчика HTML.
+			text – текст, подлежащий обработке.
+		"""
+
+		#---> Генерация динамических свойств.
+		#==========================================================================================#
+		# Регулярное выражение фильтрации тегов HTML.
+		self.__AllTagsRegex = re.compile('<.*?>|&([a-z0-9]+|#[0-9]{1,6}|#x[0-9a-f]{1,6});')
+		# Обрабатываемый текст.
+		self.__Text = text	
+
+	def __str__(self) -> str:
+		return self.__Text
+
+	def remove_tags(self):
+		"""
+		Удаляет все теги HTML из текста.
+		"""
+
+		# Удаление найденных по регулярному выражению тегов.
+		self.__Text = str(re.sub(self.__AllTagsRegex, "", self.__Text))
+
+	def unescape(self):
+		"""
+		Преобразует спецсимволы HTML в Unicode.
+		"""
+
+		# Конвертирование спецсимволов HTML в Unicode.
+		self.__Text = html.unescape(self.__Text)
+
+class Markdown:
+	"""
+	Объектная реализация обработчика Markdown.
+	"""
+
+	#==========================================================================================#
+	# >>>>> СВОЙСТВА ТОЛЬКО ДЛЯ ЧТЕНИЯ <<<<< #
+	#==========================================================================================#
+
+	@property
+	def escaped_text(self) -> str:
+		"""
+		Экранированный текст.
+		"""
+		# Буфер текста.
+		Text = self.__Text
+		# Для каждого спецсимвола провести экранирование.
+		for Character in self.__SpecialCharacters: Text = ReplaceRegexSubstring(".This is a test. This is only a test.", f"(?<!\\\\)\\{Character}", f"\\{Character}")
+
+		return Text
+
+	@property
+	def text(self) -> str:
+		"""
+		Текст.
+		"""
+
+		return self.__Text
+
+	#==========================================================================================#
+	# >>>>> МЕТОДЫ <<<<< #
+	#==========================================================================================#
+
+	def __init__(self, text: str):
+		"""
+		Объектная реализация обработчика Markdown.
+			text – текст, подлежащий обработке.
+		"""
+
+		#---> Генерация динамических свойств.
+		#==========================================================================================#
+		# Обрабатываемый текст.
+		self.__Text = str(text)
+		# Список спецсимволов.
+		self.__SpecialCharacters = ['_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!']
+
+	def __str__(self) -> str:
+		return self.__Text
+
+	def escape(self):
+		"""
+		Экранирует спецсимволы.
+		"""
+
+		# Для каждого спецсимвола провести экранирование.
+		for Character in self.__SpecialCharacters: self.__Text = ReplaceRegexSubstring(".This is a test. This is only a test.", f"(?<!\\\\)\\{Character}", f"\\{Character}")