catchlib 1.0.8__tar.gz → 1.0.9__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1,2 @@
1
+ recursive-include docs *.rst
1
2
  recursive-include src/catchlib *.toml
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: catchlib
3
- Version: 1.0.8
3
+ Version: 1.0.9
4
4
  Summary: This project allows to catch exceptions easily.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
@@ -0,0 +1,69 @@
1
+ Introduction
2
+ ------------
3
+
4
+ This project allows to catch exceptions easily.
5
+
6
+ Installation
7
+ ------------
8
+
9
+ To install catchlib, you can use pip. Open your terminal and run:
10
+
11
+ .. code-block:: shell
12
+
13
+ pip install catchlib
14
+
15
+ Features
16
+ --------
17
+
18
+ ``class catchlib.Catcher()``
19
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
+
21
+ This class allows to catch exceptions.
22
+
23
+ ``catch(*args: type[BaseException]) -> contextlib.ContextDecorator``
24
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25
+
26
+ This contextmanager catches exceptions of the given types.
27
+
28
+ ``caught: Optional[BaseException] = None``
29
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
30
+
31
+ This property stores the caught exception.
32
+
33
+ ``release() -> None`` ``release(cause: Optional[BaseException]) -> None``
34
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35
+
36
+ This method raises and deletes the ``caught`` exception.
37
+
38
+ ``catchlib.test() -> unittest.TextTestResult``
39
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40
+
41
+ This project can be tested through its test function.
42
+
43
+ .. code-block:: python
44
+
45
+ import catchlib
46
+ catchlib.test()
47
+
48
+ License
49
+ -------
50
+
51
+ This project is licensed under the MIT License.
52
+
53
+ Links
54
+ -----
55
+
56
+ - Download: https://pypi.org/project/catchlib/#files
57
+ - Index: https://pypi.org/project/catchlib/
58
+ - Source: https://github.com/johannes-programming/catchlib/
59
+ - Website: https://catchlib.johannes-programming.online/
60
+
61
+ Impressum
62
+ ---------
63
+
64
+ **Johannes Programming**
65
+
66
+ - Name: Johannes
67
+ - Email: johannes.programming@gmail.com
68
+ - Homepage: https://www.johannes-programming.online/
69
+ - Gravatar: https://www.johannes-programming.fyi/
@@ -26,7 +26,7 @@ license-files = [
26
26
  name = "catchlib"
27
27
  readme = "README.rst"
28
28
  requires-python = ">=3.11"
29
- version = "1.0.8"
29
+ version = "1.0.9"
30
30
 
31
31
  [project.urls]
32
32
  Download = "https://pypi.org/project/catchlib/#files"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: catchlib
3
- Version: 1.0.8
3
+ Version: 1.0.9
4
4
  Summary: This project allows to catch exceptions easily.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
@@ -3,6 +3,7 @@ MANIFEST.in
3
3
  README.rst
4
4
  pyproject.toml
5
5
  setup.cfg
6
+ docs/v1.0.rst
6
7
  src/catchlib/__init__.py
7
8
  src/catchlib.egg-info/PKG-INFO
8
9
  src/catchlib.egg-info/SOURCES.txt
File without changes
File without changes
File without changes