PyPI - mindroot - Versions diffs - 9.11.0__py3-none-any.whl → 9.13.0__py3-none-any.whl - Mend - Supply Chain Defender

mindroot 9.11.0py3-none-any.whl → 9.13.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of mindroot might be problematic. Click here for more details.

Files changed (417) hide show

mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/conversion.html ADDED Viewed

@@ -0,0 +1,232 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>mindroot.coreplugins.credits.conversion &mdash; MindRoot 9.10.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
+      <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../../../_static/documentation_options.js?v=3c16008f"></script>
+      <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../../search.html" />
+</head>
+<body class="wy-body-for-nav">
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search"  style="background: #343131" >
+          <a href="../../../../index.html" class="icon icon-home">
+            MindRoot
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started.html">Getting Started</a></li>
+</ul>
+        </div>
+      </div>
+    </nav>
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu"  style="background: #343131" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../../index.html">MindRoot</a>
+      </nav>
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">mindroot.coreplugins.credits.conversion</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+  <h1>Source code for mindroot.coreplugins.credits.conversion</h1><div class="highlight"><pre>
+<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditRatioConfig</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.ledger</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditLedger</span><span class="p">,</span> <span class="n">InsufficientCreditsError</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">mindroot.coreplugins.usage.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">UsageEvent</span>
+<div class="viewcode-block" id="CreditUsageHandler">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.conversion.CreditUsageHandler">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">CreditUsageHandler</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Converts usage costs to credits and records credit transactions.&quot;&quot;&quot;</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ledger</span><span class="p">:</span> <span class="n">CreditLedger</span><span class="p">,</span> <span class="n">ratio_config</span><span class="p">:</span> <span class="n">CreditRatioConfig</span><span class="p">,</span> <span class="n">base_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">ledger</span> <span class="o">=</span> <span class="n">ledger</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">ratio_config</span> <span class="o">=</span> <span class="n">ratio_config</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">base_path</span> <span class="o">=</span> <span class="n">base_path</span>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_calculate_credit_cost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">:</span> <span class="n">UsageEvent</span><span class="p">,</span> <span class="n">monetary_cost</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Convert monetary cost to credit cost using configured ratios&quot;&quot;&quot;</span>
+        <span class="n">ratio</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">ratio_config</span><span class="o">.</span><span class="n">get_ratio</span><span class="p">(</span>
+            <span class="n">plugin_id</span><span class="o">=</span><span class="n">event</span><span class="o">.</span><span class="n">plugin_id</span><span class="p">,</span>
+            <span class="n">cost_type_id</span><span class="o">=</span><span class="n">event</span><span class="o">.</span><span class="n">cost_type_id</span><span class="p">,</span>
+            <span class="n">model_id</span><span class="o">=</span><span class="n">event</span><span class="o">.</span><span class="n">model_id</span>
+        <span class="p">)</span>
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Monetary cost is&quot;</span><span class="p">,</span> <span class="n">monetary_cost</span><span class="p">)</span>
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Ratio config is&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ratio_config</span><span class="p">)</span>
+        <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;got ratio for </span><span class="si">{</span><span class="n">event</span><span class="o">.</span><span class="n">plugin_id</span><span class="si">}</span><span class="s2"> and </span><span class="si">{</span><span class="n">event</span><span class="o">.</span><span class="n">cost_type_id</span><span class="si">}</span><span class="s2"> and </span><span class="si">{</span><span class="n">event</span><span class="o">.</span><span class="n">model_id</span><span class="si">}</span><span class="s2"> it is </span><span class="si">{</span><span class="n">ratio</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">monetary_cost</span> <span class="o">*</span> <span class="n">ratio</span>
+<div class="viewcode-block" id="CreditUsageHandler.handle_usage">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.conversion.CreditUsageHandler.handle_usage">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">handle_usage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">quantity</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                         <span class="n">metadata</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">model_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Handle a usage event by converting cost to credits and recording transaction&quot;&quot;&quot;</span>
+        <span class="n">event</span> <span class="o">=</span> <span class="n">UsageEvent</span><span class="p">(</span>
+            <span class="n">timestamp</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">(),</span>
+            <span class="n">plugin_id</span><span class="o">=</span><span class="n">plugin_id</span><span class="p">,</span>
+            <span class="n">cost_type_id</span><span class="o">=</span><span class="n">cost_type_id</span><span class="p">,</span>
+            <span class="n">quantity</span><span class="o">=</span><span class="n">quantity</span><span class="p">,</span>
+            <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
+            <span class="n">username</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">username</span><span class="p">,</span>
+            <span class="n">model_id</span><span class="o">=</span><span class="n">model_id</span><span class="p">,</span>
+            <span class="n">session_id</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">log_id</span>
+        <span class="p">)</span>
+        <span class="c1"># Get cost from usage tracker</span>
+        <span class="c1">#from mindroot.coreplugins.usage.storage import UsageStorage</span>
+        <span class="c1">#from mindroot.coreplugins.usage.handlers import UsageTracker</span>
+        <span class="c1">#storage = UsageStorage(self.base_path)</span>
+        <span class="c1">#tracker = UsageTracker(storage)</span>
+        <span class="n">monetary_cost</span> <span class="o">=</span> <span class="k">await</span> <span class="n">context</span><span class="o">.</span><span class="n">get_cost</span><span class="p">(</span><span class="n">plugin_id</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">,</span> <span class="n">model_id</span><span class="p">)</span> <span class="o">*</span> <span class="n">quantity</span>
+        <span class="c1">#monetary_cost = await tracker.get_cost(plugin_id, cost_type_id, model_id) * quantity</span>
+        <span class="n">credit_cost</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_calculate_credit_cost</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">monetary_cost</span><span class="p">)</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">ledger</span><span class="o">.</span><span class="n">record_usage</span><span class="p">(</span>
+                <span class="n">username</span><span class="o">=</span><span class="n">event</span><span class="o">.</span><span class="n">username</span><span class="p">,</span>
+                <span class="n">amount</span><span class="o">=</span><span class="n">credit_cost</span><span class="p">,</span>
+                <span class="n">source</span><span class="o">=</span><span class="s1">&#39;usage_deduction&#39;</span><span class="p">,</span>
+                <span class="n">reference_id</span><span class="o">=</span><span class="n">event</span><span class="o">.</span><span class="n">session_id</span><span class="p">,</span>
+                <span class="n">metadata</span><span class="o">=</span><span class="p">{</span>
+                    <span class="s1">&#39;plugin_id&#39;</span><span class="p">:</span> <span class="n">event</span><span class="o">.</span><span class="n">plugin_id</span><span class="p">,</span>
+                    <span class="s1">&#39;cost_type_id&#39;</span><span class="p">:</span> <span class="n">event</span><span class="o">.</span><span class="n">cost_type_id</span><span class="p">,</span>
+                    <span class="s1">&#39;model_id&#39;</span><span class="p">:</span> <span class="n">event</span><span class="o">.</span><span class="n">model_id</span><span class="p">,</span>
+                    <span class="s1">&#39;monetary_cost&#39;</span><span class="p">:</span> <span class="n">monetary_cost</span><span class="p">,</span>
+                    <span class="s1">&#39;credit_ratio&#39;</span><span class="p">:</span> <span class="n">credit_cost</span> <span class="o">/</span> <span class="n">monetary_cost</span> <span class="k">if</span> <span class="n">monetary_cost</span> <span class="k">else</span> <span class="mi">0</span><span class="p">,</span>
+                    <span class="s1">&#39;quantity&#39;</span><span class="p">:</span> <span class="n">event</span><span class="o">.</span><span class="n">quantity</span><span class="p">,</span>
+                    <span class="s1">&#39;original_metadata&#39;</span><span class="p">:</span> <span class="n">event</span><span class="o">.</span><span class="n">metadata</span>
+                <span class="p">}</span>
+            <span class="p">)</span>
+        <span class="k">except</span> <span class="n">InsufficientCreditsError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+            <span class="c1"># Here you might want to implement specific handling for insufficient credits</span>
+            <span class="c1"># For now, we&#39;ll just re-raise the exception</span>
+            <span class="k">raise</span></div>
+</div>
+<div class="viewcode-block" id="CreditPolicy">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.conversion.CreditPolicy">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">CreditPolicy</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Encapsulates credit-related business rules and policies&quot;&quot;&quot;</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ledger</span><span class="p">:</span> <span class="n">CreditLedger</span><span class="p">,</span> <span class="n">ratio_config</span><span class="p">:</span> <span class="n">CreditRatioConfig</span><span class="p">,</span> <span class="n">base_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">ledger</span> <span class="o">=</span> <span class="n">ledger</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">ratio_config</span> <span class="o">=</span> <span class="n">ratio_config</span>
+<div class="viewcode-block" id="CreditPolicy.check_operation_allowed">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.conversion.CreditPolicy.check_operation_allowed">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">check_operation_allowed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                                    <span class="n">plugin_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                                    <span class="n">cost_type_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                                    <span class="n">estimated_cost</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                                    <span class="n">model_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Check if an operation should be allowed based on estimated cost&quot;&quot;&quot;</span>
+        <span class="c1"># Convert monetary cost to credits</span>
+        <span class="n">ratio</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">ratio_config</span><span class="o">.</span><span class="n">get_ratio</span><span class="p">(</span><span class="n">plugin_id</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">,</span> <span class="n">model_id</span><span class="p">)</span>
+        <span class="n">estimated_credits</span> <span class="o">=</span> <span class="n">estimated_cost</span> <span class="o">*</span> <span class="n">ratio</span>
+        <span class="c1"># Check if user has sufficient credits</span>
+        <span class="n">has_credits</span><span class="p">,</span> <span class="n">current_balance</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">ledger</span><span class="o">.</span><span class="n">check_credits_available</span><span class="p">(</span>
+            <span class="n">username</span><span class="p">,</span> <span class="n">estimated_credits</span>
+        <span class="p">)</span>
+        <span class="k">return</span> <span class="n">has_credits</span></div>
+<div class="viewcode-block" id="CreditPolicy.get_user_limits">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.conversion.CreditPolicy.get_user_limits">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_user_limits</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get user&#39;s credit limits and current usage&quot;&quot;&quot;</span>
+        <span class="n">current_balance</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">ledger</span><span class="o">.</span><span class="n">get_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
+        <span class="c1"># You could extend this with more sophisticated limit calculations</span>
+        <span class="k">return</span> <span class="p">{</span>
+            <span class="s1">&#39;current_balance&#39;</span><span class="p">:</span> <span class="n">current_balance</span><span class="p">,</span>
+            <span class="s1">&#39;can_use_services&#39;</span><span class="p">:</span> <span class="n">current_balance</span> <span class="o">&gt;</span> <span class="mi">0</span>
+        <span class="p">}</span></div>
+<div class="viewcode-block" id="CreditPolicy.estimate_credits_needed">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.conversion.CreditPolicy.estimate_credits_needed">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">estimate_credits_needed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                                   <span class="n">cost_type_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                                   <span class="n">estimated_cost</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                                   <span class="n">model_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Estimate credits needed for an operation&quot;&quot;&quot;</span>
+        <span class="n">ratio</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">ratio_config</span><span class="o">.</span><span class="n">get_ratio</span><span class="p">(</span><span class="n">plugin_id</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">,</span> <span class="n">model_id</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">estimated_cost</span> <span class="o">*</span> <span class="n">ratio</span></div>
+</div>
+</pre></div>
+           </div>
+          </div>
+          <footer>
+  <hr/>
+  <div role="contentinfo">
+    <p>&#169; Copyright 2025, Jason Livesay.</p>
+  </div>
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+</body>
+</html>