Merge pull request #18 from PolicyEngine/stocks-and-flows

Stocks/flows

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.1] - 2022-01-17
+
+### Added
+
+* Optional metadata field for stock/flow type for variables.
+
 ## [0.2.0] - 2022-01-16
 
 ### Added

openfisca_tools/model_api.py

@@ -13,13 +13,25 @@
 
 ReformType = Union[Reform, Tuple[Reform]]
 
+allowed_variable_attributes = ("metadata", "quantity_type")
+
+STOCK = "Stock"
+FLOW = "Flow"
+
 
 class Variable(CoreVariable):
+    quantity_type: str = FLOW
+
     def __init__(self, baseline_variable=None):
         try:
             CoreVariable.__init__(self, baseline_variable=baseline_variable)
         except ValueError as e:
-            if "metadata" not in str(e):
+            if all(
+                [
+                    attribute not in str(e)
+                    for attribute in allowed_variable_attributes
+                ]
+            ):
                 raise e
 
         self.is_neutralized = False

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="OpenFisca-Tools",
-    version="0.2.0",
+    version="0.2.1",
     author="PolicyEngine",
     license="http://www.fsf.org/licensing/licenses/agpl-3.0.html",
     url="https://github.com/policyengine/openfisca-tools",