Skip to content

nl2br

NL2BR Extension.

A Python-Markdown extension to treat newlines as hard breaks; like GitHub-flavored Markdown does.

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

Oringinal code Copyright 2011 Brian Neal

All changes Copyright 2011-2014 The Python Markdown Project

License: BSD

Attributes

BR_RE = '\\n' module-attribute

Classes

Nl2BrExtension(*args, **kwargs)

Bases: Extension

Newline to br extension.

Initiate Extension and set up configs.

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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

Methods:

extendMarkdown(md, md_globals)
Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/nl2br.py 
27
28
29
def extendMarkdown(self, md, md_globals):
    br_tag = SubstituteTagPattern(BR_RE, "br")
    md.inlinePatterns.add("nl", br_tag, "_end")
getConfig(key, default='')

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

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/__init__.py 
53
54
55
56
57
58
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 
60
61
62
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 
64
65
66
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 
68
69
70
71
72
73
74
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 
76
77
78
79
80
81
82
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)

Functions:

makeExtension(*args, **kwargs)

Source code in pyrevitlib/pyrevit/coreutils/markdown/extensions/nl2br.py 
32
33
def makeExtension(*args, **kwargs):
    return Nl2BrExtension(*args, **kwargs)