plugins.py 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. #!/usr/bin/python2 -O
  2. # vim: fileencoding=utf-8
  3. #
  4. # The Qubes OS Project, https://www.qubes-os.org/
  5. #
  6. # Copyright (C) 2014-2015 Joanna Rutkowska <joanna@invisiblethingslab.com>
  7. # Copyright (C) 2014-2015 Wojtek Porczyk <woju@invisiblethingslab.com>
  8. #
  9. # This program is free software; you can redistribute it and/or modify
  10. # it under the terms of the GNU General Public License as published by
  11. # the Free Software Foundation; either version 2 of the License, or
  12. # (at your option) any later version.
  13. #
  14. # This program is distributed in the hope that it will be useful,
  15. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. # GNU General Public License for more details.
  18. #
  19. # You should have received a copy of the GNU General Public License along
  20. # with this program; if not, write to the Free Software Foundation, Inc.,
  21. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22. #
  23. '''Plugins helpers for Qubes
  24. Qubes uses two types of plugins: virtual machines and extensions.
  25. '''
  26. import imp
  27. import os
  28. class Plugin(type):
  29. '''Base metaclass for plugins'''
  30. def __init__(cls, name, bases, dict_):
  31. super(Plugin, cls).__init__(name, bases, dict_)
  32. # pylint: disable=unused-argument
  33. if hasattr(cls, 'register'):
  34. cls.register[cls.__name__] = cls
  35. else:
  36. # we've got root class
  37. cls.register = {}
  38. def load(modfile):
  39. '''Load (import) all plugins from subpackage.
  40. This function should be invoked from ``__init__.py`` in a package like that:
  41. >>> __all__ = qubes.plugins.load(__file__) # doctest: +SKIP
  42. '''
  43. path = os.path.dirname(modfile)
  44. listdir = os.listdir(path)
  45. ret = set()
  46. # pylint: disable=unused-variable
  47. for suffix, mode, type_ in imp.get_suffixes():
  48. for filename in listdir:
  49. if filename.endswith(suffix):
  50. ret.add(filename[:-len(suffix)])
  51. if '__init__' in ret:
  52. ret.remove('__init__')
  53. return list(sorted(ret))