Skip to content

Commit 93a081d

Browse files
committed
2.6.0 - extras.git + asyncx.awaitable + aobject
- Created `helpers.extras.git` module, which contains a git command wrapper that works with both sync and async functions - Primarily intended for the three methods: `get_current_commit`, `get_current_branch`, and `get_current_tag`, which allows python applications and libraries to identify what version they are, via git. - Includes various basic methods such as `init`, `checkout`, `branch`, `tag`, `status`, `log` and others. - Added new async helpers - `aobject` allows sub-classes to have `async __init__` constructors - `awaitable` helps create wrapper functions that allow async functions to work with sync code seamlessly - Improved `byteify` and `stringify` with None handling - Added new `SysCallError` exception - `sniffio` is now a required dependency - however it's very small and dependency free in itself (only about 30kb). - Added unit tests for the git module, including tests for both synchronous and asynchronous execution of the methods - Re-generated some of the documentation - Possibly other small changes
1 parent ac52b28 commit 93a081d

File tree

66 files changed

+1073
-103
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1073
-103
lines changed

Pipfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Django = "*"
2727
MarkupSafe = ">=1.1.1"
2828
wheel = "*"
2929
python-dateutil = "*"
30+
sniffio = "*"
3031

3132
[requires]
3233
python_version = "3.8"

Pipfile.lock

Lines changed: 15 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
\_\_init\_\_
2+
============
3+
4+
.. currentmodule:: privex.helpers.asyncx
5+
6+
.. automethod:: aobject.__init__
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
aobject
2+
=======
3+
4+
.. currentmodule:: privex.helpers.asyncx
5+
6+
.. autoclass:: aobject
7+
8+
9+
.. automethod:: __init__
10+
:noindex:
11+
12+
13+
Methods
14+
^^^^^^^
15+
16+
.. rubric:: Methods
17+
18+
.. autosummary::
19+
:toctree: aobject
20+
21+
~aobject.__init__
22+
23+
24+
25+
26+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
awaitable
2+
=========
3+
4+
.. currentmodule:: privex.helpers.asyncx
5+
6+
.. autofunction:: awaitable
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
EncryptKeyMissing
2+
=================
3+
4+
.. currentmodule:: privex.helpers.exceptions
5+
6+
.. autoexception:: EncryptKeyMissing
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
EncryptionError
2+
===============
3+
4+
.. currentmodule:: privex.helpers.exceptions
5+
6+
.. autoexception:: EncryptionError
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
InvalidFormat
2+
=============
3+
4+
.. currentmodule:: privex.helpers.exceptions
5+
6+
.. autoexception:: InvalidFormat
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
NetworkUnreachable
2+
==================
3+
4+
.. currentmodule:: privex.helpers.exceptions
5+
6+
.. autoexception:: NetworkUnreachable
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SysCallError
2+
============
3+
4+
.. currentmodule:: privex.helpers.exceptions
5+
6+
.. autoexception:: SysCallError

0 commit comments

Comments
 (0)