PSLmodels / Tax-Brain

Tax-Brain is an integrator model for PSL tax models
http://taxbrain.pslmodels.org/
MIT License
8 stars 12 forks source link

Tax-Brain module naming #164

Closed jdebacker closed 3 years ago

jdebacker commented 3 years ago

I've separately run into two import issue when trying to use the taxbrain package after building it locally:

1) An error where building noting a circular import of typing. Note that there is a module in taxbrain called typing and that module itself imports a python package called typing. 2) An error when trying to import taxbrain modules like from taxbrain import utils. The error suggests that taxbrain is not a package, making me think it is looking at the taxbrain.py module and not the taxbrain package.

On a branch I've been working in, I have renamed typing.py to tb_typing.py to remove the first error.

The second issue may require more substantive changes and triggers a question: Does it generally create issues to have modules of a package that share the same name as the package itself? In the case of taxbrain there is even a class with the same name, so you have from taxbrain.taxbrain import TaxBrain.

jdebacker commented 3 years ago

I'm closing this Issue. I was able to resolve (2) without changing module names.