vt-commons 0.0.1__tar.gz → 0.0.1.dev2__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.
- {vt_commons-0.0.1/src/vt_commons.egg-info → vt_commons-0.0.1.dev2}/PKG-INFO +50 -39
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/README.md +49 -38
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/pyproject.toml +1 -1
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2/src/vt_commons.egg-info}/PKG-INFO +50 -39
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/LICENSE +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/setup.cfg +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/__init__.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/collections/__init__.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/collections/utils.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/core_py/__init__.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/core_py/base.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/core_py/utils.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/op/__init__.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/op/base.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/os/__init__.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/os/_base_utils.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/os/linux.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/os/mac.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/os/posix.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/os/windows.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/py.typed +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/state/__init__.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/state/done.py +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt_commons.egg-info/SOURCES.txt +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt_commons.egg-info/dependency_links.txt +0 -0
- {vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt_commons.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: vt-commons
|
|
3
|
-
Version: 0.0.1
|
|
3
|
+
Version: 0.0.1.dev2
|
|
4
4
|
Summary: Reusable common utilities, interfaces and implementations for python projects.
|
|
5
5
|
Author-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
|
|
6
6
|
Maintainer-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
|
|
@@ -28,79 +28,90 @@ Dynamic: license-file
|
|
|
28
28
|
|
|
29
29
|
# vt-commons
|
|
30
30
|
|
|
31
|
+
|
|
32
|
+
|
|
31
33
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/test.yml)
|
|
32
34
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/typecheck.yml)
|
|
33
35
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/lint.yml)
|
|
34
36
|
[](https://codecov.io/gh/Vaastav-Technologies/py-commons)
|
|
35
37
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/python-publish.yml)
|
|
38
|
+
|
|
36
39
|
|
|
37
40
|
---
|
|
38
|
-
|
|
41
|
+
A fully typed library for commons methods, utils, interfaces and implementations for python projects.
|
|
39
42
|
|
|
40
43
|
### Install
|
|
41
44
|
|
|
42
|
-
```shell
|
|
43
|
-
pip install vt-commons
|
|
44
|
-
```
|
|
45
|
+
```shell
|
|
46
|
+
pip install vt-commons
|
|
47
|
+
```
|
|
45
48
|
|
|
46
49
|
#### Usage examples
|
|
47
50
|
|
|
48
51
|
- Check for OS
|
|
49
52
|
```python
|
|
50
|
-
|
|
53
|
+
from vt.utils.commons.commons.os import is_windows
|
|
51
54
|
|
|
52
|
-
|
|
55
|
+
windows = is_windows()
|
|
53
56
|
```
|
|
54
57
|
Check in `vt.utils.commons.commons.os` and documentation for more functions and utilities related to OS.
|
|
58
|
+
|
|
59
|
+
|
|
55
60
|
- Perform some operation on a root directory
|
|
56
61
|
```python
|
|
57
|
-
|
|
58
|
-
|
|
62
|
+
from vt.utils.commons.commons.op import RootDirOp, CWDRootDirOp, RootDirOps
|
|
63
|
+
from pathlib import Path
|
|
59
64
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
+
class MyRootDirectoryOperation(RootDirOp):
|
|
66
|
+
...
|
|
67
|
+
@property
|
|
68
|
+
def root_dir(self)-> Path:
|
|
69
|
+
return Path('path', 'to', 'my', 'root-directory')
|
|
65
70
|
|
|
66
|
-
|
|
71
|
+
certain_root_dir_operation: CWDRootDirOp = RootDirOps.from_path(Path('path', 'to', 'my', 'root-directory'))
|
|
67
72
|
```
|
|
68
73
|
Check in `vt.utils.commons.commons.op` and documentation for more functions and utilities related to operations.
|
|
74
|
+
|
|
75
|
+
|
|
69
76
|
- Perform state operations
|
|
70
77
|
```python
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
78
|
+
from vt.utils.commons.commons.state import DoneMarker
|
|
79
|
+
|
|
80
|
+
# Track state by marking done
|
|
81
|
+
class MyStateManager(DoneMarker[int]):
|
|
82
|
+
def __init__(self, *args, **kwargs):
|
|
83
|
+
self.id_state = {1: False}
|
|
84
|
+
...
|
|
85
|
+
|
|
86
|
+
def mark_done(self, _id: int)-> bool:
|
|
87
|
+
# mark done for _id
|
|
88
|
+
if self.id_state[_id] is True:
|
|
89
|
+
return False
|
|
90
|
+
self.id_state[_id] = True
|
|
91
|
+
return True
|
|
85
92
|
```
|
|
86
93
|
Check in `vt.utils.commons.commons.state` and documentation for more functions and utilities related to tracking state.
|
|
94
|
+
|
|
95
|
+
|
|
87
96
|
- Check if a value is `MISSING`
|
|
88
97
|
```python
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
98
|
+
from vt.utils.commons.commons.core_py import MISSING, Missing, is_missing
|
|
99
|
+
|
|
100
|
+
def some_operation(arg: Missing = MISSING):
|
|
101
|
+
"""
|
|
102
|
+
``MISSING`` can be used as a default value sentinel when ``None`` is a valid value for arg.
|
|
103
|
+
"""
|
|
104
|
+
arg = 10 if is_missing(arg) else arg
|
|
105
|
+
...
|
|
97
106
|
```
|
|
98
107
|
Check in `vt.utils.commons.commons.core_py` and documentation for more functions and utilities related to function management.
|
|
108
|
+
|
|
109
|
+
|
|
99
110
|
- Query and operate on iterables
|
|
100
111
|
```python
|
|
101
|
-
|
|
112
|
+
from vt.utils.commons.commons.collections import get_first_true
|
|
102
113
|
|
|
103
|
-
|
|
114
|
+
assert 3 == get_first_true([1, 3, 5, 7, 2, 1], 8, lambda x: x>2)
|
|
104
115
|
```
|
|
105
116
|
Check in `vt.utils.commons.commons.collections` and documentation for more functions and utilities related to collection management.
|
|
106
117
|
|
|
@@ -1,78 +1,89 @@
|
|
|
1
1
|
# vt-commons
|
|
2
2
|
|
|
3
|
+
|
|
4
|
+
|
|
3
5
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/test.yml)
|
|
4
6
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/typecheck.yml)
|
|
5
7
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/lint.yml)
|
|
6
8
|
[](https://codecov.io/gh/Vaastav-Technologies/py-commons)
|
|
7
9
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/python-publish.yml)
|
|
10
|
+
|
|
8
11
|
|
|
9
12
|
---
|
|
10
|
-
|
|
13
|
+
A fully typed library for commons methods, utils, interfaces and implementations for python projects.
|
|
11
14
|
|
|
12
15
|
### Install
|
|
13
16
|
|
|
14
|
-
```shell
|
|
15
|
-
pip install vt-commons
|
|
16
|
-
```
|
|
17
|
+
```shell
|
|
18
|
+
pip install vt-commons
|
|
19
|
+
```
|
|
17
20
|
|
|
18
21
|
#### Usage examples
|
|
19
22
|
|
|
20
23
|
- Check for OS
|
|
21
24
|
```python
|
|
22
|
-
|
|
25
|
+
from vt.utils.commons.commons.os import is_windows
|
|
23
26
|
|
|
24
|
-
|
|
27
|
+
windows = is_windows()
|
|
25
28
|
```
|
|
26
29
|
Check in `vt.utils.commons.commons.os` and documentation for more functions and utilities related to OS.
|
|
30
|
+
|
|
31
|
+
|
|
27
32
|
- Perform some operation on a root directory
|
|
28
33
|
```python
|
|
29
|
-
|
|
30
|
-
|
|
34
|
+
from vt.utils.commons.commons.op import RootDirOp, CWDRootDirOp, RootDirOps
|
|
35
|
+
from pathlib import Path
|
|
31
36
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
+
class MyRootDirectoryOperation(RootDirOp):
|
|
38
|
+
...
|
|
39
|
+
@property
|
|
40
|
+
def root_dir(self)-> Path:
|
|
41
|
+
return Path('path', 'to', 'my', 'root-directory')
|
|
37
42
|
|
|
38
|
-
|
|
43
|
+
certain_root_dir_operation: CWDRootDirOp = RootDirOps.from_path(Path('path', 'to', 'my', 'root-directory'))
|
|
39
44
|
```
|
|
40
45
|
Check in `vt.utils.commons.commons.op` and documentation for more functions and utilities related to operations.
|
|
46
|
+
|
|
47
|
+
|
|
41
48
|
- Perform state operations
|
|
42
49
|
```python
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
50
|
+
from vt.utils.commons.commons.state import DoneMarker
|
|
51
|
+
|
|
52
|
+
# Track state by marking done
|
|
53
|
+
class MyStateManager(DoneMarker[int]):
|
|
54
|
+
def __init__(self, *args, **kwargs):
|
|
55
|
+
self.id_state = {1: False}
|
|
56
|
+
...
|
|
57
|
+
|
|
58
|
+
def mark_done(self, _id: int)-> bool:
|
|
59
|
+
# mark done for _id
|
|
60
|
+
if self.id_state[_id] is True:
|
|
61
|
+
return False
|
|
62
|
+
self.id_state[_id] = True
|
|
63
|
+
return True
|
|
57
64
|
```
|
|
58
65
|
Check in `vt.utils.commons.commons.state` and documentation for more functions and utilities related to tracking state.
|
|
66
|
+
|
|
67
|
+
|
|
59
68
|
- Check if a value is `MISSING`
|
|
60
69
|
```python
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
70
|
+
from vt.utils.commons.commons.core_py import MISSING, Missing, is_missing
|
|
71
|
+
|
|
72
|
+
def some_operation(arg: Missing = MISSING):
|
|
73
|
+
"""
|
|
74
|
+
``MISSING`` can be used as a default value sentinel when ``None`` is a valid value for arg.
|
|
75
|
+
"""
|
|
76
|
+
arg = 10 if is_missing(arg) else arg
|
|
77
|
+
...
|
|
69
78
|
```
|
|
70
79
|
Check in `vt.utils.commons.commons.core_py` and documentation for more functions and utilities related to function management.
|
|
80
|
+
|
|
81
|
+
|
|
71
82
|
- Query and operate on iterables
|
|
72
83
|
```python
|
|
73
|
-
|
|
84
|
+
from vt.utils.commons.commons.collections import get_first_true
|
|
74
85
|
|
|
75
|
-
|
|
86
|
+
assert 3 == get_first_true([1, 3, 5, 7, 2, 1], 8, lambda x: x>2)
|
|
76
87
|
```
|
|
77
88
|
Check in `vt.utils.commons.commons.collections` and documentation for more functions and utilities related to collection management.
|
|
78
89
|
|
|
@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta" # If not defined, then legacy behavior
|
|
|
7
7
|
|
|
8
8
|
[project]
|
|
9
9
|
name = "vt-commons"
|
|
10
|
-
version = "0.0.
|
|
10
|
+
version = "0.0.1dev2"
|
|
11
11
|
description = "Reusable common utilities, interfaces and implementations for python projects."
|
|
12
12
|
readme = "README.md"
|
|
13
13
|
authors = [
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: vt-commons
|
|
3
|
-
Version: 0.0.1
|
|
3
|
+
Version: 0.0.1.dev2
|
|
4
4
|
Summary: Reusable common utilities, interfaces and implementations for python projects.
|
|
5
5
|
Author-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
|
|
6
6
|
Maintainer-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
|
|
@@ -28,79 +28,90 @@ Dynamic: license-file
|
|
|
28
28
|
|
|
29
29
|
# vt-commons
|
|
30
30
|
|
|
31
|
+
|
|
32
|
+
|
|
31
33
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/test.yml)
|
|
32
34
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/typecheck.yml)
|
|
33
35
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/lint.yml)
|
|
34
36
|
[](https://codecov.io/gh/Vaastav-Technologies/py-commons)
|
|
35
37
|
[](https://github.com/Vaastav-Technologies/py-commons/actions/workflows/python-publish.yml)
|
|
38
|
+
|
|
36
39
|
|
|
37
40
|
---
|
|
38
|
-
|
|
41
|
+
A fully typed library for commons methods, utils, interfaces and implementations for python projects.
|
|
39
42
|
|
|
40
43
|
### Install
|
|
41
44
|
|
|
42
|
-
```shell
|
|
43
|
-
pip install vt-commons
|
|
44
|
-
```
|
|
45
|
+
```shell
|
|
46
|
+
pip install vt-commons
|
|
47
|
+
```
|
|
45
48
|
|
|
46
49
|
#### Usage examples
|
|
47
50
|
|
|
48
51
|
- Check for OS
|
|
49
52
|
```python
|
|
50
|
-
|
|
53
|
+
from vt.utils.commons.commons.os import is_windows
|
|
51
54
|
|
|
52
|
-
|
|
55
|
+
windows = is_windows()
|
|
53
56
|
```
|
|
54
57
|
Check in `vt.utils.commons.commons.os` and documentation for more functions and utilities related to OS.
|
|
58
|
+
|
|
59
|
+
|
|
55
60
|
- Perform some operation on a root directory
|
|
56
61
|
```python
|
|
57
|
-
|
|
58
|
-
|
|
62
|
+
from vt.utils.commons.commons.op import RootDirOp, CWDRootDirOp, RootDirOps
|
|
63
|
+
from pathlib import Path
|
|
59
64
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
+
class MyRootDirectoryOperation(RootDirOp):
|
|
66
|
+
...
|
|
67
|
+
@property
|
|
68
|
+
def root_dir(self)-> Path:
|
|
69
|
+
return Path('path', 'to', 'my', 'root-directory')
|
|
65
70
|
|
|
66
|
-
|
|
71
|
+
certain_root_dir_operation: CWDRootDirOp = RootDirOps.from_path(Path('path', 'to', 'my', 'root-directory'))
|
|
67
72
|
```
|
|
68
73
|
Check in `vt.utils.commons.commons.op` and documentation for more functions and utilities related to operations.
|
|
74
|
+
|
|
75
|
+
|
|
69
76
|
- Perform state operations
|
|
70
77
|
```python
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
78
|
+
from vt.utils.commons.commons.state import DoneMarker
|
|
79
|
+
|
|
80
|
+
# Track state by marking done
|
|
81
|
+
class MyStateManager(DoneMarker[int]):
|
|
82
|
+
def __init__(self, *args, **kwargs):
|
|
83
|
+
self.id_state = {1: False}
|
|
84
|
+
...
|
|
85
|
+
|
|
86
|
+
def mark_done(self, _id: int)-> bool:
|
|
87
|
+
# mark done for _id
|
|
88
|
+
if self.id_state[_id] is True:
|
|
89
|
+
return False
|
|
90
|
+
self.id_state[_id] = True
|
|
91
|
+
return True
|
|
85
92
|
```
|
|
86
93
|
Check in `vt.utils.commons.commons.state` and documentation for more functions and utilities related to tracking state.
|
|
94
|
+
|
|
95
|
+
|
|
87
96
|
- Check if a value is `MISSING`
|
|
88
97
|
```python
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
98
|
+
from vt.utils.commons.commons.core_py import MISSING, Missing, is_missing
|
|
99
|
+
|
|
100
|
+
def some_operation(arg: Missing = MISSING):
|
|
101
|
+
"""
|
|
102
|
+
``MISSING`` can be used as a default value sentinel when ``None`` is a valid value for arg.
|
|
103
|
+
"""
|
|
104
|
+
arg = 10 if is_missing(arg) else arg
|
|
105
|
+
...
|
|
97
106
|
```
|
|
98
107
|
Check in `vt.utils.commons.commons.core_py` and documentation for more functions and utilities related to function management.
|
|
108
|
+
|
|
109
|
+
|
|
99
110
|
- Query and operate on iterables
|
|
100
111
|
```python
|
|
101
|
-
|
|
112
|
+
from vt.utils.commons.commons.collections import get_first_true
|
|
102
113
|
|
|
103
|
-
|
|
114
|
+
assert 3 == get_first_true([1, 3, 5, 7, 2, 1], 8, lambda x: x>2)
|
|
104
115
|
```
|
|
105
116
|
Check in `vt.utils.commons.commons.collections` and documentation for more functions and utilities related to collection management.
|
|
106
117
|
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/collections/__init__.py
RENAMED
|
File without changes
|
{vt_commons-0.0.1 → vt_commons-0.0.1.dev2}/src/vt/utils/commons/commons/collections/utils.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|