Closing does not resolve nested dependecies
#702
Comments
|
Here is your example fixed to at least run, results are not what u want thou: from dependency_injector import containers, providers
from dependency_injector.wiring import inject, Provide, Closing
class MyResource:
init_counter: int = 0
shutdown_counter: int = 0
@classmethod
def reset_counter(cls):
cls.init_counter = 0
cls.shutdown_counter = 0
@classmethod
def init(cls):
cls.init_counter += 1
@classmethod
def shutdown(cls):
cls.shutdown_counter += 1
class FactoryService:
def __init__(self, resource: MyResource):
self.resource = resource
class NestedService:
def __init__(self, factory: FactoryService):
self.factory = factory
def init_resource():
resource = MyResource()
resource.init()
yield resource
resource.shutdown()
class Container(containers.DeclarativeContainer):
resource = providers.Resource(init_resource)
factory_service = providers.Factory(FactoryService, resource)
nested_service = providers.Factory(NestedService, factory_service)
@inject
def test_function(resource: MyResource = Closing[Provide["resource"]]):
return resource
@inject
def test_function_dependency(
# no "Closing" since Container.factory_service itself is not a providers.Resource
factory: FactoryService = Provide["factory_service"],
):
return factory
@inject
def test_nested_dependency(
# no "Closing" since Container.nested_service itself is not a providers.Resource
nested: NestedService = Provide["nested_service"],
):
return nested.factory
if __name__ == "__main__":
container = Container()
container.wire(modules=[__name__])
MyResource.reset_counter()
for _ in range(3):
result = test_nested_dependency()
print(f"Initialized {result.resource.init_counter} times")
print(f"Shut down {result.resource.shutdown_counter} times")This is because Closing is a wiring thing and it only works when stuff is injected. "Initialized 1 times" is printed 3 times because all the resource declared in the container are initialized once upon container instantiation (or when "container.init_resources()" is called directly) and will only be closed if u call "container.shutdown_resources()", which is not done at all in this example. To achieve what u want this is what u could do, i would be cautious thou since "Closing" is kind of bugged - #699 from dependency_injector import containers, providers
from dependency_injector.wiring import inject, Provide, Closing
class MyResource:
init_counter: int = 0
shutdown_counter: int = 0
@classmethod
def reset_counter(cls):
cls.init_counter = 0
cls.shutdown_counter = 0
@classmethod
def init(cls):
cls.init_counter += 1
@classmethod
def shutdown(cls):
cls.shutdown_counter += 1
class FactoryService:
@inject
def __init__(self, resource: MyResource = Closing[Provide["resource"]]):
self.resource = resource
class NestedService:
def __init__(self, factory: FactoryService):
self.factory = factory
def init_resource():
resource = MyResource()
resource.init()
yield resource
resource.shutdown()
class Container(containers.DeclarativeContainer):
resource = providers.Resource(init_resource)
# We don't pass resource here because it has to injected to take advantage
# of the "Closing" marker.
factory_service = providers.Factory(FactoryService)
nested_service = providers.Factory(NestedService, factory_service)
@inject
def test_function(resource: MyResource = Closing[Provide["resource"]]):
return resource
@inject
def test_function_dependency(
# no "Closing" since Container.factory_service itself is not a providers.Resource
factory: FactoryService = Provide["factory_service"],
):
return factory
@inject
def test_nested_dependency(
# no "Closing" since Container.nested_service itself is not a providers.Resource
nested: NestedService = Provide["nested_service"],
):
return nested.factory
if __name__ == "__main__":
container = Container()
container.wire(modules=[__name__])
container.init_resources()
container.shutdown_resources()
MyResource.reset_counter()
for _ in range(3):
result = test_nested_dependency()
print(f"Initialized {result.resource.init_counter} times")
print(f"Shut down {result.resource.shutdown_counter} times") |
|
@kkjot88 I see your point, but my example is just for display purposes. What I wanted to do is use |
Yeah, u are right. It should work. This minor change fixes it for me and your original code works as expected. # .../venv/lib/python3.10/site-packages/dependency_injector/wiring.py
def _locate_dependent_closing_args(provider: providers.Provider) -> Dict[str, providers.Provider]:
if not hasattr(provider, "args"):
return {}
closing_deps = {}
for arg in provider.args:
if not isinstance(arg, providers.Provider) or not hasattr(arg, "args"):
continue
if not arg.args and isinstance(arg, providers.Resource):
return {str(id(arg)): arg}
else:
closing_deps.update(_locate_dependent_closing_args(arg))
# closing_deps += _locate_dependent_closing_args(arg)
return closing_depsStill I would advise caution when dealing with "Closing" because of #699 unless I am wrong on that too :D. |
|
@kkjot88 Your advice is absolutely right, as this |
|
@jazzthief @kkjot88 Hi, guys! Also for some reason this function is looking for There is a version that works for me: def _locate_dependent_closing_args(provider: providers.Provider) -> Dict[str, providers.Provider]:
if not hasattr(provider, "args"):
return {}
closing_deps = {}
# for arg in provider.args:
for arg in [*provider.args, *provider.kwargs.values()]:
if not isinstance(arg, providers.Provider) or not hasattr(arg, "args"):
continue
if not arg.args and isinstance(arg, providers.Resource):
# return {str(id(arg)): arg}
closing_deps.update({str(id(arg)): arg})
else:
closing_deps.update(_locate_dependent_closing_args(arg))
return closing_deps |
Closingdoesn't seem to resolve nested dependecies: e.g. when aFactorydepends on anotherFactorydependent on aResource. I have followed issue #633, and linked PR #636 that dealt with the detection of dependent resources, however in my example it doesn't look like it is working when the dependencies are nested.The following example replicates the code from
dependecy-injectortest suiteused to test the dependent resources resolution in PR #636. Apart from different naming, the only things I added are
NestedServiceandtest_nested_dependency():Running this with
python 3.11.1anddependency-injector 4.41.0fails for me with the following traceback:Could anyone please provide any guidance as to whether this is expected behaviour or any existing workarounds? I am trying to use
dependency-injectorin a large FastAPI project which would greatly benefit from nestedResourceclosing - and would be glad to try and fix this if possible.The text was updated successfully, but these errors were encountered: