Skip to content

Commit c9e1e5f

Browse files
committed
Version 0.6.0 with asyncio support
1 parent 88566df commit c9e1e5f

File tree

10 files changed

+252
-108
lines changed

10 files changed

+252
-108
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
We follow Semantic Versions since the `0.1.0` release.
44

55

6+
## Version 0.6.0
7+
8+
### Features
9+
10+
- `safe` and `pipeline` now supports `asyncio`
11+
- `is_successful` now returns `Literal` types if possible
12+
13+
614
## Version 0.5.0
715

816
### Features

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Make your functions return something meaningful, typed, and safe!
1515
- Enforces [Railway Oriented Programming](https://fsharpforfunandprofit.com/rop/)
1616
- Fully typed with annotations and checked with `mypy`, [PEP561 compatible](https://www.python.org/dev/peps/pep-0561/)
1717
- Pythonic and pleasant to write and to read (!)
18-
- WIP: `asyncio` support
18+
- Support functions and coroutines, framework agnostic
1919

2020

2121
## Installation

docs/pages/functions.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ pipeline
2929
--------
3030

3131
What is a ``pipeline``?
32-
It is a more user-friendly syntax to work with containers.
32+
It is a more user-friendly syntax to work with containers
33+
that support both async and regular functions.
3334

3435
Consider this task.
3536
We were asked to create a method
@@ -162,6 +163,8 @@ safe
162163
regular functions that can throw exceptions to functions
163164
that return :class:`Result <returns.result.Result>` type.
164165

166+
Supports both async and regular functions.
167+
165168
.. code:: python
166169
167170
from returns.functions import safe
@@ -199,9 +202,9 @@ This effect can be reduced
199202
with the help of `Design by Contract <https://en.wikipedia.org/wiki/Design_by_contract>`_
200203
with these implementations:
201204

202-
- https://github.com/Parquery/icontract
203-
- https://github.com/orsinium/deal
204205
- https://github.com/deadpixi/contracts
206+
- https://github.com/orsinium/deal
207+
- https://github.com/Parquery/icontract
205208

206209

207210
compose
@@ -221,6 +224,8 @@ Composition is also type-safe.
221224
The only limitation is that we only support
222225
functions with one argument and one return to be composed.
223226

227+
Only works with regular functions (not async).
228+
224229

225230
raise_exception
226231
---------------

0 commit comments

Comments
 (0)