Tools#

The policyengine_core.tools module contains miscellaneous utility functions, including for running YAML tests.

run_tests#

policyengine_core.tools.test_runner.run_tests(tax_benefit_system, paths, options=None)[source]#

Runs all the YAML tests contained in a file or a directory.

If path is a directory, subdirectories will be recursively explored.

Parameters
  • tax_benefit_system (TaxBenefitSystem) – the tax-benefit system to use to run the tests

  • paths ((str/list)) – A path, or a list of paths, towards the files or directories containing the tests to run. If a path is a directory, subdirectories will be recursively explored.

  • options (dict) – See more details below.

Raises

AssertionError – if a test does not pass

Returns

the number of sucessful tests excecuted

Testing options:

dump_simulation#

policyengine_core.tools.simulation_dumper.dump_simulation(simulation, directory)[source]#

Write simulation data to directory, so that it can be restored later.

restore_simulation#

policyengine_core.tools.simulation_dumper.restore_simulation(directory, tax_benefit_system, **kwargs)[source]#

Restore simulation from directory