vt-commons 0.0.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.
Files changed (26) hide show
  1. vt_commons-0.0.1/LICENSE +201 -0
  2. vt_commons-0.0.1/PKG-INFO +112 -0
  3. vt_commons-0.0.1/README.md +84 -0
  4. vt_commons-0.0.1/pyproject.toml +83 -0
  5. vt_commons-0.0.1/setup.cfg +4 -0
  6. vt_commons-0.0.1/src/vt/utils/commons/commons/__init__.py +6 -0
  7. vt_commons-0.0.1/src/vt/utils/commons/commons/collections/__init__.py +9 -0
  8. vt_commons-0.0.1/src/vt/utils/commons/commons/collections/utils.py +110 -0
  9. vt_commons-0.0.1/src/vt/utils/commons/commons/core_py/__init__.py +42 -0
  10. vt_commons-0.0.1/src/vt/utils/commons/commons/core_py/base.py +47 -0
  11. vt_commons-0.0.1/src/vt/utils/commons/commons/core_py/utils.py +827 -0
  12. vt_commons-0.0.1/src/vt/utils/commons/commons/op/__init__.py +11 -0
  13. vt_commons-0.0.1/src/vt/utils/commons/commons/op/base.py +121 -0
  14. vt_commons-0.0.1/src/vt/utils/commons/commons/os/__init__.py +18 -0
  15. vt_commons-0.0.1/src/vt/utils/commons/commons/os/_base_utils.py +17 -0
  16. vt_commons-0.0.1/src/vt/utils/commons/commons/os/linux.py +29 -0
  17. vt_commons-0.0.1/src/vt/utils/commons/commons/os/mac.py +29 -0
  18. vt_commons-0.0.1/src/vt/utils/commons/commons/os/posix.py +30 -0
  19. vt_commons-0.0.1/src/vt/utils/commons/commons/os/windows.py +29 -0
  20. vt_commons-0.0.1/src/vt/utils/commons/commons/py.typed +0 -0
  21. vt_commons-0.0.1/src/vt/utils/commons/commons/state/__init__.py +13 -0
  22. vt_commons-0.0.1/src/vt/utils/commons/commons/state/done.py +163 -0
  23. vt_commons-0.0.1/src/vt_commons.egg-info/PKG-INFO +112 -0
  24. vt_commons-0.0.1/src/vt_commons.egg-info/SOURCES.txt +24 -0
  25. vt_commons-0.0.1/src/vt_commons.egg-info/dependency_links.txt +1 -0
  26. vt_commons-0.0.1/src/vt_commons.egg-info/top_level.txt +1 -0
@@ -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 2025 Vaastav Technologies (OPC) Private Limited
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,112 @@
1
+ Metadata-Version: 2.4
2
+ Name: vt-commons
3
+ Version: 0.0.1
4
+ Summary: Reusable common utilities, interfaces and implementations for python projects.
5
+ Author-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
6
+ Maintainer-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
7
+ License-Expression: Apache-2.0
8
+ Project-URL: homepage, https://github.com/Vaastav-Technologies/py-commons
9
+ Project-URL: source, https://github.com/Vaastav-Technologies/py-commons
10
+ Project-URL: issues, https://github.com/Vaastav-Technologies/py-commons/issues
11
+ Classifier: Development Status :: 1 - Planning
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Education
14
+ Classifier: Topic :: Education
15
+ Classifier: Topic :: Software Development :: Libraries
16
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
+ Classifier: Topic :: Utilities
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
+ Classifier: Programming Language :: Python :: 3.15
22
+ Classifier: Programming Language :: Python :: 3 :: Only
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.12
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Dynamic: license-file
28
+
29
+ # vt-commons
30
+
31
+ [![🔧 test](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/test.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/test.yml)
32
+ [![💡 typecheck](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/typecheck.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/typecheck.yml)
33
+ [![🛠️ lint](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/lint.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/lint.yml)
34
+ [![📊 coverage](https://codecov.io/gh/Vaastav-Technologies/py-commons/branch/main/graph/badge.svg)](https://codecov.io/gh/Vaastav-Technologies/py-commons)
35
+ [![📤 Upload Python Package](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/python-publish.yml)
36
+
37
+ ---
38
+ Commons methods, utils, interfaces and implementations for python projects.
39
+
40
+ ### Install
41
+
42
+ ```shell
43
+ pip install vt-commons
44
+ ```
45
+
46
+ #### Usage examples
47
+
48
+ - Check for OS
49
+ ```python
50
+ from vt.utils.commons.commons.os import is_windows
51
+
52
+ is_windows()
53
+ ```
54
+ Check in `vt.utils.commons.commons.os` and documentation for more functions and utilities related to OS.
55
+ - Perform some operation on a root directory
56
+ ```python
57
+ from vt.utils.commons.commons.op import RootDirOp, CWDRootDirOp, RootDirOps
58
+ from pathlib import Path
59
+
60
+ class MyRootDirectoryOperation(RootDirOp):
61
+ ...
62
+ @property
63
+ def root_dir(self)-> Path:
64
+ return Path('path', 'to', 'my', 'root-directory')
65
+
66
+ certain_root_dir_operation: CWDRootDirOp = RootDirOps.from_path(Path('path', 'to', 'my', 'root-directory'))
67
+ ```
68
+ Check in `vt.utils.commons.commons.op` and documentation for more functions and utilities related to operations.
69
+ - Perform state operations
70
+ ```python
71
+ from vt.utils.commons.commons.state import DoneMarker
72
+
73
+ # Track state by marking done
74
+ class MyStateManager(DoneMarker[int]):
75
+ def __init__(self, *args, **kwargs):
76
+ self.id_state = {1: False}
77
+ ...
78
+
79
+ def mark_done(self, _id: int)-> bool:
80
+ # mark done for _id
81
+ if self.id_state[_id] is True:
82
+ return False
83
+ self.id_state[_id] = True
84
+ return True
85
+ ```
86
+ Check in `vt.utils.commons.commons.state` and documentation for more functions and utilities related to tracking state.
87
+ - Check if a value is `MISSING`
88
+ ```python
89
+ from vt.utils.commons.commons.core_py import MISSING, Missing, is_missing
90
+
91
+ def some_operation(arg: Missing = MISSING):
92
+ """
93
+ ``MISSING`` can be used as a default value sentinel when ``None`` is a valid value for arg.
94
+ """
95
+ arg = 10 if is_missing(arg) else arg
96
+ ...
97
+ ```
98
+ Check in `vt.utils.commons.commons.core_py` and documentation for more functions and utilities related to function management.
99
+ - Query and operate on iterables
100
+ ```python
101
+ from vt.utils.commons.commons.collections import get_first_true
102
+
103
+ assert 3 == get_first_true([1, 3, 5, 7, 2, 1], 8, lambda x: x>2)
104
+ ```
105
+ Check in `vt.utils.commons.commons.collections` and documentation for more functions and utilities related to collection management.
106
+
107
+
108
+ ### Contribute
109
+
110
+ Want to contribute?
111
+
112
+ Checkout [Guidelines for contributions](CONTRIBUTING.md).
@@ -0,0 +1,84 @@
1
+ # vt-commons
2
+
3
+ [![🔧 test](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/test.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/test.yml)
4
+ [![💡 typecheck](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/typecheck.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/typecheck.yml)
5
+ [![🛠️ lint](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/lint.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/lint.yml)
6
+ [![📊 coverage](https://codecov.io/gh/Vaastav-Technologies/py-commons/branch/main/graph/badge.svg)](https://codecov.io/gh/Vaastav-Technologies/py-commons)
7
+ [![📤 Upload Python Package](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/python-publish.yml)
8
+
9
+ ---
10
+ Commons methods, utils, interfaces and implementations for python projects.
11
+
12
+ ### Install
13
+
14
+ ```shell
15
+ pip install vt-commons
16
+ ```
17
+
18
+ #### Usage examples
19
+
20
+ - Check for OS
21
+ ```python
22
+ from vt.utils.commons.commons.os import is_windows
23
+
24
+ is_windows()
25
+ ```
26
+ Check in `vt.utils.commons.commons.os` and documentation for more functions and utilities related to OS.
27
+ - Perform some operation on a root directory
28
+ ```python
29
+ from vt.utils.commons.commons.op import RootDirOp, CWDRootDirOp, RootDirOps
30
+ from pathlib import Path
31
+
32
+ class MyRootDirectoryOperation(RootDirOp):
33
+ ...
34
+ @property
35
+ def root_dir(self)-> Path:
36
+ return Path('path', 'to', 'my', 'root-directory')
37
+
38
+ certain_root_dir_operation: CWDRootDirOp = RootDirOps.from_path(Path('path', 'to', 'my', 'root-directory'))
39
+ ```
40
+ Check in `vt.utils.commons.commons.op` and documentation for more functions and utilities related to operations.
41
+ - Perform state operations
42
+ ```python
43
+ from vt.utils.commons.commons.state import DoneMarker
44
+
45
+ # Track state by marking done
46
+ class MyStateManager(DoneMarker[int]):
47
+ def __init__(self, *args, **kwargs):
48
+ self.id_state = {1: False}
49
+ ...
50
+
51
+ def mark_done(self, _id: int)-> bool:
52
+ # mark done for _id
53
+ if self.id_state[_id] is True:
54
+ return False
55
+ self.id_state[_id] = True
56
+ return True
57
+ ```
58
+ Check in `vt.utils.commons.commons.state` and documentation for more functions and utilities related to tracking state.
59
+ - Check if a value is `MISSING`
60
+ ```python
61
+ from vt.utils.commons.commons.core_py import MISSING, Missing, is_missing
62
+
63
+ def some_operation(arg: Missing = MISSING):
64
+ """
65
+ ``MISSING`` can be used as a default value sentinel when ``None`` is a valid value for arg.
66
+ """
67
+ arg = 10 if is_missing(arg) else arg
68
+ ...
69
+ ```
70
+ Check in `vt.utils.commons.commons.core_py` and documentation for more functions and utilities related to function management.
71
+ - Query and operate on iterables
72
+ ```python
73
+ from vt.utils.commons.commons.collections import get_first_true
74
+
75
+ assert 3 == get_first_true([1, 3, 5, 7, 2, 1], 8, lambda x: x>2)
76
+ ```
77
+ Check in `vt.utils.commons.commons.collections` and documentation for more functions and utilities related to collection management.
78
+
79
+
80
+ ### Contribute
81
+
82
+ Want to contribute?
83
+
84
+ Checkout [Guidelines for contributions](CONTRIBUTING.md).
@@ -0,0 +1,83 @@
1
+ [build-system]
2
+ # A list of packages that are needed to build your package:
3
+ requires = ["setuptools", "wheel"] # REQUIRED if [build-system] table is used
4
+ # The name of the Python object that frontends will use to perform the build:
5
+ build-backend = "setuptools.build_meta" # If not defined, then legacy behavior can happen.
6
+
7
+
8
+ [project]
9
+ name = "vt-commons"
10
+ version = "0.0.1"
11
+ description = "Reusable common utilities, interfaces and implementations for python projects."
12
+ readme = "README.md"
13
+ authors = [
14
+ {name = "Suhas Krishna Srivastava", email = "suhas.srivastava@vaastav.tech"}
15
+ ]
16
+ maintainers = [
17
+ {name = "Suhas Krishna Srivastava", email = "suhas.srivastava@vaastav.tech"}
18
+ ]
19
+ requires-python = ">=3.12"
20
+ # For a list of valid classifiers, see https://pypi.org/classifiers/
21
+ classifiers = [
22
+ "Development Status :: 1 - Planning",
23
+
24
+ "Intended Audience :: Developers",
25
+ "Intended Audience :: Education",
26
+
27
+ "Topic :: Education",
28
+ "Topic :: Software Development :: Libraries",
29
+ "Topic :: Software Development :: Libraries :: Python Modules",
30
+ "Topic :: Utilities",
31
+
32
+ # Specify the Python versions you support here. In particular, ensure
33
+ # that you indicate you support Python 3. These classifiers are *not*
34
+ # checked by "pip install". See instead "requires-python" key in this file.
35
+ "Programming Language :: Python :: 3.12",
36
+ "Programming Language :: Python :: 3.13",
37
+ "Programming Language :: Python :: 3.14",
38
+ "Programming Language :: Python :: 3.15",
39
+ "Programming Language :: Python :: 3 :: Only",
40
+
41
+ "Typing :: Typed"
42
+ ]
43
+ license = "Apache-2.0"
44
+
45
+ [project.urls]
46
+ homepage = "https://github.com/Vaastav-Technologies/py-commons"
47
+ source = "https://github.com/Vaastav-Technologies/py-commons"
48
+ issues = "https://github.com/Vaastav-Technologies/py-commons/issues"
49
+
50
+
51
+ [dependency-groups]
52
+ dev = ["mypy", "ruff"]
53
+ doc = ['sphinx', 'sphinx-argparse']
54
+ test = ['pytest', 'pytest-cov']
55
+ multitest = ['tox']
56
+
57
+ [tool.setuptools.packages.find]
58
+ where = ["src"]
59
+ namespaces = true
60
+
61
+ [tool.tox]
62
+ legacy_tox_ini = """
63
+ [tox]
64
+ env_list =
65
+ py312
66
+
67
+ [testenv]
68
+ deps =
69
+ pytest
70
+ sphinx
71
+ sphinx-argparse
72
+ commands =
73
+ python -m pytest --doctest-glob=*.rst --doctest-modules .
74
+ python -m doctest README.md
75
+ sphinx-build -q -b doctest docs/source docs/build/doctest
76
+
77
+ [testenv:docs]
78
+ deps =
79
+ sphinx
80
+ sphinx-argparse
81
+ commands =
82
+ sphinx-build -q -b html docs/source docs/build/html
83
+ """
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env python3
2
+ # coding=utf-8
3
+
4
+ """
5
+ Reusable common utilities, interfaces and implementations for python projects.
6
+ """
@@ -0,0 +1,9 @@
1
+ #!/usr/bin/env python3
2
+ # coding=utf-8
3
+
4
+ """
5
+ Reusable common utilities, interfaces and implementations for python projects related to collections.
6
+ """
7
+
8
+ from vt.utils.commons.commons.collections.utils import get_first_true as get_first_true
9
+ from vt.utils.commons.commons.collections.utils import get_last_true as get_last_true
@@ -0,0 +1,110 @@
1
+ #!/usr/bin/env python3
2
+ # coding=utf-8
3
+
4
+ """
5
+ Reusable common utilities for python projects related to collections.
6
+ """
7
+
8
+ from collections.abc import Sequence, Callable, Iterator
9
+
10
+
11
+ def get_first_true[T](
12
+ ids: Sequence[T],
13
+ default_val: T,
14
+ predicate: Callable[[T], bool],
15
+ iter_provider: Callable[[Sequence[T]], Iterator[T]] = iter,
16
+ ) -> T:
17
+ """
18
+ Get the first id which returns ``True`` from the supplied ``predicate`` else get the ``default_val``.
19
+
20
+ Examples:
21
+
22
+ * First id is returned if all ``ids`` are inferred as ``True``::
23
+
24
+ >>> get_first_true([1, 2, 3], -1, lambda x: True)
25
+ 1
26
+
27
+ * Default id is returned if no ``ids`` are inferred as ``True``::
28
+
29
+ >>> get_first_true([1, 2, 3], -1, lambda x: False)
30
+ -1
31
+
32
+ Error scenarios:
33
+
34
+ * supplied predicate is not a callable::
35
+
36
+ >>> get_first_true([1, 2, 3], -1,
37
+ ... object()) # noqa: to avoid typecheck warnings, expects (x)->bool Callable
38
+ Traceback (most recent call last):
39
+ TypeError: predicate must be a (x) -> bool Callable. Supplied <class 'object'>.
40
+
41
+ * suppplied predicate is a non-conforming callable::
42
+
43
+ >>> get_first_true([1, 2, 3], -1,
44
+ ... lambda x, y: True) # noqa: to avoid typecheck warnings, expects (x)->bool Callable.
45
+ Traceback (most recent call last):
46
+ TypeError: <lambda>() missing 1 required positional argument: 'y'
47
+
48
+ :param ids: sequence of id(s) from which the first ever ``predicate`` determined truthy id is to be found.
49
+ :param default_val: value returned if no id is found as truthy from the ``ids`` list according to the supplied
50
+ ``predicate``.
51
+ :param predicate: predicate to determine whether an id is inferred as satisfying and hence returning ``True`` for
52
+ that id.
53
+ :param iter_provider: iterator provider for the ``ids`` sequence.
54
+ :return: the first id from the list of ``ids`` which returns ``True`` by the ``predicate`` or ``default_val`` if
55
+ the ``predicate`` returns ``True`` for no id(s).
56
+ """
57
+ if not callable(predicate):
58
+ raise TypeError(
59
+ f"predicate must be a (x) -> bool Callable. Supplied {type(predicate)}."
60
+ )
61
+
62
+ for _id in iter_provider(ids):
63
+ if predicate(_id):
64
+ return _id
65
+ return default_val
66
+
67
+
68
+ def get_last_true[T](
69
+ ids: Sequence[T], default_val: T, predicate: Callable[[T], bool]
70
+ ) -> T:
71
+ """
72
+ Get the last id which returns ``True`` from the supplied ``predicate`` else get the ``default_val``.
73
+
74
+ Examples:
75
+
76
+ * Last id is returned if all ``ids`` are inferred as ``True``::
77
+
78
+ >>> get_last_true([1, 2, 3], -1, lambda x: True)
79
+ 3
80
+
81
+ * Default id is returned if no ``ids`` are inferred as ``True``::
82
+
83
+ >>> get_last_true([1, 2, 3], -1, lambda x: False)
84
+ -1
85
+
86
+ Error scenarios:
87
+
88
+ * supplied predicate is not a callable::
89
+
90
+ >>> get_last_true([1, 2, 3], -1,
91
+ ... object()) # noqa: to avoid typecheck warnings, expects (x)->bool Callable
92
+ Traceback (most recent call last):
93
+ TypeError: predicate must be a (x) -> bool Callable. Supplied <class 'object'>.
94
+
95
+ * suppplied predicate is a non-conforming callable::
96
+
97
+ >>> get_last_true([1, 2, 3], -1,
98
+ ... lambda x, y: True) # noqa: to avoid typecheck warnings, expects (x)->bool Callable.
99
+ Traceback (most recent call last):
100
+ TypeError: <lambda>() missing 1 required positional argument: 'y'
101
+
102
+ :param ids: sequence of id(s) from which the last ``predicate`` determined truthy id is to be found.
103
+ :param default_val: value returned if no id is found as truthy from the ``ids`` list according to the supplied
104
+ ``predicate``.
105
+ :param predicate: predicate to determine whether an id is inferred as satisfying and hence returning ``True`` for
106
+ that id.
107
+ :return: the last id from the list of ``ids`` which returns ``True`` by the ``predicate`` or ``default_val`` if
108
+ the ``predicate`` returns ``True`` for no id(s).
109
+ """
110
+ return get_first_true(ids, default_val, predicate, reversed)
@@ -0,0 +1,42 @@
1
+ #!/usr/bin/env python3
2
+ # coding=utf-8
3
+
4
+ """
5
+ Reusable interfaces related to core python.
6
+ """
7
+
8
+ # region Base interfaces
9
+ from vt.utils.commons.commons.core_py.base import MISSING as MISSING
10
+ from vt.utils.commons.commons.core_py.base import Missing as Missing
11
+ from vt.utils.commons.commons.core_py.base import UNSET as UNSET
12
+ from vt.utils.commons.commons.core_py.base import Unset as Unset
13
+ # endregion
14
+
15
+ # region utility functions
16
+ from vt.utils.commons.commons.core_py.utils import (
17
+ has_atleast_one_arg as has_atleast_one_arg,
18
+ )
19
+ from vt.utils.commons.commons.core_py.utils import (
20
+ ensure_atleast_one_arg as ensure_atleast_one_arg,
21
+ )
22
+ from vt.utils.commons.commons.core_py.utils import (
23
+ not_none_not_unset as not_none_not_unset,
24
+ )
25
+ from vt.utils.commons.commons.core_py.utils import is_unset as is_unset
26
+ from vt.utils.commons.commons.core_py.utils import alt_if_unset as alt_if_unset
27
+ from vt.utils.commons.commons.core_py.utils import alt_if_missing as alt_if_missing
28
+ from vt.utils.commons.commons.core_py.utils import is_missing as is_missing
29
+ from vt.utils.commons.commons.core_py.utils import alt_if_ellipses as alt_if_ellipses
30
+ from vt.utils.commons.commons.core_py.utils import is_ellipses as is_ellipses
31
+ from vt.utils.commons.commons.core_py.utils import fallback_on_none as fallback_on_none
32
+ from vt.utils.commons.commons.core_py.utils import (
33
+ fallback_on_none_strict as fallback_on_none_strict,
34
+ )
35
+ from vt.utils.commons.commons.core_py.utils import (
36
+ not_none_not_missing as not_none_not_missing,
37
+ )
38
+ from vt.utils.commons.commons.core_py.utils import (
39
+ not_none_not_sentinel as not_none_not_sentinel,
40
+ )
41
+ from vt.utils.commons.commons.core_py.utils import strictly_int as strictly_int
42
+ # endregion