__init__.py 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. # markdown is released under the BSD license
  2. # Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later)
  3. # Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
  4. # Copyright 2004 Manfred Stienstra (the original version)
  5. #
  6. # All rights reserved.
  7. #
  8. # Redistribution and use in source and binary forms, with or without
  9. # modification, are permitted provided that the following conditions are met:
  10. #
  11. # * Redistributions of source code must retain the above copyright
  12. # notice, this list of conditions and the following disclaimer.
  13. # * Redistributions in binary form must reproduce the above copyright
  14. # notice, this list of conditions and the following disclaimer in the
  15. # documentation and/or other materials provided with the distribution.
  16. # * Neither the name of the <organization> nor the
  17. # names of its contributors may be used to endorse or promote products
  18. # derived from this software without specific prior written permission.
  19. #
  20. # THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY
  21. # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22. # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23. # DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTORS TO THE PYTHON MARKDOWN PROJECT
  24. # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25. # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26. # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27. # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28. # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29. # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30. # POSSIBILITY OF SUCH DAMAGE.
  31. """
  32. Extensions
  33. -----------------------------------------------------------------------------
  34. """
  35. from __future__ import unicode_literals
  36. class Extension(object):
  37. """ Base class for extensions to subclass. """
  38. def __init__(self, configs = {}):
  39. """Create an instance of an Extention.
  40. Keyword arguments:
  41. * configs: A dict of configuration setting used by an Extension.
  42. """
  43. self.config = configs
  44. def getConfig(self, key, default=''):
  45. """ Return a setting for the given key or an empty string. """
  46. if key in self.config:
  47. return self.config[key][0]
  48. else:
  49. return default
  50. def getConfigs(self):
  51. """ Return all configs settings as a dict. """
  52. return dict([(key, self.getConfig(key)) for key in self.config.keys()])
  53. def getConfigInfo(self):
  54. """ Return all config descriptions as a list of tuples. """
  55. return [(key, self.config[key][1]) for key in self.config.keys()]
  56. def setConfig(self, key, value):
  57. """ Set a config setting for `key` with the given `value`. """
  58. self.config[key][0] = value
  59. def extendMarkdown(self, md, md_globals):
  60. """
  61. Add the various proccesors and patterns to the Markdown Instance.
  62. This method must be overriden by every extension.
  63. Keyword arguments:
  64. * md: The Markdown instance.
  65. * md_globals: Global variables in the markdown module namespace.
  66. """
  67. raise NotImplementedError('Extension "%s.%s" must define an "extendMarkdown"' \
  68. 'method.' % (self.__class__.__module__, self.__class__.__name__))