dublib 0.28.0__tar.gz → 0.28.2__tar.gz

{dublib-0.28.0/src/dublib.egg-info → dublib-0.28.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dublib
-Version: 0.28.0
+Version: 0.28.2
 Summary: Коллекция полезных модулей от DUB1401.
 Author-email: DUB1401 <vlad.milosta@outlook.com>
 License: This is free and unencumbered software released into the public domain.
@@ -52,6 +52,7 @@ Requires-Dist: httpx[http2]
 Requires-Dist: orjson
 Requires-Dist: prettytable
 Requires-Dist: requests
+Requires-Dist: pathvalidate
 Requires-Dist: pyyaml
 Requires-Dist: pydantic
 Requires-Dist: validators
@@ -65,6 +66,7 @@ Requires-Dist: pyTelegramBotAPI; extra == "telebot"
 Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
 Requires-Dist: Sphinx; extra == "dev"
 Requires-Dist: sphinx-rtd-theme; extra == "dev"
 Dynamic: license-file

{dublib-0.28.0 → dublib-0.28.2}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools"]
 
 [project]
 name = "dublib"
-version = "0.28.0"
+version = "0.28.2"
 description = "Коллекция полезных модулей от DUB1401."
 authors = [
 	{name = "DUB1401", email = "vlad.milosta@outlook.com"}
@@ -20,6 +20,7 @@ dependencies = [
 	"orjson",
 	"prettytable",
 	"requests",
+	"pathvalidate",
 	"pyyaml",
 	"pydantic",
 	"validators",
@@ -48,6 +49,7 @@ telebot = [
 dev = [
 	"mypy",
 	"pytest",
+	"ruff",
 	"Sphinx",
 	"sphinx-rtd-theme"
 ]
@@ -57,9 +59,13 @@ ignore_missing_imports = true
 check_untyped_defs = true
 non_interactive = true
 follow_imports = "silent"
-files = [
-	"src"
-]
+files = ["src"]
+
+[tool.ruff]
+include = ["src/*"]
+
+[tool.ruff.lint]
+ignore = ["E701"]
 
 [project.urls]
 Documentation = "https://github.com/DUB1401/dublib/tree/main/docs"

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/Templates/Bus.py

@@ -1,5 +1,5 @@
 from ..TextStyler import Codes, TextStyler
-from .. import readline
+from .. import readline as readline
 
 import enum
 

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/Templates/__init__.py

@@ -1,4 +1,4 @@
-from .. import readline
+from .. import readline as readline
 
 #==========================================================================================#
 # >>>>> ШАБЛОНЫ ВВОДА-ВЫВОДА <<<<< #
@@ -29,6 +29,6 @@ def Confirmation(text: str, question: str | None = None, yes: str | None = None,
 		InputLine = input(f"{text}\n{question} [{yes}/{no}]: ").strip().lower()
 		if InputLine == yes.lower(): Response = True
 		if InputLine == no.lower(): Response = False
-		if Response != None: break
+		if Response is not None: break
 
 	return Response

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/Terminalyzer/Command/Parser.py

@@ -1,12 +1,18 @@
 from .... import Exceptions
 
-from typing import cast, Sequence, TYPE_CHECKING
+from typing import cast, overload, Sequence, TypeVar, TYPE_CHECKING
 from datetime import datetime
 from pathlib import Path
 
 if TYPE_CHECKING:
 	from .Definition import _Flag, _Key, Command
 	
+#==========================================================================================#
+# >>>>> ПЕРЕМЕННЫЕ ТИПОВ <<<<< #
+#==========================================================================================#
+
+_EXPECTED_TYPE = TypeVar("_EXPECTED_TYPE", bool, float, int, Path, str, datetime)
+
 #==========================================================================================#
 # >>>>> ПРЕДСТАВЛЕНИЯ ОБРАБОТАННЫХ ПАРАМЕТРОВ <<<<< #
 #==========================================================================================#
@@ -135,9 +141,9 @@ class _ParsedCommandParameters:
 
 		Result = list()
 
-		for Sequence in (self.__Positions.values(), self.__BasePosition):
-			for Parameter in Sequence:
-				if type(Parameter) == required_type: Result.append(Parameter)
+		for CurrentSequence in (self.__Positions.values(), self.__BasePosition):
+			for Parameter in CurrentSequence:
+				if type(Parameter) is required_type: Result.append(Parameter)
 
 		return tuple(Result)
 
@@ -259,25 +265,49 @@ class ParsedCommandData:
 
 		return False
 	
-	def get_key_value(self, key: str, exception: bool = False) -> bool | float | int | Path | str | datetime | None:
+	@overload
+	def get_key_value(self, key: str, expected_type: type[_EXPECTED_TYPE], exception: bool = False) -> _EXPECTED_TYPE | None: ...
+
+	@overload
+	def get_key_value(self, key: str, expected_type: None = None, exception: bool = False) -> bool | float | int | Path | str | datetime | None: ...
+
+	def get_key_value(self, key: str, expected_type: type | None = None, exception: bool = False) -> bool | float | int | Path | str | datetime | None:
 		"""
 		Возвращает значение активированного ключа.
 
 		:param key: Название ключа.
 		:type key: str
-		:param exception: Указывает, нужно ли выбросить исключение при отсутствии ключа.
+		:param expected_type: Ожидаемый тип значения. Если тип не соответствует, будет выброшено исключение `TypeError`. Проверяются только значения, отличные от `None`.
+		:type expected_type: type[bool | float | int | Path | str | datetime]
+		:param exception: Указывает, нужно ли выбрасывать исключение при отсутствии ключа.
 		:type exception: bool
-		:raises KeyError: Выбрасывается в случае активации соответствующего параметра и запросе значения отсутствующего ключа.
 		:return: Значение ключа или `None` при отсутствующем ключе.
 		:rtype: bool | float | int | Path | str | datetime | None
+		:raises KeyError: Ключ не найден. Отключается параметром `exception`.
+		:raises TypeError: Ожидается другой тип данных.
 		"""
 
-		for CurrentKey in self.__ParsedData.keys:
-			if key == CurrentKey.name or key in CurrentKey.aliases: return CurrentKey.value
+		ValueToReturn: bool | float | int | Path | str | datetime | None = None
+		IsKeyFound: bool = False
 
-		if exception: raise KeyError(key)
+		for CurrentKey in self.__ParsedData.keys:
+			if key == CurrentKey.name or key in CurrentKey.aliases:
+				ValueToReturn = CurrentKey.value
+				IsKeyFound = True
+				break
+
+		if not IsKeyFound:
+			if exception:
+				raise KeyError(key)
+			else: 
+				return None
+		
+		if expected_type and ValueToReturn is not None:
+			ReturnedType = type(ValueToReturn)
+			if ReturnedType is not expected_type:
+				raise TypeError(f"Expected \"{expected_type}\", but on key {ReturnedType}.")
 
-		return None
+		return ValueToReturn
 
 	def get_position_parameter(self, position_name: str) -> _ParsedArgument | _ParsedFlag | _ParsedKey | None:
 		"""
@@ -291,25 +321,44 @@ class ParsedCommandData:
 		"""
 
 		return self.__ParsedData.positions[position_name]
-	
-	def get_position_value(self, position_name: str) -> bool | float | int | Path | str | datetime | None:
+
+	@overload
+	def get_position_value(self, position_name: str, expected_type: type[_EXPECTED_TYPE]) -> _EXPECTED_TYPE: ...
+
+	@overload
+	def get_position_value(self, position_name: str, expected_type: None = None) -> bool | float | int | Path | str | datetime | None: ...
+
+	def get_position_value(self, position_name: str, expected_type: type | None = None) -> bool | float | int | Path | str | datetime | None:
 		"""
 		Для аргументов и ключей на позиции возвращает значение, для флагов – `True` при активации.
 
 		:param position_name: Имя позиции.
 		:type position_name: str
-		:return: Параметр позиции или `None` при пустой позиции.
+		:param expected_type: Ожидаемый тип значения. Если тип не соответствует, будет выбрашено исключение `TypeError`.
+		:type expected_type: type[bool | float | int | Path | str | datetime]
+		:return: Параметр позиции или `None` при пустой позиции. Для флага возвращает основное имя флага.
 		:rtype: bool | float | int | Path | str | datetime | None
 		:raises KeyError: Позиция не обнаружена.
+		:raises TypeError: Ожидается другой тип данных.
 		"""
 
 		ParsedParameter = self.get_position_parameter(position_name)
-		if not ParsedParameter: return None
+		ValueToReturn: bool | float | int | Path | str | datetime | None = None
 
-		if type(ParsedParameter) == _ParsedFlag: return True
+		if not ParsedParameter:
+			ValueToReturn = None
+		elif type(ParsedParameter) is _ParsedFlag:
+			ValueToReturn = ParsedParameter.name
 		else:
 			ParsedParameter = cast(_ParsedArgument | _ParsedKey, ParsedParameter)
-			return ParsedParameter.value
+			ValueToReturn = ParsedParameter.value
+
+		if expected_type:
+			ReturnedType = type(ValueToReturn)
+			if ReturnedType is not expected_type:
+				raise TypeError(f"Expected \"{expected_type}\", but on position {ReturnedType}.")
+			
+		return ValueToReturn
 
 	def to_dict(self) -> dict:
 		"""

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/Terminalyzer/Helper.py

@@ -296,8 +296,9 @@ class Helper:
 		#---> Генерация таблицы.
 		#==========================================================================================#
 		Tables = list()
+		Categories: list[str | None] = list(CommandsCategories.keys())
 
-		for Category in CommandsCategories.keys():
+		for Category in Categories:
 			HelpTable: dict[str, list] = {
 				"Commands": [],
 				"Descriptions": []
@@ -320,7 +321,7 @@ class Helper:
 
 			TableObject.align = "l"
 			TableString = TableObject.get_string()
-			if TableObject.header: TableString = " " * 8 + TableString.lstrip()
+			if len(Categories) > 1: TableString = " " * 8 + TableString.lstrip()
 			Tables.append(TableString)
 
 		self.__Callback("\n\n".join(Tables))

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/Terminalyzer/__init__.py

@@ -1,6 +1,6 @@
 from .Command.Parser import _CommandParser, ParsedCommandData
+from ..Validators import ValidableTypes as ValidableTypes
 from .Command.Definition import Command
-from ..Validators import ValidableTypes
 from .Helper import Helper
 
 from ...Core import LOGS_HANDLER
@@ -46,7 +46,7 @@ class Terminalyzer:
 
 		for CurrentPosition in command.positions:
 			if CurrentPosition.description and len(CurrentPosition.parameters) == 1 and CurrentPosition.parameters[0].description:
-				LOGGER.warning(f"Command: \"{command.name}\". Parametr description suppressed by position description on \"{CurrentPosition.name}\".")
+				LOGGER.warning(f"Command: \"{command.name}\". Parameter description suppressed by position description on \"{CurrentPosition.name}\".")
 
 	def __CheckCommandForEmptyPositions(self, command: Command):
 		"""
@@ -119,6 +119,7 @@ class Terminalyzer:
 		:raises Exceptions.CLI.Terminalyzer.MultipleCommandDefinition: Множественное определение команды.
 		"""
 		
+		commands = commands.copy()
 		if not self.__CommandName: return None
 
 		self.__ValidateCommandsDefinitions(commands)
@@ -133,8 +134,9 @@ class Terminalyzer:
 				break
 
 		if self.__Helper.is_enabled and CommandData and CommandData.name == "help":
-			CommandName = cast(str, CommandData.arguments[0])
-			if CommandData.arguments: self.__Helper.generate_help_command(commands, CommandName, CommandData.check_flag("-t"))
+			if CommandData.arguments:
+				CommandName = cast(str, CommandData.arguments[0])
+				self.__Helper.generate_help_command(commands, CommandName, CommandData.check_flag("-t"))
 			else: self.__Helper.generate_help_list(commands)
 		
 		return CommandData
@@ -147,7 +149,7 @@ class Terminalyzer:
 		:type parameters: Sequence[str] | None
 		"""
 
-		self.__Input = input or sys.argv[1:]
+		self.__Input = list(input) if input else sys.argv[1:]
 
 		self.__CommandName = None
 		self.__Parameters: tuple = tuple()

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/TextStyler/__init__.py

@@ -1,6 +1,6 @@
 from ...Methods.Data import ToSequence
 
-from .FastStyler import FastStyler
+from .FastStyler import FastStyler as FastStyler
 from . import Codes, Escapes
 
 from types import MappingProxyType

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/Validators.py

@@ -6,6 +6,7 @@ from datetime import datetime
 from pathlib import Path
 from enum import Enum
 
+from pathvalidate import is_valid_filepath
 import dateparser
 import validators
 
@@ -149,7 +150,7 @@ class Validator_Base64(BaseValidator[str]):
 
 		try: 
 			Result = validators.base64(value)
-			if type(Result) == bool: return Result
+			if type(Result) is bool: return Result
 		except validators.ValidationError: pass
 
 		return False
@@ -216,7 +217,7 @@ class Validator_Datetime(BaseValidator[datetime]):
 		try: 
 			dateparser.parse(value)
 			return True
-		except: pass
+		except (ValueError, TypeError): pass
 
 		return False
 
@@ -248,7 +249,7 @@ class Validator_Email(BaseValidator[str]):
 
 		try: 
 			Result = validators.email(value)
-			if type(Result) == bool: return Result
+			if type(Result) is bool: return Result
 		except validators.ValidationError: pass
 
 		return False
@@ -337,7 +338,7 @@ class Validator_IPv4(BaseValidator[str]):
 
 		try: 
 			Result = validators.ipv4(value)
-			if type(Result) == bool: return Result
+			if type(Result) is bool: return Result
 		except validators.ValidationError: pass
 
 		return False
@@ -370,7 +371,7 @@ class Validator_IPv6(BaseValidator[str]):
 
 		try: 
 			Result = validators.ipv6(value)
-			if type(Result) == bool: return Result
+			if type(Result) is bool: return Result
 		except validators.ValidationError: pass
 
 		return False
@@ -439,10 +440,7 @@ class Validator_Path(BaseValidator[Path]):
 		:rtype: bool
 		"""
 
-		try: 
-			Path(value)
-			return True
-		except: return False
+		return is_valid_filepath(value)
 
 class Validator_UnsignedInteger(BaseValidator[int]):
 
@@ -500,7 +498,7 @@ class Validator_URL(BaseValidator[str]):
 
 		try: 
 			Result = validators.url(value)
-			if type(Result) == bool: return Result
+			if type(Result) is bool: return Result
 		except validators.ValidationError: pass
 
 		return False
@@ -531,8 +529,7 @@ class Validator_ValidPath(BaseValidator[Path]):
 		:rtype: bool
 		"""
 
-		try: return Path(value).exists()
-		except: return False
+		return Path(value).exists()
 
 #==========================================================================================#
 # >>>>> ПЕРЕЧИСЛЕНИЕ ВАЛИДАТОРОВ <<<<< #

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/CLI/readline.py

@@ -2,9 +2,11 @@
 
 import sys
 
-try: import readline
+try: import readline as readline
 except ImportError:
 
 	if sys.platform == "win32":
 		try: import pyreadline3 as readline
-		except ImportError: pass
+		except ImportError: pass
+
+__all__ = ["readline"]

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/Engine/Configurator.py

@@ -17,7 +17,7 @@ class Config:
 	#==========================================================================================#
 
 	__EXCEPTION_DISABLED = object()
-	__INSTANCES: "dict[PathLike, Config]" = dict()
+	__INSTANCES: "dict[str, Config]" = dict()
 
 	#==========================================================================================#
 	# >>>>> СВОЙСТВА <<<<< #
@@ -84,18 +84,19 @@ class Config:
 		if args[0] not in cls.__INSTANCES:
 			Instance = super().__new__(cls)
 			Instance._IS_INITIALIZED = False
-			cls.__INSTANCES[args[0]] = Instance
+			ConfigPath = Path(args[0])
+			cls.__INSTANCES[ConfigPath.as_posix()] = Instance
 
 		return cls.__INSTANCES[args[0]]
 	
-	def __init__(self, path: PathLike):
+	def __init__(self, path: str | PathLike[str]):
 		"""
 		Контейнер конфигурации.
 
 		Может работать с файлами JSON и YAML. Определение происходит по расширению файла, в противном случае предпочтение отдаётся JSON.
 
 		:param path: Путь к файлу параметров. На данный момент поддерживается только JSON.
-		:type path: PathLike
+		:type path: str | PathLike[str]
 		"""
 
 		if self._IS_INITIALIZED: return
@@ -248,7 +249,7 @@ class Config:
 	def unload(self):
 		"""Выгружает контейнер из памяти."""
 
-		del self.__INSTANCES[self.path]
+		del self.__INSTANCES[self.path.as_posix()]
 
 	def validate(self, model: type[BaseModel] | None = None):
 		"""

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/Engine/GetText.py

@@ -58,7 +58,7 @@ class GetText:
 		"""
 		
 		if languages:
-			if type(languages) == str: languages = [languages]
+			if type(languages) is str: languages = [languages]
 
 			try: return gettext.translation(GetText._DOMAIN, GetText._PATH, languages = languages).gettext(message)
 			except FileNotFoundError: return GetText.gettext(message)

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/Engine/Patcher.py

@@ -1,5 +1,4 @@
 from ..Methods.Filesystem import ReadTextFile, WriteTextFile
-from ..Methods.Data import ToSequence
 
 from pathlib import Path
 from os import PathLike
@@ -34,12 +33,12 @@ class Patch:
 	# >>>>> МЕТОДЫ <<<<< #
 	#==========================================================================================#
 
-	def __init__(self, path: PathLike):
+	def __init__(self, path: str | PathLike[str]):
 		"""
 		Патч.
 
 		:param path: Путь к файлу.
-		:type path: PathLike
+		:type path: str | PathLike[str]
 		"""
 
 		self.__Path = Path(path)
@@ -93,7 +92,7 @@ class Patch:
 		:type count: int | None
 		"""
 
-		if count == None: count = -1
+		if count is None: count = -1
 		self.__TextLines = self.text.replace(old, new, count).split("\n")
 
 	def replace_by_regex(self, regex: str, text: str, count: int = 0):

dublib-0.28.2/src/dublib/Exceptions/CLI/__init__.py

@@ -0,0 +1,2 @@
+from . import Terminalyzer as Terminalyzer
+from . import Validators as Validators

dublib-0.28.2/src/dublib/Exceptions/Engine/__init__.py

@@ -0,0 +1 @@
+from . import Bus as Bus

dublib-0.28.2/src/dublib/Exceptions/__init__.py

@@ -0,0 +1,4 @@
+from . import CLI as CLI
+from . import Engine as Engine
+from . import TelebotUtils as TelebotUtils
+from . import WebRequestor as WebRequestor

{dublib-0.28.0 → dublib-0.28.2}/src/dublib/Methods/Data.py

@@ -18,9 +18,9 @@ def Copy(data: Any) -> Any:
 	:return: Копия объекта.
 	:rtype: Any
 	"""
-
+	
 	try: return orjson.loads(orjson.dumps(data))
-	except: return copy.deepcopy(data)
+	except (orjson.JSONDecodeError, orjson.JSONEncodeError): return copy.deepcopy(data)
 
 def StringifyFloat(number: float, round_factor: int = 2) -> str:
 	"""
@@ -47,7 +47,7 @@ def StringToBool(value: str, literals: Sequence[str] = ("false", "0")) -> bool:
 
 	:param value: Преобразуемая строка.
 	:type value: str
-	:param literals: Набор строк, интерпретируемых как `False`.
+	:param literals: Набор строк, интерпретируемых как `False`. Нечувствителен к регистру.
 	:type literals: Sequence[str]
 	:return: Результирующее значение.
 	:rtype: bool
@@ -59,8 +59,10 @@ def StringToBool(value: str, literals: Sequence[str] = ("false", "0")) -> bool:
 
 @overload
 def ToSequence(value: Any, target_type: type[list]) -> list: ...
+
 @overload
 def ToSequence(value: Any, target_type: type[set]) -> set: ...
+
 @overload
 def ToSequence(value: Any, target_type: type[tuple] = ...) -> tuple: ...
 
@@ -76,7 +78,7 @@ def ToSequence(value: Any, target_type: type[list | set | tuple] = tuple) -> lis
 	:rtype: list | set | tuple
 	"""
 
-	if type(value) == target_type: return value
+	if type(value) is target_type: return value
 	if type(value) in (list, set, tuple): return target_type(value)
 	
 	return target_type((value,))

dublib-0.28.2/src/dublib/Methods/Decorators.py

@@ -0,0 +1,53 @@
+from ..CLI.TextStyler import FastStyler
+
+import functools
+import warnings
+
+def deprecated(message: str | None = None):
+	"""
+	Декоратор: помечает функцию как устаревшую.
+
+	:param message: Сопровождающее сообщение.
+	:type message: str | None
+	"""
+
+	def decorator(function):
+
+		@functools.wraps(function)
+		def Wrapper(*args, **kwargs):
+			Message = f" {message}" or ""
+			Function = FastStyler(function.__name__).decorate.bold
+			warnings.warn(f"{Function} is deprecated.{Message}", DeprecationWarning, stacklevel = 2)
+
+			return function(*args, **kwargs)
+		
+		return Wrapper
+	
+	return decorator
+
+def run_before_method(method_name: str):
+	"""
+	Декоратор: запускает публичный или защищённый метод, не принимающий аргументов, перед выполнением метода экземпляра класса. Запущенный метод имеет доступ к экземпляру.
+
+	:param method_name: Имя метода.
+	:type method_name: str
+	"""
+
+	if method_name.startswith("__"):
+		raise ValueError("Only public and protected methods supported in @run_befor_method decorator.")
+	
+	def decorator(function):
+
+		@functools.wraps(function)
+		def Wrapper(*args, **kwargs):
+			if args:
+				Object = args[0]
+				Method = getattr(Object, method_name, None)
+				if Method and callable(Method):
+					Method()
+
+			return function(*args, **kwargs)
+		
+		return Wrapper
+	
+	return decorator