Skip to content

Commit

Permalink
Additional usage example & requirements update
Browse files Browse the repository at this point in the history
  • Loading branch information
roo-oliv committed Aug 14, 2021
1 parent 95eec9f commit 6d3917e
Show file tree
Hide file tree
Showing 53 changed files with 2,717 additions and 353 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 295a0b1e9f955255820416e4dff32f0b
config: 1713a5b2b0df61545c670b29a0cc2394
tags: 645f666f9bcd5a90fca523b33c5a78b7
13 changes: 6 additions & 7 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; injectable 3.4.6 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css" />

<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>

<script src="../_static/sidebar.js"></script>

Expand Down Expand Up @@ -74,7 +73,7 @@ <h1>All modules for which code is available</h1>
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
Expand Down Expand Up @@ -108,8 +107,8 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2018, Rodrigo Martins de Oliveira.
Last updated on Mar 20, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
Last updated on Aug 14, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
</div>
</body>
</html>
13 changes: 6 additions & 7 deletions docs/_modules/injectable/container/injection_container.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>injectable.container.injection_container &#8212; injectable 3.4.6 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>

<script src="../../../_static/sidebar.js"></script>

Expand Down Expand Up @@ -251,7 +250,7 @@ <h1>Source code for injectable.container.injection_container</h1><div class="hig
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
Expand Down Expand Up @@ -285,8 +284,8 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2018, Rodrigo Martins de Oliveira.
Last updated on Mar 20, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
Last updated on Aug 14, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
</div>
</body>
</html>
13 changes: 6 additions & 7 deletions docs/_modules/injectable/container/load_injection_container.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>injectable.container.load_injection_container &#8212; injectable 3.4.6 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>

<script src="../../../_static/sidebar.js"></script>

Expand Down Expand Up @@ -109,7 +108,7 @@ <h1>Source code for injectable.container.load_injection_container</h1><div class
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
Expand Down Expand Up @@ -143,8 +142,8 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2018, Rodrigo Martins de Oliveira.
Last updated on Mar 20, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
Last updated on Aug 14, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
</div>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>injectable.injection.injectable_factory_decorator &#8212; injectable 3.4.6 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>

<script src="../../../_static/sidebar.js"></script>

Expand Down Expand Up @@ -64,7 +63,7 @@ <h1>Source code for injectable.injection.injectable_factory_decorator</h1><div c
<span class="n">namespace</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">singleton</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">T</span><span class="p">]]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Function decorator to mark it as a injectable factory for the dependency.</span>

Expand Down Expand Up @@ -138,7 +137,7 @@ <h1>Source code for injectable.injection.injectable_factory_decorator</h1><div c
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
Expand Down Expand Up @@ -172,8 +171,8 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2018, Rodrigo Martins de Oliveira.
Last updated on Mar 20, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
Last updated on Aug 14, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
</div>
</body>
</html>
13 changes: 6 additions & 7 deletions docs/_modules/injectable/testing/register_injectables_util.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>injectable.testing.register_injectables_util &#8212; injectable 3.4.6 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>

<script src="../../../_static/sidebar.js"></script>

Expand Down Expand Up @@ -118,7 +117,7 @@ <h1>Source code for injectable.testing.register_injectables_util</h1><div class=
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
Expand Down Expand Up @@ -152,8 +151,8 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2018, Rodrigo Martins de Oliveira.
Last updated on Mar 20, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
Last updated on Aug 14, 2021.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
</div>
</body>
</html>
1 change: 1 addition & 0 deletions docs/_sources/usage/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Usage Examples
namespaces
singletons
factory
injecting_existing_instance
injectable_mocking_for_tests
injection_container_resetting_for_tests
service_locator
14 changes: 14 additions & 0 deletions docs/_sources/usage/injecting_existing_instance.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _injecting_existing_instance_example:

===================================
Injecting Existing Instance Example
===================================

.. automodule:: examples.injecting_existing_instance.injecting_existing_instance_example

.. literalinclude:: ../../examples/injecting_existing_instance/injecting_existing_instance_example.py
:caption: injecting_existing_instance_example.py
:start-after: sphinx-start

.. literalinclude:: ../../examples/injecting_existing_instance/app.py
:caption: app.py
Loading

0 comments on commit 6d3917e

Please sign in to comment.