jetpytools 2.2.0__tar.gz

jetpytools-2.2.0/.gitignore

@@ -0,0 +1,233 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+.cache/
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# versioningit
+jetpytools/_version.py
+
+# DEVELOPERS:
+# Before adding a file directory to this .gitignore,
+# check if it should maybe go in your local .gitignore
+# (.git/info/exclude), or your own user-wide .gitignore
+# (https://sebastiandedeyne.com/setting-up-a-global-gitignore-file/)
+# instead.
+# Repository-specific files (Python cache files, build artifacts,
+# coverage reports, etc.) should go in here, user-specific files
+# (IDE folders, video index files, etc.) shouldn't.
+
+# JET files
+.vsjet/

jetpytools-2.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 LightArrowsEXE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

jetpytools-2.2.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: jetpytools
+Version: 2.2.0
+Summary: Collection of stuff that's useful in general python programming
+Project-URL: Source Code, https://github.com/Jaded-Encoding-Thaumaturgy/jetpytools
+Project-URL: Contact, https://discord.gg/XTpc6Fa9eB
+Author: Jaded Encoding Thaumaturgy
+Maintainer-email: Jaded Encoding Thaumaturgy <jaded.encoding.thaumaturgy@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: typing-extensions>=4.15.0; python_version < '3.13'
+Description-Content-Type: text/markdown
+
+# jetpytools
+
+[![PyPI Version](https://img.shields.io/pypi/v/jetpytools)](https://pypi.org/project/jetpytools/)
+
+A collection of utilities useful for general Python programming.
+
+## How to install
+
+`jetpytools` is distributed via **PyPI**, and the latest stable release can be installed using:
+
+```sh
+pip install vsjetpack
+```

jetpytools-2.2.0/README.md

@@ -0,0 +1,13 @@
+# jetpytools
+
+[![PyPI Version](https://img.shields.io/pypi/v/jetpytools)](https://pypi.org/project/jetpytools/)
+
+A collection of utilities useful for general Python programming.
+
+## How to install
+
+`jetpytools` is distributed via **PyPI**, and the latest stable release can be installed using:
+
+```sh
+pip install vsjetpack
+```

jetpytools-2.2.0/jetpytools/__init__.py

@@ -0,0 +1,16 @@
+"""A collection of utilities useful for general Python programming."""
+
+from .enums import *
+from .exceptions import *
+from .functions import *
+from .types import *
+from .utils import *
+
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+
+try:
+    from ._version import __version__, __version_tuple__
+except ImportError:
+    __version__ = "0.0.0+unknown"
+    __version_tuple__ = (0, 0, 0, "+unknown")

jetpytools-2.2.0/jetpytools/_version.py

@@ -0,0 +1,2 @@
+__version__ = "2.2.0"
+__version_tuple__ = (2, 2, 0)

jetpytools-2.2.0/jetpytools/enums/__init__.py

@@ -0,0 +1,2 @@
+from .base import *
+from .other import *

jetpytools-2.2.0/jetpytools/enums/base.py

@@ -0,0 +1,95 @@
+from __future__ import annotations
+
+from abc import ABCMeta
+from enum import Enum, EnumMeta, ReprEnum
+from enum import property as enum_property
+from typing import TYPE_CHECKING, Any, Self
+
+from ..exceptions import CustomTypeError, NotFoundEnumValueError
+from ..types import FuncExcept, copy_signature
+
+__all__ = ["CustomEnum", "CustomIntEnum", "CustomStrEnum", "EnumABCMeta"]
+
+
+class EnumABCMeta(EnumMeta, ABCMeta):
+    """Metaclass combining EnumMeta and ABCMeta to support abstract enumerations."""
+
+    @copy_signature(EnumMeta.__new__)
+    def __new__(mcls, *args: Any, **kwargs: Any) -> Any:
+        enum_cls = super().__new__(mcls, *args, **kwargs)
+
+        if len(enum_cls) == 0:
+            return enum_cls
+
+        if enum_cls.__abstractmethods__:
+            raise CustomTypeError(
+                "Can't instantiate abstract class {cls_name} without an implementation "
+                "for abstract method{plural} {methods}.",
+                enum_cls,
+                cls_name=enum_cls.__name__,
+                plural="s" if len(enum_cls.__abstractmethods__) > 1 else "",
+                methods=", ".join(f"'{n}'" for n in sorted(enum_cls.__abstractmethods__)),
+            )
+
+        return enum_cls
+
+
+class CustomEnum(Enum):
+    """Base class for custom enums."""
+
+    @classmethod
+    def from_param(cls, value: Any, func_except: FuncExcept | None = None) -> Self:
+        """
+        Return the enum value from a parameter.
+
+        :param value:               Value to instantiate the enum class.
+        :param func_except:         Exception function.
+
+        :return:                    Enum value.
+
+        :raises NotFoundEnumValue:   Variable not found in the given enum.
+        """
+        func_except = func_except or cls.from_param
+
+        try:
+            return cls(value)
+        except (ValueError, TypeError):
+            pass
+
+        if isinstance(func_except, tuple):
+            func_name, var_name = func_except
+        else:
+            func_name, var_name = func_except, repr(cls)
+
+        raise NotFoundEnumValueError(
+            'The given value for "{var_name}" argument must be a valid {enum_name}, not "{value}"!\n'
+            "Valid values are: [{readable_enum}].",
+            func_name,
+            var_name=var_name,
+            enum_name=cls,
+            value=value,
+            readable_enum=(f"{name} ({value!r})" for name, value in cls.__members__.items()),
+            reason=value,
+        ) from None
+
+
+class CustomIntEnum(int, CustomEnum, ReprEnum):
+    """Base class for custom int enums."""
+
+    if TYPE_CHECKING:
+        _value_: int
+        _value2member_map_: dict[int, Enum]
+
+        @enum_property
+        def value(self) -> int: ...
+
+
+class CustomStrEnum(str, CustomEnum, ReprEnum):
+    """Base class for custom str enums."""
+
+    if TYPE_CHECKING:
+        _value_: str
+        _value2member_map_: dict[str, Enum]
+
+        @enum_property
+        def value(self) -> str: ...

jetpytools-2.2.0/jetpytools/enums/other.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from typing import Self, overload
+
+__all__ = ["Coordinate", "Position", "Size"]
+
+
+class Coordinate:
+    """
+    Positive set of (x, y) coordinates.
+
+    :raises ValueError:     Negative values were passed.
+    """
+
+    x: int
+    """Horizontal coordinate."""
+
+    y: int
+    """Vertical coordinate."""
+
+    @overload
+    def __init__(self, other: tuple[int, int] | Self, /) -> None: ...
+
+    @overload
+    def __init__(self, x: int, y: int, /) -> None: ...
+
+    def __init__(self, x_or_self: int | tuple[int, int] | Self, y: int | None = None, /) -> None:
+        if isinstance(x_or_self, int):
+            x = x_or_self
+        else:
+            x, y = x_or_self if isinstance(x_or_self, tuple) else (x_or_self.x, x_or_self.y)
+
+        if y is None:
+            from ..exceptions import CustomValueError
+
+            raise CustomValueError("y coordinate must be defined!", self.__class__)
+
+        if x < 0 or y < 0:
+            from ..exceptions import CustomValueError
+
+            raise CustomValueError("Values can't be negative!", self.__class__)
+
+        self.x = x
+        self.y = y
+
+
+class Position(Coordinate):
+    """Positive set of an (x,y) offset relative to the top left corner of an area."""
+
+
+class Size(Coordinate):
+    """Positive set of an (x,y), (horizontal,vertical), size of an area."""

jetpytools-2.2.0/jetpytools/exceptions/__init__.py

@@ -0,0 +1,5 @@
+from .base import *
+from .enum import *
+from .file import *
+from .generic import *
+from .module import *

jetpytools-2.2.0/jetpytools/exceptions/base.py

@@ -0,0 +1,205 @@
+from __future__ import annotations
+
+import sys
+from contextlib import AbstractContextManager
+from types import TracebackType
+from typing import Any, Self
+
+from ..types import MISSING, FuncExcept, MissingT, SupportsString
+
+__all__ = [
+    "CustomError",
+    "CustomIndexError",
+    "CustomKeyError",
+    "CustomNotImplementedError",
+    "CustomOverflowError",
+    "CustomPermissionError",
+    "CustomRuntimeError",
+    "CustomTypeError",
+    "CustomValueError",
+]
+
+
+class CustomErrorMeta(type):
+    """Custom base exception meta class."""
+
+    def __new__[MetaSelf: CustomErrorMeta](
+        mcls: type[MetaSelf], name: str, bases: tuple[type, ...], namespace: dict[str, Any], /, **kwds: Any
+    ) -> MetaSelf:
+        cls = super().__new__(mcls, name, bases, namespace, **kwds)
+
+        if cls.__qualname__.startswith("Custom"):
+            cls.__qualname__ = cls.__qualname__[6:]
+
+        if sys.stdout and sys.stdout.isatty():
+            cls.__qualname__ = f"\033[0;31;1m{cls.__qualname__}\033[0m"
+
+        cls.__module__ = Exception.__module__
+
+        return cls
+
+
+class CustomError(Exception, metaclass=CustomErrorMeta):
+    """Custom base exception class."""
+
+    def __init__(
+        self, message: SupportsString | None = None, func: FuncExcept | None = None, reason: Any = None, **kwargs: Any
+    ) -> None:
+        """
+        Instantiate a new exception with pretty printing and more.
+
+        :param message: Message of the error.
+        :param func:    Function this exception was raised from.
+        :param reason:  Reason of the exception. For example, an optional parameter.
+        """
+
+        self.message = message
+        self.func = func
+        self.reason = reason
+        self.kwargs = kwargs
+
+        super().__init__(message)
+
+    def __call__(
+        self,
+        message: SupportsString | None | MissingT = MISSING,
+        func: FuncExcept | None | MissingT = MISSING,
+        reason: SupportsString | FuncExcept | None | MissingT = MISSING,
+        **kwargs: Any,
+    ) -> Self:
+        """
+        Copy an existing exception with defaults and instantiate a new one.
+
+        :param message: Message of the error.
+        :param func:    Function this exception was raised from.
+        :param reason:  Reason of the exception. For example, an optional parameter.
+        """
+        from copy import deepcopy
+
+        err = deepcopy(self)
+
+        if message is not MISSING:
+            err.message = message
+
+        if func is not MISSING:
+            err.func = func
+
+        if reason is not MISSING:
+            err.reason = reason
+
+        err.kwargs |= kwargs
+
+        return err
+
+    def __str__(self) -> str:
+        from ..functions import norm_display_name, norm_func_name
+
+        message = self.message
+
+        if not message:
+            message = "An error occurred!"
+
+        if self.func:
+            func_header = norm_func_name(self.func).strip()
+
+            if sys.stdout and sys.stdout.isatty():
+                func_header = f"\033[0;36m{func_header}\033[0m"
+
+            func_header = f"({func_header}) "
+        else:
+            func_header = ""
+
+        if self.kwargs:
+            self.kwargs = {key: norm_display_name(value) for key, value in self.kwargs.items()}
+
+        if self.reason:
+            reason = self.reason = norm_display_name(self.reason)
+
+            if reason:
+                if not isinstance(self.reason, dict):
+                    reason = f"({reason})"
+
+                if sys.stdout and sys.stdout.isatty():
+                    reason = f"\033[0;33m{reason}\033[0m"
+                reason = f" {reason}"
+        else:
+            reason = ""
+
+        out = f"{func_header}{self.message!s}{reason}".format(**self.kwargs).strip()
+
+        return out
+
+    @classmethod
+    def catch(cls) -> CatchError[Self]:
+        """
+        Create a context manager that catches exceptions of this class type.
+
+        Returns:
+            CatchError[Self]: A context manager that will catch and store exceptions of type `cls`
+                when used in a `with` block.
+        """
+        return CatchError(cls)
+
+
+class CatchError[CustomErrorT: CustomError](AbstractContextManager["CatchError[CustomErrorT]"]):
+    """
+    Context manager for catching a specific exception type.
+    """
+
+    error: CustomErrorT | None
+    """The caught exception instance, if any."""
+    tb: TracebackType | None
+    """The traceback object associated with the caught exception."""
+
+    def __init__(self, error: type[CustomErrorT]) -> None:
+        self.error = None
+        self.tb = None
+        self._to_catch_error = error
+
+    def __enter__(self) -> Self:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> bool | None:
+        if isinstance(exc_value, self._to_catch_error):
+            self.error = exc_value
+            self.tb = traceback
+            return True
+
+        return None
+
+
+class CustomValueError(CustomError, ValueError):
+    """Thrown when a specified value is invalid."""
+
+
+class CustomIndexError(CustomError, IndexError):
+    """Thrown when an index or generic numeric value is out of bound."""
+
+
+class CustomOverflowError(CustomError, OverflowError):
+    """Thrown when a value is out of range. e.g. temporal radius too big."""
+
+
+class CustomKeyError(CustomError, KeyError):
+    """Thrown when trying to access an non-existent key."""
+
+
+class CustomTypeError(CustomError, TypeError):
+    """Thrown when a passed argument is of wrong type."""
+
+
+class CustomRuntimeError(CustomError, RuntimeError):
+    """Thrown when a runtime error occurs."""
+
+
+class CustomNotImplementedError(CustomError, NotImplementedError):
+    """Thrown when you encounter a yet not implemented branch of code."""
+
+
+class CustomPermissionError(CustomError, PermissionError):
+    """Thrown when the user can't perform an action."""

jetpytools-2.2.0/jetpytools/exceptions/enum.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from .base import CustomKeyError
+
+__all__ = ["NotFoundEnumValue", "NotFoundEnumValueError"]
+
+
+class NotFoundEnumValueError(CustomKeyError):
+    """Raised when you try to instantiate an Enum with unknown value"""
+
+
+NotFoundEnumValue = NotFoundEnumValueError