/usr/lib/python3/dist-packages/smartypants.py is in python3-smartypants 1.8.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 | #!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2013, 2014 Yu-Jie Lin
# Copyright (c) 2004, 2005, 2007, 2013 Chad Miller
# Copyright (c) 2003 John Gruber
# Licensed under the BSD License, for detailed license information, see COPYING
"""
smartypants module
==================
:func:`smartypants` is the core of smartypants module.
"""
__author__ = 'Yu-Jie Lin'
__author_email__ = 'livibetter@gmail.com'
__version__ = '1.8.6'
__license__ = 'BSD License'
__url__ = 'https://bitbucket.org/livibetter/smartypants.py'
__description__ = 'Python with the SmartyPants'
import re
import warnings
class _Attr(object):
"""
class for instantiation of module attribute :attr:`Attr`.
"""
q = 0b000000001
"""
flag for normal quotes (``"``) and (``'``) to curly ones.
.. seealso:: :func:`convert_quotes`
"""
b = 0b000000010
"""
flag for double quotes (````backticks''``) to curly ones.
.. seealso:: :func:`convert_backticks`
"""
B = 0b000000110
"""
flag for double quotes (````backticks''``) and single quotes
(```single'``) to curly ones.
.. seealso:: :func:`convert_backticks` and :func:`convert_single_backticks`
"""
mask_b = b | B
d = 0b000001000
"""
flag for dashes (``--``) to em-dashes.
.. seealso:: :func:`convert_dashes`
"""
D = 0b000011000
"""
flag for old-school typewriter dashes (``--``) to en-dashes and dashes
(``---``) to em-dashes.
.. seealso:: :func:`convert_dashes_oldschool`
"""
i = 0b000101000
"""
flag for inverted old-school typewriter dashes (``--``) to em-dashes and
dashes (``---``) to en-dashes.
.. seealso:: :func:`convert_dashes_oldschool_inverted`
"""
mask_d = d | D | i
e = 0b001000000
"""
flag for dashes (``...``) to ellipses.
.. seealso:: :func:`convert_ellipses`
"""
w = 0b010000000
"""
flag for dashes (``"``) to ASCII double quotes (``"``).
This should be of no interest to most people, but of particular interest
to anyone who writes their posts using Dreamweaver, as Dreamweaver
inexplicably uses this entity to represent a literal double-quote
character. SmartyPants only educates normal quotes, not entities (because
ordinarily, entities are used for the explicit purpose of representing the
specific character they represent). The "w" option must be used in
conjunction with one (or both) of the other quote options ("q" or "b").
Thus, if you wish to apply all SmartyPants transformations (quotes, en-
and em-dashes, and ellipses) and also convert ``"`` entities into
regular quotes so SmartyPants can educate them.
"""
s = 0b100000000
"""
Stupefy mode. Reverses the SmartyPants transformation process, turning
the HTML entities produced by SmartyPants into their ASCII equivalents.
E.g. ``“`` is turned into a simple double-quote ("), ``—`` is
turned into two dashes, etc.
"""
set0 = 0
"suppress all transformations. (Do nothing.)"
set1 = q | b | d | e
"equivalent to :attr:`q` | :attr:`b` | :attr:`d` | :attr:`e`"
set2 = q | b | D | e
"""
equivalent to :attr:`q` | :attr:`b` | :attr:`D` | :attr:`e`
For old school en- and em- dash.
"""
set3 = q | b | i | e
"""
equivalent to :attr:`q` | :attr:`b` | :attr:`i` | :attr:`e`
For inverted old school en & em- dash."
"""
@property
def default(self):
"Default value of attributes, same value as :attr:`set1`"
global default_smartypants_attr
return default_smartypants_attr
@default.setter
def default(self, attr):
global default_smartypants_attr
default_smartypants_attr = attr
Attr = _Attr()
"""
Processing attributes, which tells :func:`smartypants` what to convert
.. seealso:: :class:`_Attr`
"""
default_smartypants_attr = Attr.set1
tags_to_skip = ['pre', 'samp', 'code', 'tt', 'kbd', 'script', 'style', 'math']
"""
Skipped HTML elements
.. seealso:: :ref:`skip-html`
"""
def _tags_to_skip_regex(tags=None):
"""
Convert a list of skipped tags into regular expression
The default *tags* are :attr:`tags_to_skip`.
>>> f = _tags_to_skip_regex
>>> print(f(['foo', 'bar']).pattern)
<(/)?(foo|bar)[^>]*>
"""
if tags is None:
tags = tags_to_skip
if isinstance(tags, (list, tuple)):
tags = '|'.join(tags)
return re.compile('<(/)?(%s)[^>]*>' % tags, re.I)
def verify_installation(request):
msg = 'Pyblosxom support will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return 1
# assert the plugin is functional
def cb_story(args):
msg = 'Pyblosxom support will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
global default_smartypants_attr
try:
forbidden_flavours = args["entry"]["smartypants_forbidden_flavours"]
except KeyError:
forbidden_flavours = ["rss"]
try:
attributes = args["entry"]["smartypants_attributes"]
except KeyError:
attributes = default_smartypants_attr
if attributes is None:
attributes = default_smartypants_attr
entryData = args["entry"].getData()
try:
if args["request"]["flavour"] in forbidden_flavours:
return
except KeyError:
if "<" in args["entry"]["body"][0:15]: # sniff the stream
return # abort if it looks like escaped HTML. FIXME
# FIXME: make these configurable, perhaps?
args["entry"]["body"] = smartypants(entryData, attributes)
args["entry"]["title"] = smartypants(args["entry"]["title"], attributes)
def _str_attr_to_int(str_attr):
"""
Convert deprecated str-type attr into int
>>> f = _str_attr_to_int
>>> f('q') == Attr.q
True
>>> f('1') == Attr.set1
True
>>> with warnings.catch_warnings(record=True) as w:
... f('bz')
... len(w)
... print(w[-1].message)
2
1
Unknown attribute: z
"""
attr = 0
for c in str_attr:
if '0' <= c <= '3':
c = 'set' + c
if not hasattr(Attr, c):
warnings.warn('Unknown attribute: %s' % c, Warning)
continue
attr |= getattr(Attr, c)
return attr
def smartyPants(text, attr=None):
msg = ('smartyPants function will be removed at Version 2.0.0, '
'use smartypants, instead')
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return smartypants(text, attr)
def smartypants(text, attr=None):
"""
SmartyPants function
>>> print(smartypants('"foo" -- bar'))
“foo” — bar
>>> print(smartypants('"foo" -- bar', Attr.d))
"foo" — bar
"""
skipped_tag_stack = []
if attr is None:
attr = Attr.default
if isinstance(attr, str):
msg = 'str-type attr will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
attr = _str_attr_to_int(attr)
do_quotes = attr & Attr.q
do_backticks = attr & Attr.mask_b
do_dashes = attr & Attr.mask_d
do_ellipses = attr & Attr.e
do_stupefy = attr & Attr.s
convert_quot = attr & Attr.w
tokens = _tokenize(text)
result = []
in_pre = False
prev_token_last_char = ""
# This is a cheat, used to get some context
# for one-character tokens that consist of
# just a quote char. What we do is remember
# the last character of the previous text
# token, to use as context to curl single-
# character quote tokens correctly.
tags_to_skip_regex = _tags_to_skip_regex()
for cur_token in tokens:
if cur_token[0] == "tag":
# Don't mess with quotes inside some tags. This does not handle
# self <closing/> tags!
result.append(cur_token[1])
skip_match = tags_to_skip_regex.match(cur_token[1])
if skip_match:
if not skip_match.group(1):
skipped_tag_stack.append(skip_match.group(2).lower())
in_pre = True
else:
if len(skipped_tag_stack) > 0:
_tag = skipped_tag_stack[-1]
if skip_match.group(2).lower() == _tag:
skipped_tag_stack.pop()
else:
pass
# This close doesn't match the open. This isn't
# XHTML. We should barf here.
if len(skipped_tag_stack) == 0:
in_pre = False
else:
t = cur_token[1]
# Remember last char of this token before processing.
last_char = t[-1:]
if not in_pre:
t = process_escapes(t)
if convert_quot:
t = re.sub('"', '"', t)
if do_dashes:
if do_dashes == Attr.d:
t = convert_dashes(t)
if do_dashes == Attr.D:
t = convert_dashes_oldschool(t)
if do_dashes == Attr.i:
t = convert_dashes_oldschool_inverted(t)
if do_ellipses:
t = convert_ellipses(t)
# Note: backticks need to be processed before quotes.
if do_backticks == Attr.b:
t = convert_backticks(t)
if do_backticks == Attr.B:
t = convert_single_backticks(t)
if do_quotes:
if t == "'":
# Special case: single-character ' token
if re.match("\S", prev_token_last_char):
t = "’"
else:
t = "‘"
elif t == '"':
# Special case: single-character " token
if re.match("\S", prev_token_last_char):
t = "”"
else:
t = "“"
else:
# Normal case:
t = convert_quotes(t)
if do_stupefy:
t = stupefy_entities(t)
prev_token_last_char = last_char
result.append(t)
return "".join(result)
def educateQuotes(text):
msg = 'educateQuotes will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return convert_quotes(text)
def convert_quotes(text):
"""
Convert quotes in *text* into HTML curly quote entities.
>>> print(convert_quotes('"Isn\\'t this fun?"'))
“Isn’t this fun?”
"""
punct_class = r"""[!"#\$\%'()*+,-.\/:;<=>?\@\[\\\]\^_`{|}~]"""
# Special case if the very first character is a quote
# followed by punctuation at a non-word-break. Close the quotes by brute
# force:
text = re.sub(r"""^'(?=%s\\B)""" % (punct_class,), '’', text)
text = re.sub(r"""^"(?=%s\\B)""" % (punct_class,), '”', text)
# Special case for double sets of quotes, e.g.:
# <p>He said, "'Quoted' words in a larger quote."</p>
text = re.sub(r""""'(?=\w)""", '“‘', text)
text = re.sub(r"""'"(?=\w)""", '‘“', text)
# Special case for decade abbreviations (the '80s):
text = re.sub(r"""\b'(?=\d{2}s)""", '’', text)
close_class = r'[^\ \t\r\n\[\{\(\-]'
dec_dashes = '–|—'
# Get most opening single quotes:
opening_single_quotes_regex = re.compile(r"""
(
\s | # a whitespace char, or
| # a non-breaking space entity, or
-- | # dashes, or
&[mn]dash; | # named dash entities
%s | # or decimal entities
&\#x201[34]; # or hex
)
' # the quote
(?=\w) # followed by a word character
""" % (dec_dashes,), re.VERBOSE)
text = opening_single_quotes_regex.sub(r'\1‘', text)
closing_single_quotes_regex = re.compile(r"""
(%s)
'
(?!\s | s\b | \d)
""" % (close_class,), re.VERBOSE)
text = closing_single_quotes_regex.sub(r'\1’', text)
closing_single_quotes_regex = re.compile(r"""
(%s)
'
(\s | s\b)
""" % (close_class,), re.VERBOSE)
text = closing_single_quotes_regex.sub(r'\1’\2', text)
# Any remaining single quotes should be opening ones:
text = re.sub("'", '‘', text)
# Get most opening double quotes:
opening_double_quotes_regex = re.compile(r"""
(
\s | # a whitespace char, or
| # a non-breaking space entity, or
-- | # dashes, or
&[mn]dash; | # named dash entities
%s | # or decimal entities
&\#x201[34]; # or hex
)
" # the quote
(?=\w) # followed by a word character
""" % (dec_dashes,), re.VERBOSE)
text = opening_double_quotes_regex.sub(r'\1“', text)
# Double closing quotes:
closing_double_quotes_regex = re.compile(r"""
#(%s)? # character that indicates the quote should be closing
"
(?=\s)
""" % (close_class,), re.VERBOSE)
text = closing_double_quotes_regex.sub('”', text)
closing_double_quotes_regex = re.compile(r"""
(%s) # character that indicates the quote should be closing
"
""" % (close_class,), re.VERBOSE)
text = closing_double_quotes_regex.sub(r'\1”', text)
# Any remaining quotes should be opening ones.
text = re.sub('"', '“', text)
return text
def educateBackticks(text):
msg = 'educateBackticks will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return convert_backticks(text)
def convert_backticks(text):
"""
Convert ````backticks''``-style double quotes in *text* into HTML curly
quote entities.
>>> print(convert_backticks("``Isn't this fun?''"))
“Isn't this fun?”
"""
text = re.sub('``', '“', text)
text = re.sub("''", '”', text)
return text
def educateSingleBackticks(text):
msg = 'educateSingleBackticks will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return convert_single_backticks(text)
def convert_single_backticks(text):
"""
Convert ```backticks'``-style single quotes in *text* into HTML curly
quote entities.
>>> print(convert_single_backticks("`Isn't this fun?'"))
‘Isn’t this fun?’
"""
text = re.sub('`', '‘', text)
text = re.sub("'", '’', text)
return text
def educateDashes(text):
msg = 'educateDashes will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return convert_dashes(text)
def convert_dashes(text):
"""
Convert ``--`` in *text* into em-dash HTML entities.
>>> quote = 'Nothing endures but change. -- Heraclitus'
>>> print(convert_dashes(quote))
Nothing endures but change. — Heraclitus
"""
text = re.sub('--', '—', text)
return text
def educateDashesOldSchool(text):
msg = 'educateDashesOldSchool will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return convert_dashes_oldschool(text)
def convert_dashes_oldschool(text):
"""
Convert ``--`` and ``---`` in *text* into en-dash and em-dash HTML
entities, respectively.
>>> quote = 'Life itself is the proper binge. --- Julia Child (1912--2004)'
>>> print(convert_dashes_oldschool(quote))
Life itself is the proper binge. — Julia Child (1912–2004)
"""
text = re.sub('---', '—', text) # em (yes, backwards)
text = re.sub('--', '–', text) # en (yes, backwards)
return text
def educateDashesOldSchoolInverted(text):
msg = 'educateDashesOldSchoolInverted will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return convert_dashes_oldschool_inverted(text)
def convert_dashes_oldschool_inverted(text):
"""
Convert ``--`` and ``---`` in *text* into em-dash and en-dash HTML
entities, respectively.
Two reasons why:
* First, unlike the en- and em-dash syntax supported by
:func:`convert_dashes_oldschool`, it's compatible with existing entries
written before SmartyPants 1.1, back when ``--`` was only used for
em-dashes.
* Second, em-dashes are more common than en-dashes, and so it sort of
makes sense that the shortcut should be shorter to type. (Thanks to Aaron
Swartz for the idea.)
>>> quote = 'Dare to be naïve. -- Buckminster Fuller (1895---1983)'
>>> print(convert_dashes_oldschool_inverted(quote))
Dare to be naïve. — Buckminster Fuller (1895–1983)
"""
text = re.sub('---', '–', text) # em
text = re.sub('--', '—', text) # en
return text
def educateEllipses(text):
msg = 'educateEllipses will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return convert_ellipses(text)
def convert_ellipses(text):
"""
Convert ``...`` in *text* into ellipsis HTML entities
>>> print(convert_ellipses('Huh...?'))
Huh…?
"""
text = re.sub(r"""\.\.\.""", '…', text)
text = re.sub(r"""\. \. \.""", '…', text)
return text
def stupefyEntities(text):
msg = 'stupefyEntities will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return stupefy_entities(text)
def stupefy_entities(text):
"""
Convert SmartyPants HTML entities in *text* into their ASCII counterparts.
>>> print(stupefy_entities('“Hello — world.”'))
"Hello -- world."
"""
text = re.sub('–', '-', text) # en-dash
text = re.sub('—', '--', text) # em-dash
text = re.sub('‘', "'", text) # open single quote
text = re.sub('’', "'", text) # close single quote
text = re.sub('“', '"', text) # open double quote
text = re.sub('”', '"', text) # close double quote
text = re.sub('…', '...', text) # ellipsis
return text
def processEscapes(text):
msg = 'processEscapes will be removed at Version 2.0.0'
warnings.filterwarnings('once', msg, DeprecationWarning)
warnings.warn(msg, DeprecationWarning)
return process_escapes(text)
def process_escapes(text):
r"""
Processe the following backslash escape sequences in *text*. This is useful
if you want to force a "dumb" quote or other character to appear.
+--------+-----------+-----------+
| Escape | Value | Character |
+========+===========+===========+
| ``\\`` | ``\`` | ``\`` |
+--------+-----------+-----------+
| ``\"`` | ``"`` | ``"`` |
+--------+-----------+-----------+
| ``\'`` | ``'`` | ``'`` |
+--------+-----------+-----------+
| ``\.`` | ``.`` | ``.`` |
+--------+-----------+-----------+
| ``\-`` | ``-`` | ``-`` |
+--------+-----------+-----------+
| ``\``` | ````` | ``\``` |
+--------+-----------+-----------+
>>> print(process_escapes(r'\\'))
\
>>> print(smartypants(r'"smarty" \"pants\"'))
“smarty” "pants"
"""
text = re.sub(r'\\\\', '\', text)
text = re.sub(r'\\"', '"', text)
text = re.sub(r"\\'", ''', text)
text = re.sub(r'\\\.', '.', text)
text = re.sub(r'\\-', '-', text)
text = re.sub(r'\\`', '`', text)
return text
def _tokenize(text):
"""
Reference to an array of the tokens comprising the input string. Each token
is either a tag (possibly with nested, tags contained therein, such as
``<a href="<MTFoo>">``, or a run of text between tags. Each element of the
array is a two-element array; the first is either 'tag' or 'text'; the
second is the actual value.
Based on the _tokenize() subroutine from `Brad Choate's MTRegex plugin`__.
__ http://www.bradchoate.com/past/mtregex.php
"""
tokens = []
tag_soup = re.compile(r'([^<]*)(<!--.*?--\s*>|<[^>]*>)', re.S)
token_match = tag_soup.search(text)
previous_end = 0
while token_match:
if token_match.group(1):
tokens.append(['text', token_match.group(1)])
# if -- in text part of comment, then it's not a comment, therefore it
# should be converted.
#
# In HTML4 [1]:
# [...] Authors should avoid putting two or more adjacent hyphens
# inside comments.
#
# In HTML5 [2]:
# [...] the comment may have text, with the additional restriction
# that the text must not [...], nor contain two consecutive U+002D
# HYPHEN-MINUS characters (--)
#
# [1]: http://www.w3.org/TR/REC-html40/intro/sgmltut.html#h-3.2.4
# [2]: http://www.w3.org/TR/html5/syntax.html#comments
tag = token_match.group(2)
type_ = 'tag'
if tag.startswith('<!--'):
# remove --[white space]> from the end of tag
if '--' in tag[4:].rstrip('>').rstrip().rstrip('-'):
type_ = 'text'
tokens.append([type_, tag])
previous_end = token_match.end()
token_match = tag_soup.search(text, token_match.end())
if previous_end < len(text):
tokens.append(['text', text[previous_end:]])
return tokens
|