pyproforma 0.2.2__tar.gz → 0.2.4__tar.gz

{pyproforma-0.2.2/pyproforma.egg-info → pyproforma-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyproforma
-Version: 0.2.2
+Version: 0.2.4
 Summary: A Python package for financial modeling and reporting
 Author-email: Robert Hannay <rhannay@gmail.com>
 Maintainer-email: Robert Hannay <rhannay@gmail.com>
@@ -22,19 +22,21 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pandas>=1.3.0
-Requires-Dist: openpyxl>=3.0.0
-Requires-Dist: jinja2>=3.0.0
-Requires-Dist: plotly>=5.0.0
-Requires-Dist: PyYAML>=6.0.0
-Requires-Dist: nbformat>=5.0.0
-Provides-Extra: dev
-Requires-Dist: pytest>=6.0; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.3.0; extra == "pandas"
+Provides-Extra: excel
+Requires-Dist: openpyxl>=3.0.0; extra == "excel"
+Provides-Extra: charts
+Requires-Dist: matplotlib>=3.5.0; extra == "charts"
 Provides-Extra: notebook
 Requires-Dist: ipython>=7.0.0; extra == "notebook"
 Provides-Extra: explorer
 Requires-Dist: flask>=2.0.0; extra == "explorer"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pandas>=1.3.0; extra == "dev"
+Requires-Dist: openpyxl>=3.0.0; extra == "dev"
 Dynamic: license-file
 
 # pyproforma

{pyproforma-0.2.2 → pyproforma-0.2.4}/pyproforma/__init__.py

@@ -3,7 +3,26 @@ PyProforma - A lightweight financial modeling framework.
 """
 
 from .charts.chart_def import ChartDef
-from .tables.table_def import TableDef
+from .compare import ModelComparison
+from .engine import LineItemValue, LineItemValues
+from .proforma_model import ProformaModel
+from .results import LineItemResult, LineItemSelection, ScalarResult
+from .results.tags_namespace import TagNamespace
+from .specs import (
+    DebtCalculator,
+    DebtConfig,
+    DebtInterestLine,
+    DebtPrincipalLine,
+    FixedLine,
+    FormulaLine,
+    InputLine,
+    LineItem,
+    ScalarInputLine,
+    ScalarLine,
+    create_debt_lines,
+)
+from .table import Format, NumberFormatSpec
+from .tables import Tables
 from .tables.row_types import (
     BlankRow,
     CumulativeChangeRow,
@@ -16,25 +35,7 @@ from .tables.row_types import (
     TagItemsRow,
     TagTotalRow,
 )
-from .line_items import (
-    DebtCalculator,
-    DebtInterestLine,
-    DebtPrincipalLine,
-    FixedLine,
-    FormulaLine,
-    InputLine,
-    LineItem,
-    LineItemResult,
-    LineItemSelection,
-    LineItemValue,
-    LineItemValues,
-    create_debt_lines,
-)
-from .table import Format, NumberFormatSpec
-from .compare import ModelComparison
-from .proforma_model import ProformaModel
-from .tables import Tables
-from .tags_namespace import ModelTagNamespace
+from .tables.table_def import TableDef
 
 __all__ = [
     "ProformaModel",
@@ -53,16 +54,20 @@ __all__ = [
     "FixedLine",
     "FormulaLine",
     "InputLine",
+    "ScalarLine",
+    "ScalarInputLine",
+    "ScalarResult",
     "DebtPrincipalLine",
     "DebtInterestLine",
     "DebtCalculator",
+    "DebtConfig",
     "create_debt_lines",
     "LineItem",
     "LineItemValues",
     "LineItemValue",
     "LineItemResult",
     "LineItemSelection",
-    "ModelTagNamespace",
+    "TagNamespace",
     "Tables",
     "ModelComparison",
     "Format",

{pyproforma-0.2.2 → pyproforma-0.2.4}/pyproforma/chart/renderers/matplotlib_renderer.py

@@ -7,8 +7,8 @@ chart types. Applies NumberFormatSpec to y-axis tick labels when set.
 
 from __future__ import annotations
 
-from pyproforma.chart.renderers.base import ChartRenderer
 from pyproforma.chart.chart import Chart as ChartSpec
+from pyproforma.chart.renderers.base import ChartRenderer
 
 
 class MatplotlibRenderer(ChartRenderer):
@@ -26,7 +26,6 @@ class MatplotlibRenderer(ChartRenderer):
             matplotlib.figure.Figure
         """
         import matplotlib.pyplot as plt
-        import numpy as np
 
         fig, ax = plt.subplots(figsize=figsize)
 
@@ -109,6 +108,7 @@ class MatplotlibRenderer(ChartRenderer):
             return
 
         from matplotlib.ticker import FuncFormatter
+
         from pyproforma.table.format_value import format_value
 
         fmt = spec.value_format

{pyproforma-0.2.2 → pyproforma-0.2.4}/pyproforma/charts/chart_def.py

@@ -6,8 +6,7 @@ chart type, title, and optional per-series colors. Accepts either the dataclass
 form (IDE autocomplete, validation) or a plain dict (JSON-serializable configs).
 """
 
-from dataclasses import dataclass, field
-from typing import Union
+from dataclasses import dataclass
 
 from pyproforma.chart.chart import ChartType
 

{pyproforma-0.2.2 → pyproforma-0.2.4}/pyproforma/charts/charts.py

@@ -15,6 +15,7 @@ from typing import TYPE_CHECKING
 from pyproforma.chart.chart import Chart, ChartSeries, ChartType
 
 if TYPE_CHECKING:
+    from pyproforma.charts.chart_def import ChartDef
     from pyproforma.proforma_model import ProformaModel
 
 
@@ -113,7 +114,9 @@ class Charts:
         Examples:
             >>> model.charts.line_items(["revenue", "expenses"]).show()
             >>> model.charts.line_items(["revenue", "cogs"], chart_type="stacked_bar").show()
-            >>> model.charts.line_items(["revenue", "expenses"], value_format=Format.MILLIONS_M).show()
+            >>> model.charts.line_items(  # noqa: E501
+            ...     ["revenue", "expenses"], value_format=Format.MILLIONS_M
+            ... ).show()
         """
         for name in names:
             self._validate_line_item(name)

{pyproforma-0.2.2 → pyproforma-0.2.4}/pyproforma/compare/model_comparison.py

@@ -293,7 +293,9 @@ class ModelComparison:
             for model, label in zip(self.models, self.labels):
                 row = [Cell(value=label, align="left")]
                 for period in self.common_periods:
-                    row.append(Cell(value=model.get_value(item_name, period), value_format=value_format))
+                    row.append(
+                        Cell(value=model.get_value(item_name, period), value_format=value_format)
+                    )
                 all_rows.append(row)
 
             # Difference row(s)

pyproforma-0.2.4/pyproforma/engine/__init__.py

@@ -0,0 +1,14 @@
+"""
+Calculation internals — engine and namespace.
+"""
+
+from .calculation_engine import calculate_line_items
+from .line_item_values import LineItemValue, LineItemValues
+from .model_namespace import ModelNamespace
+
+__all__ = [
+    "calculate_line_items",
+    "LineItemValues",
+    "LineItemValue",
+    "ModelNamespace",
+]

{pyproforma-0.2.2/pyproforma → pyproforma-0.2.4/pyproforma/engine}/calculation_engine.py

@@ -8,7 +8,7 @@ values across periods.
 from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
-    from .line_items.line_item_values import LineItemValues
+    from .line_item_values import LineItemValues
 
 
 def calculate_line_items(
@@ -27,13 +27,15 @@ def calculate_line_items(
     Returns:
         LineItemValues: Populated container with all calculated values.
     """
-    from .line_items.debt_line import DebtBase
-    from .line_items.fixed_line import FixedLine
-    from .line_items.formula_line import FormulaLine
-    from .line_items.input_line import InputLine
-    from .line_items.line_item_values import LineItemValues
+    from pyproforma.specs.debt_line import DebtBase
+    from pyproforma.specs.fixed_line import FixedLine
+    from pyproforma.specs.formula_line import FormulaLine
+    from pyproforma.specs.input_line import InputLine
+
+    from .line_item_values import LineItemValues
     from .model_namespace import ModelNamespace
 
+    # scalar_names are already resolved into the scalars dict — skip them here
     li = LineItemValues(periods=periods, names=model.line_item_names, model=model)
 
     fixed_items = []
@@ -80,7 +82,7 @@ def calculate_line_items(
                         still_pending.append(name)
                     else:
                         raise ValueError(
-                            f"Error evaluating formula for '{line_item.name}' in period {period}: {e}"
+                            f"Error evaluating formula for '{line_item.name}' in period {period}: {e}"  # noqa: E501
                         ) from e
 
             if len(still_pending) == len(remaining):
@@ -100,20 +102,19 @@ def _calculate_single_line_item(
     period: int,
     model: Any = None,
 ) -> Any:
-    from .line_items.debt_line import DebtBase
-    from .line_items.fixed_line import FixedLine
-    from .line_items.formula_line import FormulaLine
-    from .line_items.input_line import InputLine
+    from pyproforma.specs.debt_line import DebtBase
+    from pyproforma.specs.fixed_line import FixedLine
+    from pyproforma.specs.formula_line import FormulaLine
+    from pyproforma.specs.input_line import InputLine
 
     if isinstance(line_item, InputLine):
         input_values = getattr(model, "_input_line_values", {})
         period_values = input_values.get(line_item.name, {})
-        value = period_values.get(period)
-        if value is None:
+        if period not in period_values:
             raise ValueError(
                 f"No input value for '{line_item.name}' in period {period}"
             )
-        return value
+        return period_values[period]  # None is a valid value — means "no input this period"
 
     if isinstance(line_item, FixedLine):
         value = line_item.get_value(period)
@@ -141,8 +142,15 @@ def _calculate_single_line_item(
         return value
 
     if isinstance(line_item, DebtBase):
+        debt_calculators = getattr(model, "_debt_calculators", {})
+        calculator = debt_calculators.get(id(line_item.config))
+        if calculator is None:
+            raise ValueError(
+                f"No calculator found for debt line '{line_item.name}'. "
+                f"Ensure the model was instantiated via ProformaModel.__init__."
+            )
         try:
-            value = line_item.eval(ns, period)
+            value = line_item.eval(ns, period, calculator)
         except (AttributeError, KeyError):
             raise
         except Exception as e:

{pyproforma-0.2.2/pyproforma/line_items → pyproforma-0.2.4/pyproforma/engine}/line_item_values.py

@@ -9,7 +9,49 @@ from typing import TYPE_CHECKING, Any
 if TYPE_CHECKING:
     from pyproforma.proforma_model import ProformaModel
 
-from pyproforma.tags_namespace import TagNamespace
+
+class TagSum:
+    """Sums all line items sharing a tag for a given period. Used inside formula evaluation."""
+
+    def __init__(self, model: "ProformaModel", li: "LineItemValues", tag: str):
+        self._model = model
+        self._li = li
+        self._tag = tag
+
+    def __getitem__(self, period: int) -> float:
+        if period not in self._model.periods:
+            raise KeyError(
+                f"Period {period} not found in model. "
+                f"Available periods: {self._model.periods}"
+            )
+        total = 0.0
+        for name in self._model.line_item_names:
+            spec = getattr(self._model.__class__, name)
+            if hasattr(spec, "tags") and self._tag in spec.tags:
+                try:
+                    value = self._li.get(name, period)
+                    if value is not None:
+                        total += value
+                except (AttributeError, KeyError):
+                    pass
+        return total
+
+    def __repr__(self):
+        return f"TagSum(tag={self._tag!r})"
+
+
+class TagNamespace:
+    """Namespace for tag-based summation inside formula evaluation (li.tag["revenue"][t])."""
+
+    def __init__(self, model: "ProformaModel", li: "LineItemValues"):
+        self._model = model
+        self._li = li
+
+    def __getitem__(self, tag: str) -> TagSum:
+        return TagSum(self._model, self._li, tag)
+
+    def __repr__(self):
+        return f"TagNamespace(model={self._model.__class__.__name__})"
 
 
 class LineItemValues:
@@ -77,7 +119,7 @@ class LineItemValues:
         self._tag_namespace = TagNamespace(model, self) if model else None
 
     @property
-    def tag(self) -> TagNamespace:
+    def tag(self) -> "TagNamespace":
         """
         Access line items by tags.
 

{pyproforma-0.2.2/pyproforma → pyproforma-0.2.4/pyproforma/engine}/model_namespace.py

@@ -12,7 +12,24 @@ Scalar line items (FixedLine with value=, or scalar InputLine) are accessed dire
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from pyproforma.line_items.line_item_values import LineItemValues
+    from pyproforma.engine.line_item_values import LineItemValues
+
+
+class _ScalarValue(float):
+    """float subclass returned for scalar line items in formulas.
+
+    Raises a clear TypeError if the caller tries li.rate[t] instead of li.rate.
+    """
+
+    def __new__(cls, value: float, name: str):
+        inst = super().__new__(cls, value)
+        inst._name = name
+        return inst
+
+    def __getitem__(self, key):
+        raise TypeError(
+            f"'{self._name}' is a scalar — use li.{self._name}, not li.{self._name}[{key}]"
+        )
 
 
 class ModelNamespace:
@@ -48,7 +65,10 @@ class ModelNamespace:
             return li.tag
 
         if name in scalars:
-            return scalars[name]
+            value = scalars[name]
+            if isinstance(value, (int, float)) and not isinstance(value, bool):
+                return _ScalarValue(value, name)
+            return value
 
         li_error = None
         try:

pyproforma-0.2.4/pyproforma/explorer/__init__.py

@@ -0,0 +1,4 @@
+from .app import create_app
+from .components import InputGroup, StatCard
+
+__all__ = ["create_app", "InputGroup", "StatCard"]