https://github.com/ned14/automodinit

Solves the problem of forgetting to keep __init__.py files up to date
https://github.com/ned14/automodinit

Last synced: 11 days ago
JSON representation

Solves the problem of forgetting to keep __init__.py files up to date

• Host: GitHub
• URL: https://github.com/ned14/automodinit
• Owner: ned14
• Created: 2012-03-05T01:38:06.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2017-03-05T16:46:10.000Z (over 7 years ago)
• Last Synced: 2024-10-07T19:07:46.408Z (about 1 month ago)
• Language: Python
• Homepage: http://pypi.python.org/pypi/automodinit
• Size: 14.6 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.txt

Awesome Lists containing this project

README

        
automodinit v0.16 5th March 2017:

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Niall Douglas http://www.nedproductions.biz/

See http://pypi.python.org/pypi/automodinit for latest version

Go to http://github.com/ned14/automodinit to report bugs

This package fixes a small problem which has been bugging me throughout

years of python development: forgetting to keep a module's __init__.py

up to date with new files added. This causes the following, irritating

problems:

1. Test suites don't find docstring tests.

2. Static analysis tools don't see some module content in __all__.

3. Things which scan themselves for plugins mismatch what os.listdir()

   returns as against what the module import table has.

4. I waste time over something which should take care of itself.

5. os.listdir() based solutions tend to fail when freezed into

   an executable binary because they don't understand running from

   inside a ZIP archive.

   

So here's how to make the problem go away forever:

 

1. Include the automodinit package into your setup.py dependencies.

2. Replace all __init__.py files like this:

 

__all__ = ["I will get rewritten"]

# Don't modify the line above, or this line!

import automodinit

automodinit.automodinit(__name__, __file__, globals())

del automodinit

# Anything else you want can go after here, it won't get modified.

3. That's it! From now on importing a module will set __all__ to

   a list of .py[co] files in the module and will also import each

   of those files as though you had typed:

   

   for x in __all__: import x

   

   Therefore the effect of "from M import *" matches exactly "import M".

   

Customising:

-=-=-=-=-=-=

automodinit can take the following additional parameters:

filter: This is a callable which will be passed a list of tuples

        (loader, modulename, ispkg) which is the output of

        pkgutil.iter_modules() for the calling module. Return only

        those which you want to be imported.

importFindings: Defaults to True. Set to False to not auto-import

                the contents of __all__.

Version history:

-=-=-=-=-=-=-=-=

 * v0.16 5th Mar 2017

   * Fixed stripping of __init__.py file encoding. Thanks to wtyerogers

for reporting this.

   * Removed suggestion this is the smallest package on pypi. Thanks to

asl97 for reporting this.

   * Tell PyPi we are under the MIT licence. Thanks to njwhite for

reporting this.

 * v0.13 9th Feb 2013

   * Fixed a bug where the source distribution would fail to install due

to not including distribute_setup.py. Thanks to kanzure for reporting this.

 * v0.12 5th Mar 2012

   * Fixed a bug where isinstance would occasionally fail. Turns out the

pkgutil loading mechanism doesn't check to see if the module is already

loaded, so it was loading duplicates whose types wouldn't compare.

 * v0.11 5th Mar 2012

   * Fixed some typos in Readme.txt

   * Typically what worked before packaging did not work after. Fixed!

 * v0.10 5th Mar 2012

   First release