From f6ef41e2ea6f08a228b7535f5cc9a1e54e11a3f6 Mon Sep 17 00:00:00 2001 From: Alec Thomas Date: Fri, 26 Nov 2010 09:27:18 +1100 Subject: [PATCH] Use Key in README example. --- README.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index c342b0a..1567c1b 100644 --- a/README.rst +++ b/README.rst @@ -4,17 +4,20 @@ Injector - Python dependency injection framework, inspired by Guice This framework is also similar to snake-guice, but aims for simplification. While being inspired by Guice, it does not slavishly replicate its API. -Providing a Pythonic API trumps faithful replication. +Providing a Pythonic API trumps faithfulness. An Example ---------- +*TODO: Write a more useful example.* + Here's a brief, completely contrived, example from the unit tests:: from injector import Injector, Module, Key, injects, provides Weight = Key('Weight') Age = Key('Age') + Description = Key('Description') class MyModule(Module): @provides(Weight) @@ -25,10 +28,10 @@ Here's a brief, completely contrived, example from the unit tests:: def provide_age(self): return 25 - # TODO(alec) Make provides/inject order independent. - @provides(str) + @provides(Description) @inject(age=Age, weight=Weight) def provide_description(self, age, weight): return 'Bob is %d and weighs %0.1fkg' % (age, weight) - assert_equal(Injector(MyModule()).get(str), 'Bob is 25 and weighs 50.0kg') + injector = Injector(MyModule()) + assert_equal(injector.get(Description), 'Bob is 25 and weighs 50.0kg')