diff --git a/CHANGES b/CHANGES index 3794d42..5a716fe 100644 --- a/CHANGES +++ b/CHANGES @@ -160,7 +160,7 @@ Backwards incompatible: - Removed previously deprecated constructs: with_injector, Injector.install_into, Binder.bind_scope - Dependencies are no longer injected into Module.configure and raw module functions (previously deprecated) -- Removed unofficial support for injecting into parent class constructors +- Removed unofficial support for injecting into parent class constructors 0.15.0 ------ diff --git a/MANIFEST.in b/MANIFEST.in index fbe3651..5456956 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -10,6 +10,8 @@ include pytest.ini recursive-include docs *.html recursive-include docs *.py recursive-include docs *.rst +recursive-include docs *.png +recursive-include docs *.svg recursive-include docs Makefile exclude .readthedocs.yaml exclude .coveragerc diff --git a/docs/_static/user-dependency-graph.png b/docs/_static/user-dependency-graph.png new file mode 100644 index 0000000..753e5a4 Binary files /dev/null and b/docs/_static/user-dependency-graph.png differ diff --git a/docs/_static/user-dependency-graph.svg b/docs/_static/user-dependency-graph.svg new file mode 100644 index 0000000..51f4b77 --- /dev/null +++ b/docs/_static/user-dependency-graph.svg @@ -0,0 +1,98 @@ + +Embedded inter font subsets retain the following copyright and SIL OFL 1.1 license. The surrounding diagram retains its repository license. + +Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter) Inter-Italic[opsz,wght].ttf: Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. + +Injector example dependency graphUser depends on Name and Description. Description also depends on Name. Directed links show the dependencies used by the documented User construction example.namedescriptionnameUserDescriptionName diff --git a/docs/conf.py b/docs/conf.py index f7f1c18..6fb7396 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -244,7 +244,7 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/': None} +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} def setup(app): diff --git a/docs/terminology.rst b/docs/terminology.rst index 6e34535..ab9638e 100644 --- a/docs/terminology.rst +++ b/docs/terminology.rst @@ -133,6 +133,23 @@ Or transitively:: >>> user.description 'Sherlock is a man of astounding insight' +The example above forms the following dependency graph. Arrows point from +an object or provider to the binding key it requires: ``User`` needs both +``Name`` and ``Description``, and the ``Description`` provider also needs +``Name``. The same ``Name`` binding supplies both injection sites. + +.. figure:: _static/user-dependency-graph.png + :alt: User depends on Name and Description; the provider for Description also depends on Name. + :width: 854px + + Dependencies in the User example. ``Name`` is bound to ``'Sherlock'``; + ``Description`` is supplied by ``UserAttributeModule.describe``. + :download:`Editable SVG <_static/user-dependency-graph.svg>`. + `Edit diagram `__. + +This graph describes binding dependencies. Instance reuse is controlled by +:ref:`scopes`, so a shared binding key does not by itself imply singleton scope. + Assisted injection ``````````````````