diff --git a/README.md b/README.md index 790d078d0..cd73f91da 100644 --- a/README.md +++ b/README.md @@ -10,68 +10,68 @@ __Creational Patterns__: | Pattern | Description | |:-------:| ----------- | -| [abstract_factory](creational/abstract_factory.py) | use a generic function with specific factories | -| [borg](creational/borg.py) | a singleton with shared-state among instances | -| [builder](creational/builder.py) | instead of using multiple constructors, builder object receives parameters and returns constructed objects | -| [factory_method](creational/factory_method.py) | delegate a specialized function/method to create instances | -| [lazy_evaluation](creational/lazy_evaluation.py) | lazily-evaluated property pattern in Python | -| [pool](creational/pool.py) | preinstantiate and maintain a group of instances of the same type | -| [prototype](creational/prototype.py) | use a factory and clones of a prototype for new instances (if instantiation is expensive) | +| [abstract_factory](patterns/creational/abstract_factory.py) | use a generic function with specific factories | +| [borg](patterns/creational/borg.py) | a singleton with shared-state among instances | +| [builder](patterns/creational/builder.py) | instead of using multiple constructors, builder object receives parameters and returns constructed objects | +| [factory_method](patterns/creational/factory_method.py) | delegate a specialized function/method to create instances | +| [lazy_evaluation](patterns/creational/lazy_evaluation.py) | lazily-evaluated property pattern in Python | +| [pool](patterns/creational/pool.py) | preinstantiate and maintain a group of instances of the same type | +| [prototype](patterns/creational/prototype.py) | use a factory and clones of a prototype for new instances (if instantiation is expensive) | __Structural Patterns__: | Pattern | Description | |:-------:| ----------- | -| [3-tier](structural/3-tier.py) | data<->business logic<->presentation separation (strict relationships) | -| [adapter](structural/adapter.py) | adapt one interface to another using a white-list | -| [bridge](structural/bridge.py) | a client-provider middleman to soften interface changes | -| [composite](structural/composite.py) | lets clients treat individual objects and compositions uniformly | -| [decorator](structural/decorator.py) | wrap functionality with other functionality in order to affect outputs | -| [facade](structural/facade.py) | use one class as an API to a number of others | -| [flyweight](structural/flyweight.py) | transparently reuse existing instances of objects with similar/identical state | -| [front_controller](structural/front_controller.py) | single handler requests coming to the application | -| [mvc](structural/mvc.py) | model<->view<->controller (non-strict relationships) | -| [proxy](structural/proxy.py) | an object funnels operations to something else | +| [3-tier](patterns/structural/3-tier.py) | data<->business logic<->presentation separation (strict relationships) | +| [adapter](patterns/structural/adapter.py) | adapt one interface to another using a white-list | +| [bridge](patterns/structural/bridge.py) | a client-provider middleman to soften interface changes | +| [composite](patterns/structural/composite.py) | lets clients treat individual objects and compositions uniformly | +| [decorator](patterns/structural/decorator.py) | wrap functionality with other functionality in order to affect outputs | +| [facade](patterns/structural/facade.py) | use one class as an API to a number of others | +| [flyweight](patterns/structural/flyweight.py) | transparently reuse existing instances of objects with similar/identical state | +| [front_controller](patterns/structural/front_controller.py) | single handler requests coming to the application | +| [mvc](patterns/structural/mvc.py) | model<->view<->controller (non-strict relationships) | +| [proxy](patterns/structural/proxy.py) | an object funnels operations to something else | __Behavioral Patterns__: | Pattern | Description | |:-------:| ----------- | -| [chain](behavioral/chain.py) | apply a chain of successive handlers to try and process the data | -| [catalog](behavioral/catalog.py) | general methods will call different specialized methods based on construction parameter | -| [chaining_method](behavioral/chaining_method.py) | continue callback next object method | -| [command](behavioral/command.py) | bundle a command and arguments to call later | -| [iterator](behavioral/iterator.py) | traverse a container and access the container's elements | -| [mediator](behavioral/mediator.py) | an object that knows how to connect other objects and act as a proxy | -| [memento](behavioral/memento.py) | generate an opaque token that can be used to go back to a previous state | -| [observer](behavioral/observer.py) | provide a callback for notification of events/changes to data | -| [publish_subscribe](behavioral/publish_subscribe.py) | a source syndicates events/data to 0+ registered listeners | -| [registry](behavioral/registry.py) | keep track of all subclasses of a given class | -| [specification](behavioral/specification.py) | business rules can be recombined by chaining the business rules together using boolean logic | -| [state](behavioral/state.py) | logic is organized into a discrete number of potential states and the next state that can be transitioned to | -| [strategy](behavioral/strategy.py) | selectable operations over the same data | -| [template](behavioral/template.py) | an object imposes a structure but takes pluggable components | -| [visitor](behavioral/visitor.py) | invoke a callback for all items of a collection | +| [chain](patterns/behavioral/chain.py) | apply a chain of successive handlers to try and process the data | +| [catalog](patterns/behavioral/catalog.py) | general methods will call different specialized methods based on construction parameter | +| [chaining_method](patterns/behavioral/chaining_method.py) | continue callback next object method | +| [command](patterns/behavioral/command.py) | bundle a command and arguments to call later | +| [iterator](patterns/behavioral/iterator.py) | traverse a container and access the container's elements | +| [mediator](patterns/behavioral/mediator.py) | an object that knows how to connect other objects and act as a proxy | +| [memento](patterns/behavioral/memento.py) | generate an opaque token that can be used to go back to a previous state | +| [observer](patterns/behavioral/observer.py) | provide a callback for notification of events/changes to data | +| [publish_subscribe](patterns/behavioral/publish_subscribe.py) | a source syndicates events/data to 0+ registered listeners | +| [registry](patterns/behavioral/registry.py) | keep track of all subclasses of a given class | +| [specification](patterns/behavioral/specification.py) | business rules can be recombined by chaining the business rules together using boolean logic | +| [state](patterns/behavioral/state.py) | logic is organized into a discrete number of potential states and the next state that can be transitioned to | +| [strategy](patterns/behavioral/strategy.py) | selectable operations over the same data | +| [template](patterns/behavioral/template.py) | an object imposes a structure but takes pluggable components | +| [visitor](patterns/behavioral/visitor.py) | invoke a callback for all items of a collection | __Design for Testability Patterns__: | Pattern | Description | |:-------:| ----------- | -| [setter_injection](dft/setter_injection.py) | the client provides the depended-on object to the SUT via the setter injection (implementation variant of dependency injection) | +| [setter_injection](patterns/dft/setter_injection.py) | the client provides the depended-on object to the SUT via the setter injection (implementation variant of dependency injection) | __Fundamental Patterns__: | Pattern | Description | |:-------:| ----------- | -| [delegation_pattern](fundamental/delegation_pattern.py) | an object handles a request by delegating to a second object (the delegate) | +| [delegation_pattern](patterns/fundamental/delegation_pattern.py) | an object handles a request by delegating to a second object (the delegate) | __Others__: | Pattern | Description | |:-------:| ----------- | -| [blackboard](other/blackboard.py) | architectural model, assemble different sub-system knowledge to build a solution, AI approach - non gang of four pattern | -| [graph_search](other/graph_search.py) | graphing algorithms - non gang of four pattern | -| [hsm](other/hsm/hsm.py) | hierarchical state machine - non gang of four pattern | +| [blackboard](patterns/other/blackboard.py) | architectural model, assemble different sub-system knowledge to build a solution, AI approach - non gang of four pattern | +| [graph_search](patterns/other/graph_search.py) | graphing algorithms - non gang of four pattern | +| [hsm](patterns/other/hsm/hsm.py) | hierarchical state machine - non gang of four pattern | Contributing @@ -86,10 +86,10 @@ Run `append_output.sh` (e.g. `./append_output.sh borg.py`) to generate/update it ##### Docstrings Add module level description in form of a docstring with links to corresponding references or other useful information. -[strategy.py](behavioral/strategy.py) has a good example of detailed description, -but sometimes the shorter one as in [template.py](behavioral/template.py) would suffice. +[strategy.py](patterns/behavioral/strategy.py) has a good example of detailed description, +but sometimes the shorter one as in [template.py](patterns/behavioral/template.py) would suffice. -In some cases class-level docstring with doctest would also help (see [adapter.py](structural/adapter.py)) +In some cases class-level docstring with doctest would also help (see [adapter.py](patterns/structural/adapter.py)) ##### Python2/3 compatibility Try to keep it (discussion is held in [issue #208](https://github.com/faif/python-patterns/issues/208)) @@ -97,4 +97,4 @@ Try to keep it (discussion is held in [issue #208](https://github.com/faif/pytho - use `from future import print` ##### Update README -When everything else is done - update corresponding part of README. \ No newline at end of file +When everything else is done - update corresponding part of README.