baumbelt 0.1.1__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.
@@ -0,0 +1,53 @@
1
+ name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
2
+
3
+ on: push
4
+
5
+ jobs:
6
+ build:
7
+ name: Build distribution 📦
8
+ runs-on: ubuntu-latest
9
+
10
+ steps:
11
+ - uses: actions/checkout@v4
12
+ - name: Set up Python
13
+ uses: actions/setup-python@v5
14
+ with:
15
+ python-version: "3.11"
16
+
17
+ - name: Install pypa/build
18
+ run: >-
19
+ python3 -m
20
+ pip install
21
+ build
22
+ --user
23
+ - name: Build a binary wheel and a source tarball
24
+ run: python3 -m build
25
+ - name: Store the distribution packages
26
+ uses: actions/upload-artifact@v3
27
+ with:
28
+ name: python-package-distributions
29
+ path: dist/
30
+
31
+ publish-to-testpypi:
32
+ name: Publish Python 🐍 distribution 📦 to TestPyPI
33
+ needs:
34
+ - build
35
+ runs-on: ubuntu-latest
36
+
37
+ environment:
38
+ name: testpypi
39
+ url: https://test.pypi.org/p/baumbelt
40
+
41
+ permissions:
42
+ id-token: write # IMPORTANT: mandatory for trusted publishing
43
+
44
+ steps:
45
+ - name: Download all the dists
46
+ uses: actions/download-artifact@v3
47
+ with:
48
+ name: python-package-distributions
49
+ path: dist/
50
+ - name: Publish distribution 📦 to TestPyPI
51
+ uses: pypa/gh-action-pypi-publish@release/v1
52
+ with:
53
+ repository-url: https://test.pypi.org/legacy/
@@ -0,0 +1,9 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *$py.class
4
+
5
+ dist/
6
+
7
+ venv/
8
+ .idea/
9
+ .local/
@@ -0,0 +1,12 @@
1
+ # Install dev dependencies
2
+
3
+ Run `pip install ".[dev]"`
4
+
5
+ # Build
6
+
7
+ Run `python -m build` in the repository root.
8
+
9
+ # Testing
10
+
11
+ Run `PYTHONPATH=src pytest`
12
+ `
baumbelt-0.1.1/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,107 @@
1
+ Metadata-Version: 2.3
2
+ Name: baumbelt
3
+ Version: 0.1.1
4
+ Summary: A collection of Python utility functions by Tenhil GmbH & Co. KG
5
+ Project-URL: Homepage, https://github.com/Tenhil-GmbH-Co-KG/baumbelt
6
+ Project-URL: Issues, https://github.com/Tenhil-GmbH-Co-KG/baumbelt/issues
7
+ Author: Watte
8
+ License-File: LICENSE
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Topic :: Software Development
14
+ Classifier: Topic :: Utilities
15
+ Requires-Python: >=3.8
16
+ Provides-Extra: dev
17
+ Requires-Dist: black==24.4.2; extra == 'dev'
18
+ Requires-Dist: build==1.2.1; extra == 'dev'
19
+ Requires-Dist: pytest==8.2.1; extra == 'dev'
20
+ Requires-Dist: twine==5.1.0; extra == 'dev'
21
+ Provides-Extra: django
22
+ Requires-Dist: django==5.0.6; extra == 'django'
23
+ Description-Content-Type: text/markdown
24
+
25
+ # baumbelt
26
+
27
+ Curated collection of handy utility functions for Python by the Tenhil GmbH.
28
+
29
+ # Installation
30
+
31
+ Run `pip install baumbelt`
32
+
33
+ # Utilities
34
+
35
+ ## EnumContainsMeta
36
+
37
+ `baumbelt.enum.EnumContainsMeta` offers a metaclass, that adds the syntactic sugar of member checks. The default `Enum` only allows checks for values:
38
+
39
+ ```python
40
+ from enum import Enum
41
+ from baumbelt.enum import EnumContainsMeta
42
+
43
+
44
+ class AtomEnum(Enum, metaclass=EnumContainsMeta):
45
+ hydrogen = 1
46
+ helium = 2
47
+
48
+
49
+ "hydrogen" in AtomEnum # True
50
+ 2 in AtomEnum # True
51
+ "water" in AtomEnum # False
52
+ ```
53
+
54
+ ## MeasureTime
55
+
56
+ The `baumbelt.time.MeasureTime` class can be used as a context manager to have a syntactically nice way to measure the time a block of code takes.
57
+ The following two snippets produce the same result.
58
+
59
+ Vanilla:
60
+
61
+ ```python
62
+ from datetime import datetime
63
+
64
+ t0 = datetime.now()
65
+ this_call_takes_a_while()
66
+ tend = datetime.now() - t0
67
+
68
+ print(f"{tend} ({tend.total_seconds()}s)")
69
+ ```
70
+
71
+ and with `MeasureTime`:
72
+
73
+ ```python
74
+ from baumbelt.time import MeasureTime
75
+
76
+ with MeasureTime() as mt:
77
+ this_call_takes_a_while()
78
+ print(mt)
79
+ ```
80
+
81
+ ## HuggingLog
82
+
83
+ `baumbelt.logging.HuggingLog` offers a convenient way to print the duration a specific code block took. It utilizes [MeasureTime](#measuretime) and adds a bit of printing around it. You can also pass
84
+ a different logging function, for instance `logger.debug`. This comes especially comes in handy, if you run in detached environment (eg: cronjob).
85
+
86
+ ```python
87
+ from baumbelt.logging import HuggingLog
88
+ import logging
89
+
90
+ logger = logging.getLogger(__name__)
91
+
92
+ with HuggingLog("cross-compile doom", logging_fn=logger.debug, prefix="[ARM]"):
93
+ # compile hard
94
+ ...
95
+ ```
96
+
97
+ This outputs something like:
98
+
99
+ ```
100
+ (2629) [DEBUG] 2024-05-28 14:49:51,616 - logging#32 - [ARM]: Start 'cross-compile doom'...
101
+ (2629) [DEBUG] 2024-05-28 14:49:53,616 - logging#41 - [ARM]: Finish 'cross-compile doom' in 0:00:02.000204 (2.000204s total)
102
+ ```
103
+
104
+ > Vigilant readers may notice the log-origin "logging#32" and "logging#41". These origins are from inside the utility and probably not very useful. You can circumvent this by passing a lambda:
105
+ >
106
+ > `with HuggingLog(..., logging_fn=lambda s: logger.debug(s)):`
107
+
@@ -0,0 +1,83 @@
1
+ # baumbelt
2
+
3
+ Curated collection of handy utility functions for Python by the Tenhil GmbH.
4
+
5
+ # Installation
6
+
7
+ Run `pip install baumbelt`
8
+
9
+ # Utilities
10
+
11
+ ## EnumContainsMeta
12
+
13
+ `baumbelt.enum.EnumContainsMeta` offers a metaclass, that adds the syntactic sugar of member checks. The default `Enum` only allows checks for values:
14
+
15
+ ```python
16
+ from enum import Enum
17
+ from baumbelt.enum import EnumContainsMeta
18
+
19
+
20
+ class AtomEnum(Enum, metaclass=EnumContainsMeta):
21
+ hydrogen = 1
22
+ helium = 2
23
+
24
+
25
+ "hydrogen" in AtomEnum # True
26
+ 2 in AtomEnum # True
27
+ "water" in AtomEnum # False
28
+ ```
29
+
30
+ ## MeasureTime
31
+
32
+ The `baumbelt.time.MeasureTime` class can be used as a context manager to have a syntactically nice way to measure the time a block of code takes.
33
+ The following two snippets produce the same result.
34
+
35
+ Vanilla:
36
+
37
+ ```python
38
+ from datetime import datetime
39
+
40
+ t0 = datetime.now()
41
+ this_call_takes_a_while()
42
+ tend = datetime.now() - t0
43
+
44
+ print(f"{tend} ({tend.total_seconds()}s)")
45
+ ```
46
+
47
+ and with `MeasureTime`:
48
+
49
+ ```python
50
+ from baumbelt.time import MeasureTime
51
+
52
+ with MeasureTime() as mt:
53
+ this_call_takes_a_while()
54
+ print(mt)
55
+ ```
56
+
57
+ ## HuggingLog
58
+
59
+ `baumbelt.logging.HuggingLog` offers a convenient way to print the duration a specific code block took. It utilizes [MeasureTime](#measuretime) and adds a bit of printing around it. You can also pass
60
+ a different logging function, for instance `logger.debug`. This comes especially comes in handy, if you run in detached environment (eg: cronjob).
61
+
62
+ ```python
63
+ from baumbelt.logging import HuggingLog
64
+ import logging
65
+
66
+ logger = logging.getLogger(__name__)
67
+
68
+ with HuggingLog("cross-compile doom", logging_fn=logger.debug, prefix="[ARM]"):
69
+ # compile hard
70
+ ...
71
+ ```
72
+
73
+ This outputs something like:
74
+
75
+ ```
76
+ (2629) [DEBUG] 2024-05-28 14:49:51,616 - logging#32 - [ARM]: Start 'cross-compile doom'...
77
+ (2629) [DEBUG] 2024-05-28 14:49:53,616 - logging#41 - [ARM]: Finish 'cross-compile doom' in 0:00:02.000204 (2.000204s total)
78
+ ```
79
+
80
+ > Vigilant readers may notice the log-origin "logging#32" and "logging#41". These origins are from inside the utility and probably not very useful. You can circumvent this by passing a lambda:
81
+ >
82
+ > `with HuggingLog(..., logging_fn=lambda s: logger.debug(s)):`
83
+
baumbelt-0.1.1/TODO.md ADDED
@@ -0,0 +1,2 @@
1
+ * tests
2
+ * right now, you'd have to run `PYTHONPATH=src/ pytest` otherwise there will be ModuleNotFound, there should be a better way
@@ -0,0 +1,42 @@
1
+ [project]
2
+ name = "baumbelt"
3
+ version = "0.1.1"
4
+ authors = [
5
+ { name = "Watte" },
6
+ ]
7
+ description = "A collection of Python utility functions by Tenhil GmbH & Co. KG"
8
+ readme = "README.md"
9
+ requires-python = ">=3.8"
10
+ classifiers = [
11
+ "Programming Language :: Python :: 3",
12
+ "License :: OSI Approved :: MIT License",
13
+ "Operating System :: OS Independent",
14
+ "Intended Audience :: Developers",
15
+ "Topic :: Software Development",
16
+ "Topic :: Utilities",
17
+ ]
18
+
19
+ [project.urls]
20
+ Homepage = "https://github.com/Tenhil-GmbH-Co-KG/baumbelt"
21
+ Issues = "https://github.com/Tenhil-GmbH-Co-KG/baumbelt/issues"
22
+
23
+ [project.optional-dependencies]
24
+ dev = [
25
+ "black==24.4.2",
26
+ "build==1.2.1",
27
+ "pytest==8.2.1",
28
+ "twine==5.1.0"
29
+ ]
30
+ django = [
31
+ "django==5.0.6"
32
+ ]
33
+
34
+ [build-system]
35
+ requires = ["hatchling"]
36
+ build-backend = "hatchling.build"
37
+
38
+ [tool.hatch.build.targets.wheel]
39
+ packages = ["src/baumbelt"]
40
+
41
+ [tool.black]
42
+ line-length = 120
@@ -0,0 +1 @@
1
+ # coding=utf-8
@@ -0,0 +1,24 @@
1
+ from enum import EnumMeta
2
+
3
+
4
+ class EnumContainsMeta(EnumMeta):
5
+ """
6
+ Constructing Enums with this metaclass will allow for `in` checks.
7
+ Note, that this only checks for the existence in the Enum members,
8
+ not the respective values. Similar to dictionary lookups: `"key" in dict_instance`
9
+
10
+ ```
11
+ class AtomEnum(Enum, metaclass=EnumContainsMeta):
12
+ hydrogen = 1
13
+ helium = 2
14
+ lithium = 3
15
+ neon = 10
16
+
17
+ "hydrogen" in AtomEnum # True
18
+ "sulfur" in AtomEnum # False
19
+ "water" not in AtomEnum # True
20
+ ```
21
+ """
22
+
23
+ def __contains__(cls, item):
24
+ return item in cls.__members__
@@ -0,0 +1,27 @@
1
+ from typing import Callable, Any
2
+
3
+ from baumbelt.time import MeasureTime
4
+
5
+
6
+ class HuggingLog:
7
+ timer: MeasureTime
8
+ name: str
9
+ prefix: str
10
+ logging_fn: Callable[[str], Any]
11
+
12
+ def __init__(self, name: str, logging_fn: Callable[[str], Any] = print, prefix: str | None = None):
13
+ self.name = name
14
+ self.prefix = f"{prefix}: " if prefix else ""
15
+ self.logging_fn = logging_fn
16
+
17
+ def __enter__(self):
18
+ self.logging_fn(f"{self.prefix}Start '{self.name}'...")
19
+ self.timer = MeasureTime().__enter__()
20
+
21
+ def __exit__(self, exc_type, exc_val, exc_tb):
22
+ if not self.timer:
23
+ return
24
+
25
+ self.timer.__exit__(exc_type, exc_val, exc_tb)
26
+ duration_str = f"{self.timer.duration} ({self.timer.duration.total_seconds():f}s total)"
27
+ self.logging_fn(f"{self.prefix}Finish '{self.name}' in {duration_str}")
@@ -0,0 +1,18 @@
1
+ from datetime import timedelta, datetime
2
+
3
+
4
+ class MeasureTime:
5
+ duration: timedelta
6
+ start: datetime
7
+
8
+ def __enter__(self):
9
+ self.start = datetime.now()
10
+ return self
11
+
12
+ def __exit__(self, exc_type, exc_val, exc_tb):
13
+ self.duration = datetime.now() - self.start
14
+
15
+ def __str__(self):
16
+ if self.duration is None:
17
+ self.duration = datetime.now() - self.start
18
+ return f"{self.duration} ({self.duration.total_seconds()}s)"
@@ -0,0 +1 @@
1
+ # coding=utf-8
@@ -0,0 +1,21 @@
1
+ from enum import Enum
2
+ from unittest import TestCase
3
+
4
+ from baumbelt.enum import EnumContainsMeta
5
+
6
+
7
+ class AtomEnum(Enum, metaclass=EnumContainsMeta):
8
+ hydrogen = 1
9
+ helium = 2
10
+ lithium = 3
11
+ neon = 10
12
+
13
+
14
+ class EnumContainsTestCase(TestCase):
15
+
16
+ def test_enum_contains(self):
17
+ self.assertIn("hydrogen", AtomEnum)
18
+ self.assertIn("helium", AtomEnum)
19
+ self.assertIn("lithium", AtomEnum)
20
+ self.assertIn("neon", AtomEnum)
21
+ self.assertNotIn("water", AtomEnum)
@@ -0,0 +1,41 @@
1
+ import contextlib
2
+ import io
3
+ from unittest import TestCase
4
+
5
+ from baumbelt.logging import HuggingLog
6
+ from tests.utils import strip_duration_and_seconds
7
+
8
+
9
+ class HuggingLogTestCase(TestCase):
10
+
11
+ def test_hugging_log_print_default(self):
12
+ buffer = io.StringIO()
13
+ with contextlib.redirect_stdout(buffer), HuggingLog("cross-compile doom"):
14
+ ...
15
+
16
+ msg = strip_duration_and_seconds(buffer.getvalue())
17
+ self.assertEqual(msg, "Start 'cross-compile doom'...\nFinish 'cross-compile doom' in <duration>\n")
18
+
19
+ def test_hugging_log_logging_fn(self):
20
+ buffer = ""
21
+
22
+ def logging_fn(string):
23
+ nonlocal buffer
24
+ buffer += string
25
+
26
+ with HuggingLog("cross-compile doom", logging_fn=logging_fn):
27
+ ...
28
+
29
+ msg = strip_duration_and_seconds(buffer)
30
+ self.assertEqual(msg, "Start 'cross-compile doom'...Finish 'cross-compile doom' in <duration>")
31
+
32
+ def test_hugging_log_prefix(self):
33
+ buffer = io.StringIO()
34
+ with contextlib.redirect_stdout(buffer), HuggingLog("cross-compile doom", prefix="[ARM]"):
35
+ ...
36
+
37
+ msg = strip_duration_and_seconds(buffer.getvalue())
38
+ self.assertEqual(
39
+ msg,
40
+ "[ARM]: Start 'cross-compile doom'...\n[ARM]: Finish 'cross-compile doom' in <duration>\n",
41
+ )
@@ -0,0 +1,26 @@
1
+ import re
2
+ import time
3
+ from datetime import datetime
4
+ from unittest import TestCase
5
+
6
+ from baumbelt.time import MeasureTime
7
+
8
+
9
+ class MeasureTimeTestCase(TestCase):
10
+
11
+ def test_duration(self):
12
+ t0 = datetime.now()
13
+
14
+ with MeasureTime() as mt:
15
+ time.sleep(0.3)
16
+ tduration = datetime.now() - t0
17
+
18
+ self.assertAlmostEqual(mt.duration.total_seconds(), tduration.total_seconds(), places=2)
19
+
20
+ def test_duration_string(self):
21
+ with MeasureTime() as mt:
22
+ time.sleep(0.3)
23
+
24
+ formatted_duration = str(mt)
25
+ match = re.search(r"^0:00:00\.3\d+ \(0\.3\d+s\)$", formatted_duration)
26
+ self.assertIsNotNone(match)
@@ -0,0 +1,15 @@
1
+ # coding=utf-8
2
+ import re
3
+
4
+
5
+ def strip_duration_and_seconds(timer_msg: str) -> str:
6
+ """
7
+ For a string like:
8
+ "Finish 'cross-compile doom' in 0:00:00.000002 (0.000002s total)"
9
+
10
+ this replaces the whobbly time parts, so it becomes:
11
+ "Finish 'cross-compile doom' in <duration>"
12
+ """
13
+
14
+ timer_msg = re.sub(r"(.* in )0:00:.*", r"\1<duration>", timer_msg)
15
+ return timer_msg