wikilinks

WikiLinks Extension for Python-Markdown.

Converts [[WikiLinks]] to relative links.

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

Original code Copyright Waylan Limberg.

All changes Copyright The Python Markdown Project

License: BSD

Classes

WikiLinkExtension(*args, **kwargs)

Bases: Extension

WikiLinks markdown extension.

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

def __init__(self, *args, **kwargs):
    self.config = {
        'base_url': ['/', 'String to append to beginning or URL.'],
        'end_url': ['/', 'String to append to end of URL.'],
        'html_class': ['wikilink', 'CSS hook. Leave blank for none.'],
        'build_url': [build_url, 'Callable formats URL from label.'],
    }

    super(WikiLinkExtension, self).__init__(*args, **kwargs)

Attributes

config = {'base_url': ['/', 'String to append to beginning or URL.'], 'end_url': ['/', 'String to append to end of URL.'], 'html_class': ['wikilink', 'CSS hook. Leave blank for none.'], 'build_url': [build_url, 'Callable formats URL from label.']} 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)

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

def extendMarkdown(self, md, md_globals):
    self.md = md

    # append to end of inline patterns
    WIKILINK_RE = r'\[\[([\w0-9_ -]+)\]\]'
    wikilinkPattern = WikiLinks(WIKILINK_RE, self.getConfigs())
    wikilinkPattern.md = md
    md.inlinePatterns.add('wikilink', wikilinkPattern, "<not_strong")

WikiLinks(pattern, config)

Bases: Pattern

WikiLinks parser.

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

def __init__(self, pattern, config):
    super(WikiLinks, self).__init__(pattern)
    self.config = config

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

config = config 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/wikilinks.py

def handleMatch(self, m):
    if m.group(2).strip():
        base_url, end_url, html_class = self._getMeta()
        label = m.group(2).strip()
        url = self.config['build_url'](label, base_url, end_url)
        a = etree.Element('a')
        a.text = label
        a.set('href', url)
        if html_class:
            a.set('class', html_class)
    else:
        a = ''
    return a

Functions

build_url(label, base, end)

Build a url from the label, a base, and an end.

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

def build_url(label, base, end):
    """Build a url from the label, a base, and an end."""
    clean_label = re.sub(r'([ ]+_)|(_[ ]+)|([ ]+)', '_', label)
    return '%s%s%s' % (base, clean_label, end)

makeExtension(*args, **kwargs)

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

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