python-custom-exceptions 0.0.1__tar.gz → 0.0.2__tar.gz

python_custom_exceptions-0.0.2/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: python-custom-exceptions
+Version: 0.0.2
+Summary: A collection of custom exceptions for Python projects.
+Home-page: https://github.com/aviz92/python-custom-exceptions
+Author: Avi Zaguri
+Author-email: 
+Project-URL: Repository, https://github.com/aviz92/python-custom-exceptions
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: wheel
+Requires-Dist: python-dotenv
+Requires-Dist: pre-commit
+Requires-Dist: colorlog
+Requires-Dist: pytest
+Requires-Dist: pathlib
+Requires-Dist: pytest-plugins
+Requires-Dist: custom-python-logger
+Requires-Dist: python-base-toolkit
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Python Custom Exceptions
+A repository containing custom exception classes for Python projects. <br>
+These exceptions are designed to provide more specific error handling and improve code readability. 
+They can be easily integrated into any Python application to enhance error management. <br>
+
+---
+
+### Features
+- ✅ Specific Exception Classes: Custom exceptions for various error scenarios.
+- ✅ Improved Readability: Clearer error handling in code.
+- ✅ Easy Integration: Simple to add to existing Python projects.
+- ✅ Standardized Error Handling: Consistent approach to managing exceptions.
+- ✅ Structured Hierarchy: Organized exception classes for better maintainability.
+
+---
+
+### Installation
+```bash
+pip install python-custom-exceptions
+```
+
+---
+
+### Usage Examples
+```python
+import os
+from python_custom_exceptions import DiagnosticInfo, IsNotExistException
+
+
+class DiagnosticInfoTest(DiagnosticInfo):
+    file_path: str
+
+
+file_path = "test_dir"
+os.mkdir(file_path)
+if not os.path.exists(file_path):
+    raise IsNotExistException(
+        subject="Directory",
+        diagnostic_info=DiagnosticInfoTest(
+            file_path=file_path
+        )
+    )
+```
+
+---
+
+### 🤝 Contributing
+If you have a helpful tool, pattern, or improvement to suggest:
+Fork the repo <br>
+Create a new branch <br>
+Submit a pull request <br>
+I welcome additions that promote clean, productive, and maintainable development. <br>
+
+---
+
+### 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding! <br>

python_custom_exceptions-0.0.2/README.md

@@ -0,0 +1,58 @@
+# Python Custom Exceptions
+A repository containing custom exception classes for Python projects. <br>
+These exceptions are designed to provide more specific error handling and improve code readability. 
+They can be easily integrated into any Python application to enhance error management. <br>
+
+---
+
+### Features
+- ✅ Specific Exception Classes: Custom exceptions for various error scenarios.
+- ✅ Improved Readability: Clearer error handling in code.
+- ✅ Easy Integration: Simple to add to existing Python projects.
+- ✅ Standardized Error Handling: Consistent approach to managing exceptions.
+- ✅ Structured Hierarchy: Organized exception classes for better maintainability.
+
+---
+
+### Installation
+```bash
+pip install python-custom-exceptions
+```
+
+---
+
+### Usage Examples
+```python
+import os
+from python_custom_exceptions import DiagnosticInfo, IsNotExistException
+
+
+class DiagnosticInfoTest(DiagnosticInfo):
+    file_path: str
+
+
+file_path = "test_dir"
+os.mkdir(file_path)
+if not os.path.exists(file_path):
+    raise IsNotExistException(
+        subject="Directory",
+        diagnostic_info=DiagnosticInfoTest(
+            file_path=file_path
+        )
+    )
+```
+
+---
+
+### 🤝 Contributing
+If you have a helpful tool, pattern, or improvement to suggest:
+Fork the repo <br>
+Create a new branch <br>
+Submit a pull request <br>
+I welcome additions that promote clean, productive, and maintainable development. <br>
+
+---
+
+### 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding! <br>

python_custom_exceptions-0.0.2/python_custom_exceptions/__init__.py

@@ -0,0 +1,15 @@
+from python_custom_exceptions.base_custom_exception import BaseCustomException, DiagnosticInfo, serialize_data
+from python_custom_exceptions.connection_exceptions import ConnectionException
+from python_custom_exceptions.is_exist_exception import (
+    IsExistException,
+    IsNotExistException,
+)
+
+__all__ = [
+    "BaseCustomException",
+    "DiagnosticInfo",
+    "serialize_data",
+    "ConnectionException",
+    "IsExistException",
+    "IsNotExistException",
+]

python_custom_exceptions-0.0.2/python_custom_exceptions/base_custom_exception.py

@@ -0,0 +1,46 @@
+import json
+from dataclasses import is_dataclass
+from json import dumps
+from typing import TypedDict
+
+from python_base_toolkit.utils.data_serialization import default_serialize
+
+
+class DiagnosticInfo(TypedDict): ...
+
+
+def serialize_data(obj: object) -> dict:
+    return json.loads(json.dumps(obj, default=default_serialize))
+
+
+def get_full_exception_message(content: dict) -> str:
+    return (
+        f'{content["message"]}\n\nCustom Exception Raised!\n'
+        f"{dumps(content, indent=4, sort_keys=False, default=str)}"
+    )
+
+
+class BaseCustomException(Exception):
+    def __init__(
+        self,
+        message_with_marking_dynamic_variables: str,
+        diagnostic_info: dict | DiagnosticInfo | None = None,
+    ) -> None:
+        if is_dataclass(diagnostic_info):
+            diagnostic_info = diagnostic_info.__dict__
+
+        self.exception_type = type(self).__name__
+        self.message = message_with_marking_dynamic_variables
+        self.diagnostic_info = diagnostic_info or {}
+
+    def __str__(self) -> str:
+        exception_content = {
+            "exception_type": self.exception_type,
+            "message": self.message,
+            "diagnostic_info": self.diagnostic_info,
+        }
+        # return get_full_exception_message(exception_content)
+        return dumps(exception_content, indent=4, sort_keys=False, default=str)
+
+    def __repr__(self) -> str:
+        return self.__str__()

python_custom_exceptions-0.0.2/python_custom_exceptions/connection_exceptions.py

@@ -0,0 +1,23 @@
+from python_custom_exceptions.base_custom_exception import BaseCustomException, DiagnosticInfo
+
+
+class ConnectionException(BaseCustomException):
+    def __init__(
+        self,
+        host: str | None,
+        message: str | None = None,
+        diagnostic_info: dict | DiagnosticInfo | None = None,
+    ) -> None:
+        message = (
+            (
+                f'Connection failed: Unable to establish a connection to the remote host ["{host}"]. '
+                f"Please check your credentials, network status, and host availability."
+            )
+            if not message
+            else message
+        )
+
+        super().__init__(
+            message_with_marking_dynamic_variables=message,
+            diagnostic_info=diagnostic_info,
+        )

python_custom_exceptions-0.0.2/python_custom_exceptions/is_exist_exception.py

@@ -0,0 +1,27 @@
+from python_custom_exceptions.base_custom_exception import BaseCustomException, DiagnosticInfo
+
+
+class IsExistException(BaseCustomException):
+    def __init__(
+        self,
+        subject: str,
+        diagnostic_info: dict | DiagnosticInfo | None = None,
+    ) -> None:
+        message = f"[{subject}] is exists"
+        super().__init__(
+            message_with_marking_dynamic_variables=message,
+            diagnostic_info=diagnostic_info,
+        )
+
+
+class IsNotExistException(BaseCustomException):
+    def __init__(
+        self,
+        subject: str,
+        diagnostic_info: dict | DiagnosticInfo | None = None,
+    ) -> None:
+        message = f"[{subject}] is not exists"
+        super().__init__(
+            message_with_marking_dynamic_variables=message,
+            diagnostic_info=diagnostic_info,
+        )

python_custom_exceptions-0.0.2/python_custom_exceptions.egg-info/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: python-custom-exceptions
+Version: 0.0.2
+Summary: A collection of custom exceptions for Python projects.
+Home-page: https://github.com/aviz92/python-custom-exceptions
+Author: Avi Zaguri
+Author-email: 
+Project-URL: Repository, https://github.com/aviz92/python-custom-exceptions
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: wheel
+Requires-Dist: python-dotenv
+Requires-Dist: pre-commit
+Requires-Dist: colorlog
+Requires-Dist: pytest
+Requires-Dist: pathlib
+Requires-Dist: pytest-plugins
+Requires-Dist: custom-python-logger
+Requires-Dist: python-base-toolkit
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Python Custom Exceptions
+A repository containing custom exception classes for Python projects. <br>
+These exceptions are designed to provide more specific error handling and improve code readability. 
+They can be easily integrated into any Python application to enhance error management. <br>
+
+---
+
+### Features
+- ✅ Specific Exception Classes: Custom exceptions for various error scenarios.
+- ✅ Improved Readability: Clearer error handling in code.
+- ✅ Easy Integration: Simple to add to existing Python projects.
+- ✅ Standardized Error Handling: Consistent approach to managing exceptions.
+- ✅ Structured Hierarchy: Organized exception classes for better maintainability.
+
+---
+
+### Installation
+```bash
+pip install python-custom-exceptions
+```
+
+---
+
+### Usage Examples
+```python
+import os
+from python_custom_exceptions import DiagnosticInfo, IsNotExistException
+
+
+class DiagnosticInfoTest(DiagnosticInfo):
+    file_path: str
+
+
+file_path = "test_dir"
+os.mkdir(file_path)
+if not os.path.exists(file_path):
+    raise IsNotExistException(
+        subject="Directory",
+        diagnostic_info=DiagnosticInfoTest(
+            file_path=file_path
+        )
+    )
+```
+
+---
+
+### 🤝 Contributing
+If you have a helpful tool, pattern, or improvement to suggest:
+Fork the repo <br>
+Create a new branch <br>
+Submit a pull request <br>
+I welcome additions that promote clean, productive, and maintainable development. <br>
+
+---
+
+### 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding! <br>

{python_custom_exceptions-0.0.1 → python_custom_exceptions-0.0.2}/python_custom_exceptions.egg-info/SOURCES.txt

@@ -4,8 +4,13 @@ README.md
 pyproject.toml
 requirements.txt
 setup.py
+python_custom_exceptions/__init__.py
+python_custom_exceptions/base_custom_exception.py
+python_custom_exceptions/connection_exceptions.py
+python_custom_exceptions/is_exist_exception.py
 python_custom_exceptions.egg-info/PKG-INFO
 python_custom_exceptions.egg-info/SOURCES.txt
 python_custom_exceptions.egg-info/dependency_links.txt
 python_custom_exceptions.egg-info/requires.txt
-python_custom_exceptions.egg-info/top_level.txt
+python_custom_exceptions.egg-info/top_level.txt
+tests/test_exception.py

{python_custom_exceptions-0.0.1 → python_custom_exceptions-0.0.2}/python_custom_exceptions.egg-info/requires.txt

@@ -1,6 +1,10 @@
 setuptools
 wheel
+python-dotenv
+pre-commit
 colorlog
 pytest
 pathlib
+pytest-plugins
 custom-python-logger
+python-base-toolkit

python_custom_exceptions-0.0.2/python_custom_exceptions.egg-info/top_level.txt

@@ -0,0 +1 @@
+python_custom_exceptions

{python_custom_exceptions-0.0.1 → python_custom_exceptions-0.0.2}/requirements.txt

@@ -1,7 +1,11 @@
 setuptools
 wheel
+python-dotenv
+pre-commit
 colorlog
 pytest
 pathlib
 
+pytest-plugins
 custom-python-logger
+python-base-toolkit

python_custom_exceptions-0.0.2/setup.py

@@ -0,0 +1,35 @@
+from setuptools import find_packages, setup
+
+package_version = "0.0.2"
+
+package_name = "python-custom-exceptions"
+package_description = "A collection of custom exceptions for Python projects."
+
+package_name_ = package_name.replace("-", "_")
+package_long_description_content_type = "text/markdown"
+package_url = f"https://github.com/aviz92/{package_name}"
+package_python_requires = ">=3.11"
+package_author = "Avi Zaguri"
+
+with open("requirements.txt") as file:
+    package_install_requires = [line.strip() for line in file.readlines() if line.strip() and not line.startswith("#")]
+
+with open("README.md") as file:
+    package_long_description = file.read()
+
+setup(
+    name=package_name,
+    version=package_version,
+    packages=find_packages(include=[package_name_, f"{package_name_}.*"]),
+    install_requires=package_install_requires,
+    author=package_author,
+    author_email="",
+    description=package_description,
+    long_description=package_long_description,
+    long_description_content_type=package_long_description_content_type,
+    url=package_url,
+    project_urls={
+        "Repository": package_url,
+    },
+    python_requires=package_python_requires,
+)

python_custom_exceptions-0.0.2/tests/test_exception.py

@@ -0,0 +1,22 @@
+import pytest
+from custom_python_logger import build_logger
+
+from python_custom_exceptions import ConnectionException
+
+logger = build_logger(project_name="custom_exceptions_test")
+
+
+def test_connection_exception():
+    with pytest.raises(ConnectionException) as exc_info:
+        raise ConnectionException(
+            host="Database",
+            message="Connection failed",
+            diagnostic_info={"host": "db.example.com"},
+        )
+    logger.info(f"\n{exc_info.value}")  # noqa
+
+
+def test_connection_exception_without_message():
+    with pytest.raises(ConnectionException) as exc_info:
+        raise ConnectionException(host="Database", diagnostic_info={"host": "db.example.com"})
+    logger.info(f"\n{exc_info.value}")  # noqa

python_custom_exceptions-0.0.1/PKG-INFO

@@ -1,43 +0,0 @@
-Metadata-Version: 2.4
-Name: python-custom-exceptions
-Version: 0.0.1
-Summary: A collection of custom exceptions for Python projects.
-Home-page: https://github.com/aviz92/python-custom-exceptions
-Author: Avi Zaguri
-Author-email: 
-Project-URL: Repository, https://github.com/aviz92/python-custom-exceptions
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: setuptools
-Requires-Dist: wheel
-Requires-Dist: colorlog
-Requires-Dist: pytest
-Requires-Dist: pathlib
-Requires-Dist: custom-python-logger
-Dynamic: author
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# Python Custom Exceptions
-
----
-
-## 🤝 Contributing
-If you have a helpful tool, pattern, or improvement to suggest:
-Fork the repo <br>
-Create a new branch <br>
-Submit a pull request <br>
-I welcome additions that promote clean, productive, and maintainable development. <br>
-
----
-
-## 🙏 Thanks
-Thanks for exploring this repository! <br>
-Happy coding! <br>

python_custom_exceptions-0.0.1/README.md

@@ -1,16 +0,0 @@
-# Python Custom Exceptions
-
----
-
-## 🤝 Contributing
-If you have a helpful tool, pattern, or improvement to suggest:
-Fork the repo <br>
-Create a new branch <br>
-Submit a pull request <br>
-I welcome additions that promote clean, productive, and maintainable development. <br>
-
----
-
-## 🙏 Thanks
-Thanks for exploring this repository! <br>
-Happy coding! <br>

python_custom_exceptions-0.0.1/python_custom_exceptions.egg-info/PKG-INFO

@@ -1,43 +0,0 @@
-Metadata-Version: 2.4
-Name: python-custom-exceptions
-Version: 0.0.1
-Summary: A collection of custom exceptions for Python projects.
-Home-page: https://github.com/aviz92/python-custom-exceptions
-Author: Avi Zaguri
-Author-email: 
-Project-URL: Repository, https://github.com/aviz92/python-custom-exceptions
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: setuptools
-Requires-Dist: wheel
-Requires-Dist: colorlog
-Requires-Dist: pytest
-Requires-Dist: pathlib
-Requires-Dist: custom-python-logger
-Dynamic: author
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# Python Custom Exceptions
-
----
-
-## 🤝 Contributing
-If you have a helpful tool, pattern, or improvement to suggest:
-Fork the repo <br>
-Create a new branch <br>
-Submit a pull request <br>
-I welcome additions that promote clean, productive, and maintainable development. <br>
-
----
-
-## 🙏 Thanks
-Thanks for exploring this repository! <br>
-Happy coding! <br>

python_custom_exceptions-0.0.1/python_custom_exceptions.egg-info/top_level.txt

@@ -1 +0,0 @@
-

python_custom_exceptions-0.0.1/setup.py

@@ -1,37 +0,0 @@
-from setuptools import setup, find_packages
-
-package_version = '0.0.1'
-
-package_name = 'python-custom-exceptions'
-package_description = 'A collection of custom exceptions for Python projects.'
-
-package_name_ = package_name.replace('-', '_')
-package_long_description_content_type = 'text/markdown'
-package_url = f'https://github.com/aviz92/{package_name}'
-package_python_requires = '>=3.11'
-package_author = 'Avi Zaguri'
-
-with open('requirements.txt', 'r') as file:
-    package_install_requires = [
-        line.strip() for line in file.readlines() if line.strip() and not line.startswith('#')
-    ]
-
-with open('README.md', 'r') as file:
-    package_long_description = file.read()
-
-setup(
-    name=package_name,
-    version=package_version,
-    packages=find_packages(include=[package_name_, f'{package_name_}.*']),
-    install_requires=package_install_requires,
-    author=package_author,
-    author_email='',
-    description=package_description,
-    long_description=package_long_description,
-    long_description_content_type=package_long_description_content_type,
-    url=package_url,
-    project_urls={
-        'Repository': package_url,
-    },
-    python_requires=package_python_requires,
-)