Documentation: "Using Scopes to manage Resources"

[bschnitz]

I tried to make a minimal example on how to automatically free resources with a custom Scope. Since I'm still learning how to use the python-injector, there may be many misconceptions, so please have a firm look.

[bschnitz]

Typo, remove to.

[jstasiak]

Thank you very much for the contribution @bschnitz, it's always nice to see a documentation patch.

May I ask about the exact use case you're addressing here?

Is it primarly/only about being able to do this?

with injector.get(SomeTypeThatNeedsCleanup) as obj:
    obj.doSomething()

If yes, then it seems to me it's enough for SomeTypeThatNeedsCleanup to be a type that's a context manager.

Then injector.get(SomeTypeThatNeedsCleanup) returns a context manager which will be accepted by the with statement and the example should work without any custom scopes or custom Injector wrappers.

[bschnitz]

Hi @jstasiak , thank You for having a look!

Actually, thats not the whole idea and I have to admit, that the example is too short to grasp it correctly. The idea is, that all objects in CleanupScope are handled, not just the one we directly get in this example. So it's really the context of the Scope and not the one of the object, although it looks a bit misleading here. The usage of @contextmanager is a bit misleading, it would be clearer, if it wouldn't have to be used at all, but this crook is needed here.

I will extend the example a bit, then You may have a look again.

Oh, this person named @contextmanager is probably getting lot's of notifications.

Edit: I extended the motivation a bit. It still feels clumsy, but I hope the idea is clearer now. If You have ideas on improving my horrible writing, feel free to tell ;).