Developer guide¶

Source code repositories¶

OpenFisca is distributed across many Git repositories. There are two types of repositories, those shared by everyone and country/jurisdiction specific repositories.

Here are some of the main repositories shared by everyone:

These can all be found at https://github.com/openfisca.

Debugging code¶

If you install ipdb (pip install ipdb) the API server will drop you into a debugger when an exception occurs:

$ paster serve --reload development-france.ini
Starting server in PID 3815.
serving on 0.0.0.0:2000 view at http://127.0.0.1:2000
model.py(52)get_cached_composed_reform()
     51
---> 52     full_key = '.'.join(
     53         tax_benefit_system.full_key + reform_keys

ipdb> tax_benefit_system
<openfisca_web_api.environment.TaxBenefitSystem object at 0x7f7eb8e88d10>
ipdb> tax_benefit_system.full_key
u'paris'
ipdb>

Profiling code¶

To profile the execution of a portion of code, wrap it with these lines:

+    import cProfile
+    pr = cProfile.Profile()
+    pr.enable()

     [...portion of code...]

+    pr.disable()
+    pr.dump_stats('result.profile')

Each time you call the endpoint a result.profile file is written. To prevent it from being overwritten, generate a dynamic name with tempfile.mkstemp.

Then you can use the runsnakerun GUI to inspect the profile data.

Under Debian GNU/Linux:
aptitude install runsnakerun

For a throughout example on profiling and debugging please take a look at How to profile the performance of a simulation.