taxcalc 4.4.0__py3-none-any.whl → 4.5.0__py3-none-any.whl

taxcalc/parameters.py

@@ -1,13 +1,14 @@
+"""
+Tax-Calculator abstract base parameter class based on paramtools package.
+"""
+
 import os
 import copy
 from collections import defaultdict
 from typing import Union, Mapping, Any, List
-
+import numpy as np
 import marshmallow as ma
 import paramtools as pt
-import numpy as np
-
-from taxcalc.growfactors import GrowFactors
 
 
 class CompatibleDataSchema(ma.Schema):
@@ -64,8 +65,8 @@ class Parameters(pt.Parameters):
     Check out the ParamTools
     `documentation <https://paramtools.dev/api/reference.html>`_
     for more information on these inherited methods.
-
     """
+    # pylint: disable=too-many-instance-attributes
     defaults = None
     array_first = True
     label_to_extend = "year"
@@ -83,6 +84,8 @@ class Parameters(pt.Parameters):
 
     def __init__(self, start_year=None, num_years=None, last_known_year=None,
                  removed=None, redefined=None, wage_indexed=None, **kwargs):
+        # pylint: disable=too-many-arguments,too-many-positional-arguments
+
         # In case we need to wait for this to be called from the
         # initialize method for legacy reasons.
         if not start_year or not num_years:
@@ -121,8 +124,12 @@ class Parameters(pt.Parameters):
         label["validators"]["range"]["max"] = last_budget_year
         super().__init__(**kwargs)
 
-    def adjust(
-        self, params_or_path, print_warnings=True, raise_errors=True, **kwargs
+    def adjust(  # pylint: disable=arguments-differ
+            # pylint warning W0221 is:
+            #   Number of parameters was 6 in 'Parameters.adjust' and
+            #   is now 5 in overriding 'Parameters.adjust' method
+            self, params_or_path,
+            print_warnings=True, raise_errors=True, **kwargs
     ):
         """
         Update parameter values using a ParamTools styled adjustment.
@@ -136,8 +143,10 @@ class Parameters(pt.Parameters):
 
                 {
                     "standard_deduction": [
-                        {"year": 2024, "marital_status": "single", "value": 10000.0},
-                        {"year": 2024, "marital_status": "joint", "value": 10000.0}
+                        {"year": 2024, "marital_status": "single",
+                         "value": 10000.0},
+                        {"year": 2024, "marital_status": "joint",
+                         "value": 10000.0}
                     ],
                     "ss_rate": [{"year": 2024, "value": 0.2}]}
                 }
@@ -154,7 +163,7 @@ class Parameters(pt.Parameters):
         adjustment : Dict
             Parsed paremeter dictionary
 
-        """  # noqa
+        """
         if print_warnings:
             _data = copy.deepcopy(self._data)
             kwargs["ignore_warnings"] = False
@@ -177,13 +186,15 @@ class Parameters(pt.Parameters):
         except pt.ValidationError as ve:
             if self.errors and raise_errors:
                 raise ve
-            elif self.errors and not raise_errors:
+            if self.errors and not raise_errors:
                 return {}
             if print_warnings:
                 print("WARNING:")
                 print(self.warnings)
             kwargs["ignore_warnings"] = True
+            # pylint: disable=possibly-used-before-assignment
             self._data = _data
+            # pylint: enable=possibly-used-before-assignment
             _warnings = copy.deepcopy(self._warnings)
             self._warnings = {}
             self._errors = {}
@@ -242,6 +253,8 @@ class Parameters(pt.Parameters):
           wiped out after the year in which the value is adjusted for the
           same hard-coding reason.
         """
+        # pylint: disable=too-many-statements,too-many-locals,too-many-branches
+
         # Temporarily turn off extra ops during the intermediary adjustments
         # so that expensive and unnecessary operations are not run.
         label_to_extend = self.label_to_extend
@@ -310,7 +323,7 @@ class Parameters(pt.Parameters):
             self.delete(to_delete, **kwargs)
 
             # 1.b For all others, these are years after last_known_year.
-            last_known_year = max(cpi_min_year["year"], self._last_known_year)
+            # last_known_year=max(cpi_min_year["year"],self._last_known_year)
             # calculate 2026 value, using new inflation rates, for parameters
             # that revert to their pre-TCJA values.
             long_params = ['II_brk7', 'II_brk6', 'II_brk5', 'II_brk4',
@@ -362,7 +375,15 @@ class Parameters(pt.Parameters):
                 ):
                     continue
                 if self._data[param].get("indexed", False):
-                    to_delete[param] = self.sel[param]["_auto"] == True  # noqa
+                    # pylint: disable=singleton-comparison
+                    to_delete[param] = self.sel[param]["_auto"] == True
+                    # pylint warning message:
+                    #   Comparison 'self.sel[param]['_auto'] == True' should
+                    #   be 'self.sel[param]['_auto'] is True' if checking for
+                    #   the singleton value True, or
+                    #   'bool(self.sel[param]['_auto'])' if testing for
+                    #   truthiness
+                    # pylint: enable=singleton-comparison
                     needs_reset.append(param)
 
             self.delete(to_delete, **kwargs)
@@ -405,13 +426,14 @@ class Parameters(pt.Parameters):
                         min_index_change_year, strict=False
                     )
 
-                    if len(list(vos)):
+                    if list(vos):
                         min_adj_year = min(vos, key=lambda vo: vo["year"])[
                             "year"
                         ]
                         self.delete(
                             {
-                                base_param: self.sel[base_param]["year"] > min_adj_year  # noqa
+                                base_param:
+                                self.sel[base_param]["year"] > min_adj_year
                             }
                         )
                         super().adjust({base_param: vos}, **kwargs)
@@ -482,40 +504,45 @@ class Parameters(pt.Parameters):
         )
         return adj
 
-    def get_index_rate(self, param, label_to_extend_val):
+    def get_index_rate(self, param, lte_val):
         """
         Initalize indexing data and return the indexing rate value
-        depending on the parameter name and label_to_extend_val, the value of
-        label_to_extend.
+        depending on the parameter name and lte_val (that is, the
+        label_to_extend_val), the value of label_to_extend.
         Returns: rate to use for indexing.
         """
         if not self._inflation_rates or not self._wage_growth_rates:
             self.set_rates()
         if param in self._wage_indexed:
-            return self.wage_growth_rates(year=label_to_extend_val)
-        else:
-            return self.inflation_rates(year=label_to_extend_val)
+            return self.wage_growth_rates(year=lte_val)
+        return self.inflation_rates(year=lte_val)
 
     def set_rates(self):
         """
-        This method is implemented by classes inheriting
-        Parameters.
+        This method is implemented by classes inheriting Parameters.
         """
         raise NotImplementedError()
 
     def wage_growth_rates(self, year=None):
+        """
+        Return wage growth rates used in parameter indexing.
+        """
         if year is not None:
             syr = max(self.start_year, self._gfactors.first_year)
             return self._wage_growth_rates[year - syr]
         return self._wage_growth_rates or []
 
     def inflation_rates(self, year=None):
+        """
+        Return price inflation rates used in parameter indexing.
+        """
         if year is not None:
             syr = max(self.start_year, self._gfactors.first_year)
             return self._inflation_rates[year - syr]
         return self._inflation_rates or []
 
-    # alias methods below
+    # alias methods below:
+
     def initialize(self, start_year, num_years, last_known_year=None,
                    removed=None, redefined=None, wage_indexed=None,
                    **kwargs):
@@ -523,13 +550,15 @@ class Parameters(pt.Parameters):
         Legacy method for initializing a Parameters instance. Projects
         should use the __init__ method in the future.
         """
-        # case where project hasn't been initialized yet.
+        # pylint: disable=too-many-arguments,too-many-positional-arguments
+        # Handle case where project hasn't been initialized yet
         if getattr(self, "_data", None) is None:
             return Parameters.__init__(
                 self, start_year, num_years, last_known_year=last_known_year,
                 removed=removed, redefined=redefined,
                 wage_indexed=wage_indexed, **kwargs
             )
+        return None  # pragma: no cover
 
     def _update(self, revision, print_warnings, raise_errors):
         """
@@ -553,13 +582,16 @@ class Parameters(pt.Parameters):
 
             {
                 "standard_deduction": [
-                    {"year": 2024, "marital_status": "single", "value": 10000.0},
-                    {"year": 2024, "marital_status": "joint", "value": 10000.0}
+                    {"year": 2024, "marital_status": "single",
+                     "value": 10000.0},
+                    {"year": 2024, "marital_status": "joint",
+                     "value": 10000.0}
                 ],
                 "ss_rate": [{"year": 2024, "value": 0.2}]}
             }
 
-        """  # noqa: E501
+        """
+        # pylint: disable=too-many-branches
         if not isinstance(revision, dict):
             raise pt.ValidationError(
                 {"errors": {"schema": "Revision must be a dictionary."}},
@@ -651,30 +683,37 @@ class Parameters(pt.Parameters):
         )
 
     def set_year(self, year):
+        """Specify parameter year"""
         self.set_state(year=year)
 
     @property
     def current_year(self):
+        """Propery docstring"""
         return self.label_grid["year"][0]
 
     @property
     def start_year(self):
+        """Propery docstring"""
         return self._stateless_label_grid["year"][0]
 
     @property
     def end_year(self):
+        """Propery docstring"""
         return self._stateless_label_grid["year"][-1]
 
     @property
     def num_years(self):
+        """Propery docstring"""
         return self.end_year - self.start_year + 1
 
     @property
     def parameter_warnings(self):
+        """Propery docstring"""
         return self.errors or {}
 
     @property
     def parameter_errors(self):
+        """Propery docstring"""
         return self.errors or {}
 
     @staticmethod
@@ -698,14 +737,17 @@ class Parameters(pt.Parameters):
 
         Some examples of valid links are:
 
-        - HTTP: ``https://raw.githubusercontent.com/PSLmodels/Tax-Calculator/master/taxcalc/reforms/2017_law.json``
+        - HTTP: ``https://raw.githubusercontent.com/PSLmodels/Tax-Calculator/
+                  master/taxcalc/reforms/2017_law.json``
 
-        - Github API: ``github://PSLmodels:Tax-Calculator@master/taxcalc/reforms/2017_law.json``
+        - Github API: ``github://PSLmodels:Tax-Calculator@master/taxcalc/
+                        reforms/2017_law.json``
 
         Checkout the ParamTools
-        `docs <https://paramtools.dev/_modules/paramtools/parameters.html#Parameters.read_params>`_
+        `docs <https://paramtools.dev/_modules/paramtools/
+                       parameters.html#Parameters.read_params>`_
         for more information on valid file URLs.
-        """  # noqa
+        """
         # embedded function used only in _read_json_revision staticmethod
         def convert_year_to_int(syr_dict):
             """
@@ -713,10 +755,10 @@ class Parameters(pt.Parameters):
             keys, into a dictionary with the same structure but having integer
             years as secondary keys.
             """
-            iyr_dict = dict()
+            iyr_dict = {}
             for pkey, sdict in syr_dict.items():
                 assert isinstance(pkey, str)
-                iyr_dict[pkey] = dict()
+                iyr_dict[pkey] = {}
                 assert isinstance(sdict, dict)
                 for skey, val in sdict.items():
                     assert isinstance(skey, str)
@@ -726,7 +768,7 @@ class Parameters(pt.Parameters):
         # end of embedded function
         # process the main function arguments
         if obj is None:
-            return dict()
+            return {}
 
         full_dict = pt.read_json(obj)
 
@@ -743,6 +785,9 @@ class Parameters(pt.Parameters):
         return convert_year_to_int(single_dict)
 
     def metadata(self):
+        """
+        Return parameter specification.
+        """
         return self.specification(meta_data=True, use_state=False)
 
     @staticmethod
@@ -752,7 +797,7 @@ class Parameters(pt.Parameters):
         assumed to have a param:year:value format.
         """
         assert isinstance(revision, dict)
-        years = list()
+        years = []
         for _, paramdata in revision.items():
             assert isinstance(paramdata, dict)
             for year, _ in paramdata.items():
@@ -774,8 +819,7 @@ class Parameters(pt.Parameters):
             return self.to_array(
                 attr[1:], year=list(range(self.start_year, self.end_year + 1))
             )
-        else:
-            raise AttributeError(f"{attr} is not defined.")
+        raise AttributeError(f"{attr} is not defined.")
 
 
 TaxcalcReform = Union[str, Mapping[int, Any]]
@@ -815,7 +859,6 @@ def is_paramtools_format(params: Union[TaxcalcReform, ParamToolsAdjustment]):
     for data in params.values():
         if isinstance(data, dict):
             return False  # taxcalc reform
-        else:
-            # Not doing a specific check to see if the value is a list
-            # since it could be a list or just a scalar value.
-            return True
+        # Not doing a specific check to see if the value is a list
+        # since it could be a list or just a scalar value.
+        return True

taxcalc/policy.py

@@ -42,7 +42,7 @@ class Policy(Parameters):
     JSON_START_YEAR = 2013  # remains the same unless earlier data added
     LAST_KNOWN_YEAR = 2025  # last year for which indexed param vals are known
     # should increase LAST_KNOWN_YEAR by one every calendar year
-    LAST_BUDGET_YEAR = 2034  # default value of last extrapolation year
+    LAST_BUDGET_YEAR = 2035  # default value of last extrapolation year
     # should increase LAST_BUDGET_YEAR by one every calendar year
 
     @staticmethod
@@ -158,7 +158,7 @@ class Policy(Parameters):
             Policy.DEFAULTS_FILE_PATH,
             Policy.DEFAULTS_FILE_NAME
         )
-        with open(path, 'r',  encoding='utf-8') as f:
+        with open(path, 'r', encoding='utf-8') as f:
             defaults = json.loads(f.read())  # pylint: disable=protected-access
         return [k for k in defaults if k != "schema"]