abbr

Abbreviation Extension for Python-Markdown.

This extension adds abbreviation handling to Python-Markdown.

See https://pythonhosted.org/Markdown/extensions/abbreviations.html for documentation.

Oringinal code Copyright 2007-2008 Waylan Limberg and Seemant Kulleen

All changes Copyright 2008-2014 The Python Markdown Project

License: BSD

Attributes

ABBR_REF_RE = re.compile('[*]\\[(?P<abbr>[^\\]]*)\\][ ]?:\\s*(?P<title>.*)') module-attribute

Classes

AbbrExtension(*args, **kwargs)

Bases: Extension

Abbreviation Extension for Python-Markdown.

Initiate Extension and set up configs.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py

def __init__(self, *args, **kwargs):
    """Initiate Extension and set up configs."""
    # check for configs arg for backward compat.
    # (there only ever used to be one so we use arg[0])
    if len(args):
        if args[0] is not None:
            self.setConfigs(args[0])
        warnings.warn('Extension classes accepting positional args is '
                      'pending Deprecation. Each setting should be '
                      'passed into the Class as a keyword. Positional '
                      'args are deprecated and will raise '
                      'an error in version 2.7. See the Release Notes for '
                      'Python-Markdown version 2.6 for more info.',
                      DeprecationWarning)
    # check for configs kwarg for backward compat.
    if 'configs' in kwargs.keys():
        if kwargs['configs'] is not None:
            self.setConfigs(kwargs.pop('configs', {}))
        warnings.warn('Extension classes accepting a dict on the single '
                      'keyword "config" is pending Deprecation. Each '
                      'setting should be passed into the Class as a '
                      'keyword directly. The "config" keyword is '
                      'deprecated and raise an error in '
                      'version 2.7. See the Release Notes for '
                      'Python-Markdown version 2.6 for more info.',
                      DeprecationWarning)
    # finally, use kwargs
    self.setConfigs(kwargs)

Attributes

config = {} class-attribute instance-attribute

Functions

getConfig(key, default='')

Return a setting for the given key or an empty string.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py

def getConfig(self, key, default=''):
    """Return a setting for the given key or an empty string."""
    if key in self.config:
        return self.config[key][0]
    else:
        return default

getConfigs()

Return all configs settings as a dict.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py

def getConfigs(self):
    """Return all configs settings as a dict."""
    return dict([(key, self.getConfig(key)) for key in self.config.keys()])

getConfigInfo()

Return all config descriptions as a list of tuples.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py

def getConfigInfo(self):
    """Return all config descriptions as a list of tuples."""
    return [(key, self.config[key][1]) for key in self.config.keys()]

setConfig(key, value)

Set a config setting for key with the given value.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py

def setConfig(self, key, value):
    """Set a config setting for `key` with the given `value`."""
    if isinstance(self.config[key][0], bool):
        value = parseBoolValue(value)
    if self.config[key][0] is None:
        value = parseBoolValue(value, preserve_none=True)
    self.config[key][0] = value

setConfigs(items)

Set multiple config settings given a dict or list of tuples.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py

def setConfigs(self, items):
    """Set multiple config settings given a dict or list of tuples."""
    if hasattr(items, 'items'):
        # it's a dict
        items = items.items()
    for key, value in items:
        self.setConfig(key, value)

extendMarkdown(md, md_globals)

Insert AbbrPreprocessor before ReferencePreprocessor.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/abbr.py

def extendMarkdown(self, md, md_globals):
    """Insert AbbrPreprocessor before ReferencePreprocessor."""
    md.preprocessors.add('abbr', AbbrPreprocessor(md), '<reference')

AbbrPreprocessor(markdown_instance=None)

Bases: Preprocessor

Abbreviation Preprocessor - parse text for abbr references.

Source code in pyrevitlib/pyrevit/coreutils/markdown/util.py

def __init__(self, markdown_instance=None):
    if markdown_instance:
        self.markdown = markdown_instance

Attributes

markdown = markdown_instance instance-attribute

Functions

run(lines)

Find and remove all Abbreviation references from the text.

Each reference is set as a new AbbrPattern in the markdown instance.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/abbr.py

def run(self, lines):
    """Find and remove all Abbreviation references from the text.

    Each reference is set as a new AbbrPattern in the markdown instance.
    """
    new_text = []
    for line in lines:
        m = ABBR_REF_RE.match(line)
        if m:
            abbr = m.group('abbr').strip()
            title = m.group('title').strip()
            self.markdown.inlinePatterns['abbr-%s' % abbr] = \
                AbbrPattern(self._generate_pattern(abbr), title)
        else:
            new_text.append(line)
    return new_text

AbbrPattern(pattern, title)

Bases: Pattern

Abbreviation inline pattern.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/abbr.py

def __init__(self, pattern, title):
    super(AbbrPattern, self).__init__(pattern)
    self.title = title

Attributes

pattern = pattern instance-attribute

compiled_re = re.compile('^(.*?)%s(.*)$' % pattern, re.DOTALL | re.UNICODE) instance-attribute

safe_mode = False instance-attribute

markdown = markdown_instance instance-attribute

title = title instance-attribute

Functions

getCompiledRegExp()

Return a compiled regular expression.

Source code in pyrevitlib/pyrevit/coreutils/markdown/inlinepatterns.py

def getCompiledRegExp(self):
    """Return a compiled regular expression."""
    return self.compiled_re

type()

Return class name, to define pattern type.

Source code in pyrevitlib/pyrevit/coreutils/markdown/inlinepatterns.py

def type(self):
    """Return class name, to define pattern type."""
    return self.__class__.__name__

unescape(text)

Return unescaped text given text with an inline placeholder.

Source code in pyrevitlib/pyrevit/coreutils/markdown/inlinepatterns.py

def unescape(self, text):
    """Return unescaped text given text with an inline placeholder."""
    try:
        stash = self.markdown.treeprocessors['inline'].stashed_nodes
    except KeyError:  # pragma: no cover
        return text

    def itertext(el):  # pragma: no cover
        """Reimplement Element.itertext for older python versions."""
        tag = el.tag
        if not isinstance(tag, util.string_type) and tag is not None:
            return
        if el.text:
            yield el.text
        for e in el:
            for s in itertext(e):
                yield s
            if e.tail:
                yield e.tail

    def get_stash(m):
        id = m.group(1)
        if id in stash:
            value = stash.get(id)
            if isinstance(value, util.string_type):
                return value
            else:
                # An etree Element - return text content only
                return ''.join(itertext(value))
    return util.INLINE_PLACEHOLDER_RE.sub(get_stash, text)

handleMatch(m)

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/abbr.py

def handleMatch(self, m):
    abbr = etree.Element('abbr')
    abbr.text = AtomicString(m.group('abbr'))
    abbr.set('title', self.title)
    return abbr

Functions

makeExtension(*args, **kwargs)

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/abbr.py

def makeExtension(*args, **kwargs):
    return AbbrExtension(*args, **kwargs)