added controlled scope documentation

mastern2k3 · Feb 23, 2022 · f2cda3c · f2cda3c
1 parent 9408553
commit f2cda3c
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# 0.4.0
+
+* Added new `resolve_open` for more control over resolution scope and disposal. 
+
+
 # 0.3.1
 
 * Better typing when using `Depends(...)` and `Lazy(...)`.

diff --git a/README.md b/README.md
@@ -149,6 +149,27 @@ resolve(get_dep_a)
 # enter b
 ```
 
+Controlled dependency lifetime scope:
+
+```python
+from deadsimple import resolve_open
+
+
+def get_dep_b() -> DepB:
+    print("enter b")
+    yield DepB(value="some val")
+    print("exit b")
+
+
+with resolve_open(get_dep_b) as dep_b:
+    print("inside")
+
+# prints:
+# enter b
+# inside
+# exit b
+```
+
 
 ## Todo
 

diff --git a/docs/index.md b/docs/index.md
@@ -158,6 +158,28 @@ resolve(get_dep_a)
 ```
 
 
+## Controlled lifetime scope
+
+```python
+from deadsimple import resolve_open
+
+
+def get_dep_b() -> DepB:
+    print("enter b")
+    yield DepB(value="some val")
+    print("exit b")
+
+
+with resolve_open(get_dep_b) as dep_b:
+    print("inside")
+
+# prints:
+# enter b
+# inside
+# exit b
+```
+
+
 ## Installation
 
 ```