diff options
| author | Yu-Jie Lin <livibetter@gmail.com> | 2013-08-12 17:11:28 +0800 |
|---|---|---|
| committer | Yu-Jie Lin <livibetter@gmail.com> | 2013-08-12 17:11:28 +0800 |
| commit | 74a1d328fddbd07b3c51744ded83db7cb3ae956d (patch) | |
| tree | 9a7f4701d644acd1a376565a0cba42342b516b24 | |
| parent | f6ba2fdba600359d646c1cf157704e753122b93f (diff) | |
| parent | 818e532a7787b133d6ee3f5ab458878c88801d29 (diff) | |
| download | smartypants-74a1d328fddbd07b3c51744ded83db7cb3ae956d.tar.gz | |
drop c94ddab86075 head
| -rw-r--r-- | .hgignore | 3 | ||||
| -rw-r--r-- | CHANGES.rst | 61 | ||||
| -rw-r--r-- | COPYING | 65 | ||||
| -rw-r--r-- | Makefile | 14 | ||||
| -rw-r--r-- | README.rst | 287 | ||||
| -rwxr-xr-x | setup.py | 234 | ||||
| -rwxr-xr-x | smartypants | 30 | ||||
| -rwxr-xr-x[-rw-r--r--] | smartypants.py | 1554 | ||||
| -rw-r--r-- | tests/test.py | 78 | ||||
| -rw-r--r-- | tests/test_cli.py | 64 |
10 files changed, 1274 insertions, 1116 deletions
diff --git a/.hgignore b/.hgignore new file mode 100644 index 0000000..ec2ea52 --- /dev/null +++ b/.hgignore @@ -0,0 +1,3 @@ +syntax: glob +dist +MANIFEST diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..aa48351 --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,61 @@ +CHANGES +======= + +Versions without timestamps mean they are future releases. + +2.0.0: + - drop Pyblosxom support + +1.7.0: + - deprecate Pyblosxom support + - add Python 3 support + - add unittest and checks + - add CLI script + +---- + +The following releases were made by Hao Lian: + +1.6.0.3: 2009-04-21 + +1.6.0.2: 2008-12-20 + +---- + +The following releases were made by Chad Miller: + +1.5_1.7: Fri, 09 Aug 2013 07:34:16 -0400 + - Add HBS language translation. Patch by by Vera Djuraskovic from + Webhostinggeeks.com + - Add Python3 support. + +1.5_1.6: Fri, 27 Jul 2007 07:06:40 -0400 + - Fixed bug where blocks of precious unalterable text was instead + interpreted. Thanks to Le Roux and Dirk van Oosterbosch. + +1.5_1.5: Sat, 13 Aug 2005 15:50:24 -0400 + - Fix bogus magical quotation when there is no hint that the + user wants it, e.g., in "21st century". Thanks to Nathan Hamblen. + - Be smarter about quotes before terminating numbers in an en-dash'ed + range. + +1.5_1.4: Thu, 10 Feb 2005 20:24:36 -0500 + - Fix a date-processing bug, as reported by jacob childress. + - Begin a test-suite for ensuring correct output. + - Removed import of "string", since I didn't really need it. + (This was my first every Python program. Sue me!) + +1.5_1.3: Wed, 15 Sep 2004 18:25:58 -0400 + - Abort processing if the flavour is in forbidden-list. Default of + [ "rss" ] (Idea of Wolfgang SCHNERRING.) + - Remove stray virgules from en-dashes. Patch by Wolfgang SCHNERRING. + +1.5_1.2: Mon, 24 May 2004 08:14:54 -0400 + - Some single quotes weren't replaced properly. Diff-tesuji played + by Benjamin GEIGER. + +1.5_1.1: Sun, 14 Mar 2004 14:38:28 -0500 + - Support upcoming pyblosxom 0.9 plugin verification feature. + +1.5_1.0: Tue, 09 Mar 2004 08:08:35 -0500 + - Initial release @@ -0,0 +1,65 @@ +SmartyPants license:: + + Copyright (c) 2003 John Gruber + (http://daringfireball.net/) + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + * Neither the name "SmartyPants" nor the names of its contributors + may be used to endorse or promote products derived from this + software without specific prior written permission. + + This software is provided by the copyright holders and contributors "as + is" and any express or implied warranties, including, but not limited + to, the implied warranties of merchantability and fitness for a + particular purpose are disclaimed. In no event shall the copyright + owner or contributors be liable for any direct, indirect, incidental, + special, exemplary, or consequential damages (including, but not + limited to, procurement of substitute goods or services; loss of use, + data, or profits; or business interruption) however caused and on any + theory of liability, whether in contract, strict liability, or tort + (including negligence or otherwise) arising in any way out of the use + of this software, even if advised of the possibility of such damage. + + +smartypants.py license:: + + smartypants.py is a derivative work of SmartyPants. + + Copyright (c) 2013 Yu-Jie Lin + Copyright (c) 2004, 2005, 2007, 2013 Chad Miller + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + This software is provided by the copyright holders and contributors "as + is" and any express or implied warranties, including, but not limited + to, the implied warranties of merchantability and fitness for a + particular purpose are disclaimed. In no event shall the copyright + owner or contributors be liable for any direct, indirect, incidental, + special, exemplary, or consequential damages (including, but not + limited to, procurement of substitute goods or services; loss of use, + data, or profits; or business interruption) however caused and on any + theory of liability, whether in contract, strict liability, or tort + (including negligence or otherwise) arising in any way out of the use + of this software, even if advised of the possibility of such damage. diff --git a/Makefile b/Makefile deleted file mode 100644 index 9fa6ed7..0000000 --- a/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -all: HEADER.html HEADER.hbs.html checksums - -HEADER.html: HEADER.en.html - mv $< $@ - -HEADER.%.html: smartypants.py - python3 $< $* >$@ - -checksums: emit - rm -f md5sums sha512sums - set -e; for f in smartypants.py-*; do md5sum $$f >>md5sums; sha512sum $$f >>sha512sums; done - -emit: - bzr tags |while read tagname revno; do bzr cat -r$$revno smartypants.py >>$$tagname; done diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b830894 --- /dev/null +++ b/README.rst @@ -0,0 +1,287 @@ +============== +smartypants.py +============== + +smartypants.py is a Python port of SmartyPants_. + +.. _SmartyPants: http://daringfireball.net/projects/smartypants/ + +.. contents:: **Contents** + + +Description +=========== + +SmartyPants can perform the following transformations: + +- Straight quotes ( " and ' ) into "curly" quote HTML entities +- Backticks-style quotes (\`\`like this'') into "curly" quote HTML entities +- Dashes (``--`` and ``---``) into en- and em-dash entities +- Three consecutive dots (``...`` or ``. . .``) into an ellipsis entity + +This means you can write, edit, and save your posts using plain old +ASCII straight quotes, plain dashes, and plain dots, but your published +posts (and final HTML output) will appear with smart quotes, em-dashes, +and proper ellipses. + +SmartyPants does not modify characters within ``<pre>``, ``<code>``, ``<kbd>``, +``<math>`` or ``<script>`` tag blocks. Typically, these tags are used to +display text where smart quotes and other "smart punctuation" would not be +appropriate, such as source code or example markup. + + +Installation +============ + +smartypants.py can be installed vi pip:: + + $ pip install smartypants + + +Usage +===== + +As module +--------- + +.. code:: python + + import smartypants + + text = '"SmartyPants" is smart, so is <code>smartypants.py</code> -- a Python port' + print(smartypants.smartyPants(text)) + +It outputs:: + + “SmartyPants” is smart, so is <code>smartypants.py</code> — a Python port + + +Via CLI +------- + +.. code:: sh + + $ echo '"SmartyPants" is smart, so is <code>smartypants.py</code> -- a Python port' | smartypants + “SmartyPants” is smart, so is <code>smartypants.py</code> — a Python port + + +Backslash Escapes +================= + +If you need to use literal straight quotes (or plain hyphens and +periods), SmartyPants accepts the following backslash escape sequences +to force non-smart punctuation. It does so by transforming the escape +sequence into a decimal-encoded HTML entity: + ++--------+-------+-----------+ +| Escape | Value | Character | ++========+=======+===========+ +| ``\\`` | \ | \\ | ++--------+-------+-----------+ +| ``\"`` | " | " | ++--------+-------+-----------+ +| ``\'`` | ' | ' | ++--------+-------+-----------+ +| ``\.`` | . | . | ++--------+-------+-----------+ +| ``\-`` | - | \- | ++--------+-------+-----------+ +| ``\``` | ` | \` | ++--------+-------+-----------+ + +This is useful, for example, when you want to use straight quotes as +foot and inch marks: 6'2" tall; a 17" iMac. + +Options +======= + +Numeric values are the easiest way to configure SmartyPants' behavior: + +"0" + Suppress all transformations. (Do nothing.) +"1" + Performs default SmartyPants transformations: quotes (including + \`\`backticks'' -style), em-dashes, and ellipses. "``--``" (dash dash) + is used to signify an em-dash; there is no support for en-dashes. + +"2" + Same as smarty_pants="1", except that it uses the old-school typewriter + shorthand for dashes: "``--``" (dash dash) for en-dashes, "``---``" + (dash dash dash) + for em-dashes. + +"3" + Same as smarty_pants="2", but inverts the shorthand for dashes: + "``--``" (dash dash) for em-dashes, and "``---``" (dash dash dash) for + en-dashes. + +"-1" + 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. + + +The following single-character attribute values can be combined to toggle +individual transformations from within the SmartyPants attributes. For +example, to educate normal quotes and em-dashes, but not ellipses or +\`\`backticks'' -style quotes: + +.. code:: python + + smartypants.smartyPants(text, '1') + +In CLI: + +.. code:: sh + + echo "$text" | smartypants -a '1' + +"q" + Educates normal quote characters: (") and ('). + +"b" + Educates \`\`backticks'' -style double quotes. + +"B" + Educates \`\`backticks'' -style double quotes and \`single' quotes. + +"d" + Educates em-dashes. + +"D" + Educates em-dashes and en-dashes, using old-school typewriter shorthand: + (dash dash) for en-dashes, (dash dash dash) for em-dashes. + +"i" + Educates em-dashes and en-dashes, using inverted old-school typewriter + shorthand: (dash dash) for em-dashes, (dash dash dash) for en-dashes. + +"e" + Educates ellipses. + +"w" + Translates any instance of ``"`` into a normal double-quote character. + 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 translate ``"`` entities into + regular quotes so SmartyPants can educate them, you should pass the + following to the smarty_pants attribute: + + +Caveats +======= + +Why You Might Not Want to Use Smart Quotes in Your Weblog +--------------------------------------------------------- + +For one thing, you might not care. + +Most normal, mentally stable individuals do not take notice of proper +typographic punctuation. Many design and typography nerds, however, break +out in a nasty rash when they encounter, say, a restaurant sign that uses +a straight apostrophe to spell "Joe's". + +If you're the sort of person who just doesn't care, you might well want to +continue not caring. Using straight quotes -- and sticking to the 7-bit +ASCII character set in general -- is certainly a simpler way to live. + +Even if you I *do* care about accurate typography, you still might want to +think twice before educating the quote characters in your weblog. One side +effect of publishing curly quote HTML entities is that it makes your +weblog a bit harder for others to quote from using copy-and-paste. What +happens is that when someone copies text from your blog, the copied text +contains the 8-bit curly quote characters (as well as the 8-bit characters +for em-dashes and ellipses, if you use these options). These characters +are not standard across different text encoding methods, which is why they +need to be encoded as HTML entities. + +People copying text from your weblog, however, may not notice that you're +using curly quotes, and they'll go ahead and paste the unencoded 8-bit +characters copied from their browser into an email message or their own +weblog. When pasted as raw "smart quotes", these characters are likely to +get mangled beyond recognition. + +That said, my own opinion is that any decent text editor or email client +makes it easy to stupefy smart quote characters into their 7-bit +equivalents, and I don't consider it my problem if you're using an +indecent text editor or email client. + + +Algorithmic Shortcomings +------------------------ + +One situation in which quotes will get curled the wrong way is when +apostrophes are used at the start of leading contractions. For example:: + + 'Twas the night before Christmas. + +In the case above, SmartyPants will turn the apostrophe into an opening +single-quote, when in fact it should be a closing one. I don't think +this problem can be solved in the general case -- every word processor +I've tried gets this wrong as well. In such cases, it's best to use the +proper HTML entity for closing single-quotes (``’``) by hand. + + +Bugs +==== + +To file bug reports or feature requests (other than topics listed in the +Caveats_ section above), please `open an issue`__. + +__ https://bitbucket.org/livibetter/smartypants.py/issues/new + +If the bug involves quotes being curled the wrong way, please add example text +to illustrate. + + +History +======= + +`John Gruber`_ did all of the hard work of writing this software in Perl for +`Movable Type`_ and almost all of this useful documentation. `Chad Miller`_ +ported it to Python to use with Pyblosxom_. + +.. _John Gruber: http://daringfireball.net/ +.. _Movable Type: http://www.movabletype.org/ +.. _Chad Miller: http://web.chad.org/ +.. _Pyblosxom: http://pyblosxom.github.io/ + +Portions of the SmartyPants original work are based on Brad Choate's nifty +MTRegex plug-in. `Brad Choate`_ also contributed a few bits of source code to +this plug-in. Brad Choate is a fine hacker indeed. + +`Jeremy Hedley`_ and `Charles Wiltgen`_ deserve mention for exemplary beta +testing of the original SmartyPants. + +`Rael Dornfest`_ ported SmartyPants to Blosxom. + +.. _Brad Choate: http://bradchoate.com/ +.. _Jeremy Hedley: http://antipixel.com/ +.. _Charles Wiltgen: http://playbacktime.com/ +.. _Rael Dornfest: http://raelity.org/ + +It was later packaged for PyPI by Hao Lian. + +Since August 2013, smartypants.py has been managed by `Yu-Jie Lin`_ after +contacted Chad Miller and Hao Lian. Lin took the project manager role and the +package ownership on PyPI. It has also officially supported Python 3. + +.. _Yu-Jie Lin: http://yjl.im/ + + +Copyright and License +===================== + +:: + + Copyright (c) 2013 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 diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..9fc0e44 --- /dev/null +++ b/setup.py @@ -0,0 +1,234 @@ +#!/usr/bin/env python +# Copyright (C) 2013 by Yu-Jie Lin +# For detail license information, See COPYING + +from __future__ import print_function +from distutils.core import Command, setup +from unittest import TestLoader, TextTestRunner +import sys + +CLI_script = 'smartypants' +module_name = 'smartypants' +module_file = 'smartypants.py' + +CHECK_FILES = ('.', CLI_script) + +# scripts to be exculded from checking +EXCLUDE_SCRIPTS = () + + +# ============================================================================ + + +class cmd_test(Command): + + description = 'run tests' + user_options = [] + + def initialize_options(self): + + pass + + def finalize_options(self): + + pass + + def run(self): + + loader = TestLoader() + tests = loader.discover(start_dir='tests') + runner = TextTestRunner(verbosity=2) + runner.run(tests) + + +class cmd_pep8(Command): + + description = 'run pep8' + user_options = [] + + def initialize_options(self): + + pass + + def finalize_options(self): + + pass + + def run(self): + + try: + import pep8 + except ImportError: + print(('Cannot import pep8, you forgot to install?\n' + 'run `pip install pep8` to install.'), file=sys.stderr) + sys.exit(1) + + p8 = pep8.StyleGuide() + + # do not include code not written in b.py + p8.options.exclude += EXCLUDE_SCRIPTS + # ignore four-space indentation error + p8.options.ignore += () + + print() + print('Options') + print('=======') + print() + print('Exclude:', p8.options.exclude) + print('Ignore :', p8.options.ignore) + + print() + print('Results') + print('=======') + print() + report = p8.check_files(CHECK_FILES) + + print() + print('Statistics') + print('==========') + print() + report.print_statistics() + print('%-7d Total errors and warnings' % report.get_count()) + + +class cmd_pyflakes(Command): + + description = 'run Pyflakes' + user_options = [] + + def initialize_options(self): + + pass + + def finalize_options(self): + + pass + + def run(self): + + try: + from pyflakes import api + from pyflakes import reporter as modReporter + except ImportError: + print(('Cannot import pyflakes, you forgot to install?\n' + 'run `pip install pyflakes` to install.'), file=sys.stderr) + sys.exit(1) + + from os.path import basename + + reporter = modReporter._makeDefaultReporter() + + # monkey patch for exclusion of pathes + api_iterSourceCode = api.iterSourceCode + + def _iterSourceCode(paths): + for path in api_iterSourceCode(paths): + if basename(path) not in EXCLUDE_SCRIPTS: + yield path + api.iterSourceCode = _iterSourceCode + + print() + print('Options') + print('=======') + print() + print('Exclude:', EXCLUDE_SCRIPTS) + + print() + print('Results') + print('=======') + print() + warnings = api.checkRecursive(CHECK_FILES, reporter) + print() + print('Total warnings: %d' % warnings) + + +class cmd_pylint(Command): + + description = 'run Pylint' + user_options = [] + + def initialize_options(self): + + pass + + def finalize_options(self): + + pass + + def run(self): + + from glob import glob + try: + from pylint import lint + except ImportError: + print(('Cannot import pylint, you forgot to install?\n' + 'run `pip install pylint` to install.'), file=sys.stderr) + sys.exit(1) + + print() + print('Options') + print('=======') + print() + print('Exclude:', EXCLUDE_SCRIPTS) + + files = ['setup.py', CLI_script, module_file] + glob('tests/*.py') + args = [ + '--ignore=%s' % ','.join(EXCLUDE_SCRIPTS), + '--output-format=colorized', + '--include-ids=y', + '--indent-string=" "', + ] + files + print() + lint.Run(args) + +# ============================================================================ + +with open(module_file) as f: + meta = dict( + (k.strip(' _'), eval(v)) for k, v in + # There will be a '\n', with eval(), it's safe to ignore + (line.split('=') for line in f if line.startswith('__')) + ) + + # renaming meta-data keys + meta_renames = [ + ('website', 'url'), + ('email', 'author_email'), + ] + for old, new in meta_renames: + if old in meta: + meta[new] = meta[old] + del meta[old] + + # keep these + meta_keys = ['name', 'description', 'version', 'license', 'url', 'author', + 'author_email'] + meta = dict([m for m in meta.items() if m[0] in meta_keys]) + +classifiers = [ + 'Development Status :: 5 - Production/Stable', + 'Intended Audience :: Developers', + 'Intended Audience :: End Users/Desktop', + 'License :: OSI Approved :: BSD License', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 3', + 'Topic :: Text Processing :: Filters', +] + +setup_d = dict( + name=module_name, + cmdclass={ + 'pep8': cmd_pep8, + 'pyflakes': cmd_pyflakes, + 'pylint': cmd_pylint, + 'test': cmd_test, + }, + classifiers=classifiers, + py_modules=[module_name], + scripts=[CLI_script], + **meta +) + +if __name__ == '__main__': + setup(**setup_d) diff --git a/smartypants b/smartypants new file mode 100755 index 0000000..67adfdc --- /dev/null +++ b/smartypants @@ -0,0 +1,30 @@ +#!/usr/bin/env python +# Copyright (c) 2013 Yu-Jie Lin +# Licensed under the BSD License, for detailed license information, see COPYING + +from __future__ import print_function +import argparse +import sys + +import smartypants + + +def main(): + + parser = argparse.ArgumentParser(description='SmartyPants in Python') + parser.add_argument('-a', '--attr', + default=smartypants.default_smartypants_attr, + help='processing attributes (Default: %(default)s)') + parser.add_argument('files', metavar='FILE', type=argparse.FileType('r'), + nargs='*', help='files to be processed ') + args = parser.parse_args() + + if args.files: + for f in args.files: + print(smartypants.smartyPants(f.read(), args.attr), end='') + else: + print(smartypants.smartyPants(sys.stdin.read(), args.attr), end='') + + +if __name__ == '__main__': + main() diff --git a/smartypants.py b/smartypants.py index a504c27..78d7ac9 100644..100755 --- a/smartypants.py +++ b/smartypants.py @@ -1,1151 +1,501 @@ #!/usr/bin/python -# coding: utf-8 - -docs = dict() -docs["en"] = r""" -============== -smartypants.py -============== - ----------------------------- -SmartyPants ported to Python ----------------------------- - -Ported by `Chad Miller`_ -Copyright (c) 2004, 2007 Chad Miller - -original `SmartyPants`_ by `John Gruber`_ -Copyright (c) 2003 John Gruber - - -Synopsis -======== - -A smart-quotes plugin for Pyblosxom_. - -The priginal "SmartyPants" is a free web publishing plug-in for Movable Type, -Blosxom, and BBEdit that easily translates plain ASCII punctuation characters -into "smart" typographic punctuation HTML entities. - -This software, *smartypants.py*, endeavours to be a functional port of -SmartyPants to Python, for use with Pyblosxom_. - - -Description -=========== - -SmartyPants can perform the following transformations: - -- Straight quotes ( " and ' ) into "curly" quote HTML entities -- Backticks-style quotes (\`\`like this'') into "curly" quote HTML entities -- Dashes (``--`` and ``---``) into en- and em-dash entities -- Three consecutive dots (``...`` or ``. . .``) into an ellipsis entity - -This means you can write, edit, and save your posts using plain old -ASCII straight quotes, plain dashes, and plain dots, but your published -posts (and final HTML output) will appear with smart quotes, em-dashes, -and proper ellipses. - -SmartyPants does not modify characters within ``<pre>``, ``<code>``, ``<kbd>``, -``<math>`` or ``<script>`` tag blocks. Typically, these tags are used to -display text where smart quotes and other "smart punctuation" would not be -appropriate, such as source code or example markup. - - -Backslash Escapes -================= - -If you need to use literal straight quotes (or plain hyphens and -periods), SmartyPants accepts the following backslash escape sequences -to force non-smart punctuation. It does so by transforming the escape -sequence into a decimal-encoded HTML entity: - -(FIXME: table here.) - -.. comment It sucks that there's a disconnect between the visual layout and table markup when special characters are involved. -.. comment ====== ===== ========= -.. comment Escape Value Character -.. comment ====== ===== ========= -.. comment \\\\\\\\ \ \\\\ -.. comment \\\\" " " -.. comment \\\\' ' ' -.. comment \\\\. . . -.. comment \\\\- - \- -.. comment \\\\` ` \` -.. comment ====== ===== ========= - -This is useful, for example, when you want to use straight quotes as -foot and inch marks: 6'2" tall; a 17" iMac. - -Options -======= - -For Pyblosxom users, the ``smartypants_attributes`` attribute is where you -specify configuration options. - -Numeric values are the easiest way to configure SmartyPants' behavior: - -"0" - Suppress all transformations. (Do nothing.) -"1" - Performs default SmartyPants transformations: quotes (including - \`\`backticks'' -style), em-dashes, and ellipses. "``--``" (dash dash) - is used to signify an em-dash; there is no support for en-dashes. - -"2" - Same as smarty_pants="1", except that it uses the old-school typewriter - shorthand for dashes: "``--``" (dash dash) for en-dashes, "``---``" - (dash dash dash) - for em-dashes. - -"3" - Same as smarty_pants="2", but inverts the shorthand for dashes: - "``--``" (dash dash) for em-dashes, and "``---``" (dash dash dash) for - en-dashes. - -"-1" - 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. - - -The following single-character attribute values can be combined to toggle -individual transformations from within the smarty_pants attribute. For -example, to educate normal quotes and em-dashes, but not ellipses or -\`\`backticks'' -style quotes: - -``py['smartypants_attributes'] = "1"`` - -"q" - Educates normal quote characters: (") and ('). - -"b" - Educates \`\`backticks'' -style double quotes. - -"B" - Educates \`\`backticks'' -style double quotes and \`single' quotes. - -"d" - Educates em-dashes. - -"D" - Educates em-dashes and en-dashes, using old-school typewriter shorthand: - (dash dash) for en-dashes, (dash dash dash) for em-dashes. - -"i" - Educates em-dashes and en-dashes, using inverted old-school typewriter - shorthand: (dash dash) for em-dashes, (dash dash dash) for en-dashes. - -"e" - Educates ellipses. - -"w" - Translates any instance of ``"`` into a normal double-quote character. - 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 translate ``"`` entities into - regular quotes so SmartyPants can educate them, you should pass the - following to the smarty_pants attribute: - -The ``smartypants_forbidden_flavours`` list contains pyblosxom flavours for -which no Smarty Pants rendering will occur. - - -Caveats -======= - -Why You Might Not Want to Use Smart Quotes in Your Weblog ---------------------------------------------------------- - -For one thing, you might not care. - -Most normal, mentally stable individuals do not take notice of proper -typographic punctuation. Many design and typography nerds, however, break -out in a nasty rash when they encounter, say, a restaurant sign that uses -a straight apostrophe to spell "Joe's". - -If you're the sort of person who just doesn't care, you might well want to -continue not caring. Using straight quotes -- and sticking to the 7-bit -ASCII character set in general -- is certainly a simpler way to live. - -Even if you I *do* care about accurate typography, you still might want to -think twice before educating the quote characters in your weblog. One side -effect of publishing curly quote HTML entities is that it makes your -weblog a bit harder for others to quote from using copy-and-paste. What -happens is that when someone copies text from your blog, the copied text -contains the 8-bit curly quote characters (as well as the 8-bit characters -for em-dashes and ellipses, if you use these options). These characters -are not standard across different text encoding methods, which is why they -need to be encoded as HTML entities. - -People copying text from your weblog, however, may not notice that you're -using curly quotes, and they'll go ahead and paste the unencoded 8-bit -characters copied from their browser into an email message or their own -weblog. When pasted as raw "smart quotes", these characters are likely to -get mangled beyond recognition. - -That said, my own opinion is that any decent text editor or email client -makes it easy to stupefy smart quote characters into their 7-bit -equivalents, and I don't consider it my problem if you're using an -indecent text editor or email client. - - -Algorithmic Shortcomings ------------------------- - -One situation in which quotes will get curled the wrong way is when -apostrophes are used at the start of leading contractions. For example: - -``'Twas the night before Christmas.`` - -In the case above, SmartyPants will turn the apostrophe into an opening -single-quote, when in fact it should be a closing one. I don't think -this problem can be solved in the general case -- every word processor -I've tried gets this wrong as well. In such cases, it's best to use the -proper HTML entity for closing single-quotes (``’``) by hand. - - -Bugs -==== - -To file bug reports or feature requests (other than topics listed in the -Caveats section above) please send email to: mailto:smartypantspy@chad.org - -If the bug involves quotes being curled the wrong way, please send example -text to illustrate. - -To Do list ----------- - -- Provide a function for use within templates to quote anything at all. - - -Version History -=============== - -1.5_1.7: Fri, 09 Aug 2013 07:34:16 -0400 - - Add HBS language translation. Patch by by Vera Djuraskovic from - Webhostinggeeks.com - - Add Python3 support. -1.5_1.6: Fri, 27 Jul 2007 07:06:40 -0400 - - Fixed bug where blocks of precious unalterable text was instead - interpreted. Thanks to Le Roux and Dirk van Oosterbosch. - -1.5_1.5: Sat, 13 Aug 2005 15:50:24 -0400 - - Fix bogus magical quotation when there is no hint that the - user wants it, e.g., in "21st century". Thanks to Nathan Hamblen. - - Be smarter about quotes before terminating numbers in an en-dash'ed - range. - -1.5_1.4: Thu, 10 Feb 2005 20:24:36 -0500 - - Fix a date-processing bug, as reported by jacob childress. - - Begin a test-suite for ensuring correct output. - - Removed import of "string", since I didn't really need it. - (This was my first every Python program. Sue me!) - -1.5_1.3: Wed, 15 Sep 2004 18:25:58 -0400 - - Abort processing if the flavour is in forbidden-list. Default of - [ "rss" ] (Idea of Wolfgang SCHNERRING.) - - Remove stray virgules from en-dashes. Patch by Wolfgang SCHNERRING. - -1.5_1.2: Mon, 24 May 2004 08:14:54 -0400 - - Some single quotes weren't replaced properly. Diff-tesuji played - by Benjamin GEIGER. - -1.5_1.1: Sun, 14 Mar 2004 14:38:28 -0500 - - Support upcoming pyblosxom 0.9 plugin verification feature. - -1.5_1.0: Tue, 09 Mar 2004 08:08:35 -0500 - - Initial release - -Version Information -------------------- - -Version numbers will track the SmartyPants_ version numbers, with the addition -of an underscore and the smartypants.py version on the end. - -New versions will be available at `http://wiki.chad.org/SmartyPantsPy`_ - -.. _http://wiki.chad.org/SmartyPantsPy: http://wiki.chad.org/SmartyPantsPy - -Authors -======= - -`John Gruber`_ did all of the hard work of writing this software in Perl for -`Movable Type`_ and almost all of this useful documentation. `Chad Miller`_ -ported it to Python to use with Pyblosxom_. - - -Additional Credits -================== - -Portions of the SmartyPants original work are based on Brad Choate's nifty -MTRegex plug-in. `Brad Choate`_ also contributed a few bits of source code to -this plug-in. Brad Choate is a fine hacker indeed. - -`Jeremy Hedley`_ and `Charles Wiltgen`_ deserve mention for exemplary beta -testing of the original SmartyPants. - -`Rael Dornfest`_ ported SmartyPants to Blosxom. - -.. _Brad Choate: http://bradchoate.com/ -.. _Jeremy Hedley: http://antipixel.com/ -.. _Charles Wiltgen: http://playbacktime.com/ -.. _Rael Dornfest: http://raelity.org/ - - -Copyright and License -===================== - -SmartyPants_ license:: - - Copyright (c) 2003 John Gruber - (http://daringfireball.net/) - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are - met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - - * Neither the name "SmartyPants" nor the names of its contributors - may be used to endorse or promote products derived from this - software without specific prior written permission. - - This software is provided by the copyright holders and contributors "as - is" and any express or implied warranties, including, but not limited - to, the implied warranties of merchantability and fitness for a - particular purpose are disclaimed. In no event shall the copyright - owner or contributors be liable for any direct, indirect, incidental, - special, exemplary, or consequential damages (including, but not - limited to, procurement of substitute goods or services; loss of use, - data, or profits; or business interruption) however caused and on any - theory of liability, whether in contract, strict liability, or tort - (including negligence or otherwise) arising in any way out of the use - of this software, even if advised of the possibility of such damage. - - -smartypants.py license:: - - smartypants.py is a derivative work of SmartyPants. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are - met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - - This software is provided by the copyright holders and contributors "as - is" and any express or implied warranties, including, but not limited - to, the implied warranties of merchantability and fitness for a - particular purpose are disclaimed. In no event shall the copyright - owner or contributors be liable for any direct, indirect, incidental, - special, exemplary, or consequential damages (including, but not - limited to, procurement of substitute goods or services; loss of use, - data, or profits; or business interruption) however caused and on any - theory of liability, whether in contract, strict liability, or tort - (including negligence or otherwise) arising in any way out of the use - of this software, even if advised of the possibility of such damage. -""" - - -_refs = """ -.. _Brad Choate: http://bradchoate.com/ -.. _Jeremy Hedley: http://antipixel.com/ -.. _Charles Wiltgen: http://playbacktime.com/ -.. _Rael Dornfest: http://raelity.org/ -.. _John Gruber: http://daringfireball.net/ -.. _Chad Miller: http://web.chad.org/ -.. _Pyblosxom: http://roughingit.subtlehints.net/pyblosxom -.. _SmartyPants: http://daringfireball.net/projects/smartypants/ -.. _Movable Type: http://www.movabletype.org/ -""" - - -docs["hbs"] = r""" -SmartyPants priključen u Python -------------------------------- - -Priključio `Chad Miller`_ -Copyright (c) 2004, 2007, 2012 Chad Miller - -naziv originala `SmartyPants`_ autor `John Gruber`_ -Copyright (c) 2003 John Gruber - -Izvor -===== - -Pronađeno u Bazaar odeljku na http://web.chad.org/projects/smartypants.py/ . - - -Kratak pregled -============== - -Dodatak sa tipografskim navodnicima za Pyblosxom_. - -Originalni "SmartyPants" je besplatan web dodatak za Movable Type, -Blosxom i BBEdit koji lako prevodi obične ASCII znake interpunkcije u “pametne” tipografske HTML entitete interpunkcije. - -Оvaj softver, *smartypants.py*, nastoji da bude funkcionalan priključak -SmartyPants-a za Python, za korišćenje uz Pyblosxom_. - - -Opis -==== - -SmartyPants može obavljati sledeće transformacije: - -- Ravne navodnike ( " i ' ) u "uvijene" HTML entitete navodnika -- Ulevo nagnute navodnike (\`\`ovako'') u "uvijene" HTML entitete navodnika -- Crtice (``--`` i ``---``) u entitete kratke i duge crtice -- Tri tačke (``...`` ili ``. . .``) u elipsaste entitete - -To znači da možete da pišete, uređujete i čuvate vaše postove pomoću -običnih starih ASCII ravnih navodnika, običnih crtica i običnih tačaka, ali -vaš objavljeni post (i krajnji HTML rezultat) pojaviće se sa pametnim navodnicima, -dugim crticama i odgovarajućim elipsama. - -SmartyPants ne modifikuje karaktere u okviru ``<pre>``, ``<code>``, ``<kbd>``, -``<math>`` ili ``<script>`` blokova oznaka. Tipično, ove oznake se upotrebljavaju da -prikažu tekst tamo gde pametni navodnici i druga “pametna interpunkcija” ne bi bila -odgovarajuća, kao što je izvorni kod ili označavanje primera. - - -Kose crte u izlaznoj sekvenci -============================= - -Ako morate da koristite dosledne ravne navodnike (ili obične povlake i tačke), -SmartyPants prihvata sledeće izlazne sekvence sa ulevo nagnutim kosim crtama kako bi -izazvao pojavu ne-pametne interpunkcije. To čini tako što transformiše izlaznu -sekvencu u decimalno kodirani HTML entitet: - -(FIXME: tabela ovde) - - - - - - -Sasvim je glupo što postoji prekinuta veza između vizuelnog izgleda i oznake tabele onda kada -su angažovani specijalni karakteri. - - -komentar Izlaz Vrednost Karakter - - -Оvo je korisno, na primer, kada želite da upotrebite ravne navodnike kao -oznake za dužinu stopa i inča: 6'2" tall; a 17" iMac. - -Оpcije -====== - -Za korisnike Pyblosxoma, ``smartypants_attributes`` atribut je tamo gde -određujete opcije konfiguracije. - -Brojčane vrednosti su najlakši način za konfiguraciju ponašanja SmartyPants-a. - -"0" -Potiskuje sve transformacije (ne radi ništa). -"1" -Izvodi podrazumevane SmartyPants transformacije: navodnike (uključujući i \`\`kose crte''), duge crtice i elipse. "``--``" (crtica crtica) se koristi da označi -dugu crticu; ne postoji podrška za kratku crticu. - - -"2" -Isto kao za smarty_pants="1", osim što koristi staro stenografsko -kucanje za crtice: "``--``" (crtica crtica) za kratku crticu, "``---``" (crtica -crtica crtica) za dugu crticu. - -"3" -Isto kao za smarty_pants="2", osim što invertuje stenografiju za -crtice: "``--``" (crtica crtica) za kratku crticu, i "``---``" (crtica -crtica crtica) za dugu crticu. - -"-1" -Režim pretvaranja. Obrće SmartyPants proces transformacije, pretvarajući -HTML entitete koje proizvede SmartyPants u njihove ASCII ekvivalente. -Npr. "“" se pretvara u obične duple navodnike (“), "—" se -pretvara u dve crtice itd. - - -Sledeće vrednosti atributa pojedinačnih karaktera mogu se kombinovati kako bi -se aktivirale individualne transformacije iz okvira smarty_pants atributa. Na primer, -za obrazovanje normalnih navodnika i dugih crtica, ali ne elipsa ili \`\`nagnutih'' -navodnika: - -``py['smartypants_attributes'] = "1"`` - -"q" -Obrazuje normalne znakove navoda: (") i ('). - -"b" -Obrazuje duple \`\`nagnute'' znakove navoda. - -"B" -Obrazuje duple \`\`nagnute'' znakove navoda i \`pojedinačne' navodnike. - -"d" -Obrazuje dugu crticu. - -"D" -Obrazuje dugu crticu i kratku crticu pomoću starog stenografskog -kucanja: (crtica crtica) za kratku crticu, (crtica crtica crtica) za dugu crticu - -"i" -Obrazuje dugu crticu i kratku crticu pomoću invertovanog starog stenografskog -kucanja: (crtica crtica) za dugu crticu, (crtica crtica crtica) za kratku crticu - -"e" -Obrazuje elipse. - -"w" -Prevodi svaku instancu ``"`` u normalne karaktere duplih navodnika. -To ne bi trebalo da ima značaja za većinu ljudi, ali je od posebnog značaja -za svakoga ko piše postove pomoću Dreamweavera, jer Dreamweaver -neobjašnjivo koristi taj entitet da bi predstavio dosledni karakter duplih navodnika. -SmartyPants obrazuje samo normalne navodnike, ne entitete (jer se obično -entiteti koriste za eksplicitnu svrhu predstavljanja određenih karaktera koje -označavaju). Opcija “w” se mora upotrebiti zajedno sa jednom (ili obe) drugom -opcijom navodnika ("q" ili "b"). Na taj način, ako želite da primenite sve SmartyPants -transformacije (navodnike, kratke i duge crtice i elipse) i da prevedete ``"`` -entitete u regularne navodnike tako da SmartyPants može da ih obrazuje, treba -da prenesete sledeće u smarty_pants atribut: - -Lista ``smartypants_forbidden_flavours`` sadrži pyblosxom zabranjene flavore za koje neće doći do SmartyPants rasterizacije. - - -Upozorenja -========== - -Zašto možda ne bi trebalo da koristite pametne navodnike u vašem web blogu --------------------------------------------------------------------------- - -Kao prvo, možda vas neće interesovati. - -Uobičajeno, mentalno stabilne osobe ne obraćaju pažnju na tipografsku interpunkciju -koju koriste. Mnogi programeri i tipografski stručnjaci planu i neugodno reaguju kada se -susretnu sa, recimo, restoranskim natpisom koji koristi ravan apostrof za pisanje "Joe's". - -Ako ste vi osoba koju jednostavno nije briga, možete tako i da nastavite. Korišćenje ravnih navodnika -- i čuvanje 7-bitnog ASCII generalnog podešavanja karaktera -- svakako je -jednostavniji način funkcionisanja. -Čak iako mi *jeste* stalo do tačne tipografije, ipak možda treba dvaput da razmislite pre -obrazovanja karaktera navodnika na vašem blogu. Jedan sporedan efekat objavljivanja HTML entiteta uvijenih navodnika jeste taj što to čini vaš web blog unekoliko težim za ostale da ga citiraju koristeći opciju preslikavanja (copy-paste). Dešava se da, kada neko prekopira tekst sa vašeg bloga, kopirani tekst sadrži 8-bitne uvijene znakove navoda (kao i 8-bitne karaktere za dugu crticu i elipsu, ako koristite te opcije). Ovi karakteri nisu standardni u svim metodama kodiranja teksta, zbog čega se moraju kodirati kao HTML entiteti. - -Oni koji kopiraju tekst sa vašeg bloga možda ipak neće primetiti da koristite uvijene navodnike i pokušaće da preslikaju 8-bitne karaktere iskopirane iz pretraživača u mejl poruku ili u njihov sopstveni blog. Kada se preslikaju kao sirovi “pametni navodnici”, ovi karakteri će se verovatno raskomadati do neprepoznavanja. - -Znajući sve to, moje mišljenje je da svaki pristojan uređivač teksta ili program za mejl olakšava pretvaranje pametnih navodnika u 7-bitne ekvivalente i smatram da nije moj problem ako koristite loš uređivač teksta ili loš program za mejl. - - -Algoritamski nedostaci ----------------------- - -Jedna od situacija u kojima će navodnici postati uvijeni na pogrešan način jeste -kada se apostrofi koriste na početku vodećih skraćivanja. Na primer: - -``'Twas the night before Christmas.`` (T’s’ desilo noć pred Božić) - -U navedenom primeru SmartyPants će pretvoriti apostrof u otvarajući pojedinačni -znak navoda, a u stvari bi trebalo da bude zatvarajući. Mislim da se ovaj problem ne -može rešiti u opštem smislu -- svaki word procesor koji sam isprobao to radi pogrešno. -U takvim slučajevima najbolje je upotrebiti ispravan HTML entitet za zatvaranje pojedinačnih navoda (``’``) ručno. - - -Greške -====== - -Da biste prijavili greške ili zahteve za svojstva (osim tema izlistanih u navedenom odeljku o upozorenjima), pošaljite mejl na smartypantspy@chad.org - -Ako greška podrazumeva pogrešno uvijanje navodnika, molim vas pošaljite primer koji to ilustruje. - -Radna lista ------------ - -- Obezbediti funkciju za korišćenje u okviru šablona za bilo kakvo citiranje. - -Informacije o verziji ---------------------- - -Brojevi verzije će pratiti SmartyPants_ brojeve verzije uz dodatak podvlačenja i smartypants.py verzije na kraju. - -Nove verzije će biti dostupne na `http://wiki.chad.org/SmartyPantsPy`_ - -.. _http://wiki.chad.org/SmartyPantsPy: http://wiki.chad.org/SmartyPantsPy - -Аutori -====== - -`John Gruber`_ je odradio najteži posao u pisanju ovog softvera u Perlu za -`Movable Type`_ i skoro sve od ove korisne dokumentacije. `Chad Miller`_ -ju je priključio u Python za korišćenje uz Pyblosxom_. - - -Dodatne zasluge -================== - -Delovi SmartyPants originalnog rada bazirani su na veštom MTRegex dodatku Brada Choatea `Brad Choate`_ takođe je doprineo sa nekim delovima izvornog koda za ovaj dodatak. Brad Choate je zaista odličan haker. - -`Jeremy Hedley`_ i `Charles Wiltgen`_ zaslužuju da budu pomenuti zbog primernog beta testiranja originalnog SmartyPants-a. - -`Rael Dornfest`_ priključio je SmartyPants u Blosxom -""" - -for _k in docs: - docs[_k] += _refs -__docs__ = docs["en"] - +# Copyright (c) 2013 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 + +__author__ = 'Yu-Jie Lin' +__email__ = 'livibetter@gmail.com' +__version__ = '1.7.0dev' +__license__ = 'BSD License' +__url__ = 'https://bitbucket.org/livibetter/smartypants.py' +__description__ = 'Smart-quotes, smart-ellipses, and smart-dashes' default_smartypants_attr = "1" import re +import warnings -tags_to_skip_regex = re.compile(r"<(/)?(pre|code|kbd|script|math)[^>]*>", re.I) +tags_to_skip_regex = re.compile('<(/)?(pre|code|kbd|script|math)[^>]*>', re.I) def verify_installation(request): - return 1 - # assert the plugin is functional + + 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): - global default_smartypants_attr - try: - forbidden_flavours = args["entry"]["smartypants_forbidden_flavours"] - except KeyError: - forbidden_flavours = [ "rss" ] + msg = 'Pyblosxom support will be removed at Version 2.0.0' + warnings.filterwarnings('once', msg, DeprecationWarning) + warnings.warn(msg, DeprecationWarning) - try: - attributes = args["entry"]["smartypants_attributes"] - except KeyError: - attributes = default_smartypants_attr + global default_smartypants_attr - if attributes is None: - attributes = default_smartypants_attr + try: + forbidden_flavours = args["entry"]["smartypants_forbidden_flavours"] + except KeyError: + forbidden_flavours = ["rss"] - entryData = args["entry"].getData() + try: + attributes = args["entry"]["smartypants_attributes"] + except KeyError: + attributes = default_smartypants_attr - 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 + if attributes is None: + attributes = default_smartypants_attr - # FIXME: make these configurable, perhaps? - args["entry"]["body"] = smartyPants(entryData, attributes) - args["entry"]["title"] = smartyPants(args["entry"]["title"], attributes) + 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) ### interal functions below here def smartyPants(text, attr=default_smartypants_attr): - convert_quot = False # should we translate " entities into normal quotes? - - # Parse attributes: - # 0 : do nothing - # 1 : set all - # 2 : set all, using old school en- and em- dash shortcuts - # 3 : set all, using inverted old school en and em- dash shortcuts - # - # q : quotes - # b : backtick quotes (``double'' only) - # B : backtick quotes (``double'' and `single') - # d : dashes - # D : old school dashes - # i : inverted old school dashes - # e : ellipses - # w : convert " entities to " for Dreamweaver users - - skipped_tag_stack = [] - do_dashes = "0" - do_backticks = "0" - do_quotes = "0" - do_ellipses = "0" - do_stupefy = "0" - - if attr == "0": - # Do nothing. - return text - elif attr == "1": - do_quotes = "1" - do_backticks = "1" - do_dashes = "1" - do_ellipses = "1" - elif attr == "2": - # Do everything, turn all options on, use old school dash shorthand. - do_quotes = "1" - do_backticks = "1" - do_dashes = "2" - do_ellipses = "1" - elif attr == "3": - # Do everything, turn all options on, use inverted old school dash shorthand. - do_quotes = "1" - do_backticks = "1" - do_dashes = "3" - do_ellipses = "1" - elif attr == "-1": - # Special "stupefy" mode. - do_stupefy = "1" - else: - for c in attr: - if c == "q": do_quotes = "1" - elif c == "b": do_backticks = "1" - elif c == "B": do_backticks = "2" - elif c == "d": do_dashes = "1" - elif c == "D": do_dashes = "2" - elif c == "i": do_dashes = "3" - elif c == "e": do_ellipses = "1" - elif c == "w": convert_quot = "1" - else: - pass - # ignore unknown option - - 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. - - 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 is not None: - 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: - if skip_match.group(2).lower() == skipped_tag_stack[-1]: - 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] - last_char = t[-1:] # Remember last char of this token before processing. - if not in_pre: - oldstr = t - t = processEscapes(t) - - if convert_quot != "0": - t = re.sub('"', '"', t) - - if do_dashes != "0": - if do_dashes == "1": - t = educateDashes(t) - if do_dashes == "2": - t = educateDashesOldSchool(t) - if do_dashes == "3": - t = educateDashesOldSchoolInverted(t) - - if do_ellipses != "0": - t = educateEllipses(t) - - # Note: backticks need to be processed before quotes. - if do_backticks != "0": - t = educateBackticks(t) - - if do_backticks == "2": - t = educateSingleBackticks(t) - - if do_quotes != "0": - 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 = educateQuotes(t) - - if do_stupefy == "1": - t = stupefyEntities(t) - - prev_token_last_char = last_char - result.append(t) - - return "".join(result) - - -def educateQuotes(str): - """ - Parameter: String. - - Returns: The string, with "educated" curly quote HTML entities. - - Example input: "Isn't this fun?" - Example output: “Isn’t this fun?” - """ - - oldstr = str - 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: - str = re.sub(r"""^'(?=%s\\B)""" % (punct_class,), r"""’""", str) - str = re.sub(r"""^"(?=%s\\B)""" % (punct_class,), r"""”""", str) - - # Special case for double sets of quotes, e.g.: - # <p>He said, "'Quoted' words in a larger quote."</p> - str = re.sub(r""""'(?=\w)""", """“‘""", str) - str = re.sub(r"""'"(?=\w)""", """‘“""", str) - - # Special case for decade abbreviations (the '80s): - str = re.sub(r"""\b'(?=\d{2}s)""", r"""’""", str) - - close_class = r"""[^\ \t\r\n\[\{\(\-]""" - dec_dashes = r"""–|—""" - - # 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) - str = opening_single_quotes_regex.sub(r"""\1‘""", str) - - closing_single_quotes_regex = re.compile(r""" - (%s) - ' - (?!\s | s\b | \d) - """ % (close_class,), re.VERBOSE) - str = closing_single_quotes_regex.sub(r"""\1’""", str) - - closing_single_quotes_regex = re.compile(r""" - (%s) - ' - (\s | s\b) - """ % (close_class,), re.VERBOSE) - str = closing_single_quotes_regex.sub(r"""\1’\2""", str) - - # Any remaining single quotes should be opening ones: - str = re.sub(r"""'""", r"""‘""", str) - - # 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) - str = opening_double_quotes_regex.sub(r"""\1“""", str) - - # Double closing quotes: - closing_double_quotes_regex = re.compile(r""" - #(%s)? # character that indicates the quote should be closing - " - (?=\s) - """ % (close_class,), re.VERBOSE) - str = closing_double_quotes_regex.sub(r"""”""", str) - - closing_double_quotes_regex = re.compile(r""" - (%s) # character that indicates the quote should be closing - " - """ % (close_class,), re.VERBOSE) - str = closing_double_quotes_regex.sub(r"""\1”""", str) - - # Any remaining quotes should be opening ones. - str = re.sub(r'"', r"""“""", str) - - return str - - -def educateBackticks(str): - """ - Parameter: String. - Returns: The string, with ``backticks'' -style double quotes - translated into HTML curly quote entities. - Example input: ``Isn't this fun?'' - Example output: “Isn't this fun?” - """ - - str = re.sub(r"""``""", r"""“""", str) - str = re.sub(r"""''""", r"""”""", str) - return str - - -def educateSingleBackticks(str): - """ - Parameter: String. - Returns: The string, with `backticks' -style single quotes - translated into HTML curly quote entities. - - Example input: `Isn't this fun?' - Example output: ‘Isn’t this fun?’ - """ - - str = re.sub(r"""`""", r"""‘""", str) - str = re.sub(r"""'""", r"""’""", str) - return str - - -def educateDashes(str): - """ - Parameter: String. - - Returns: The string, with each instance of "--" translated to - an em-dash HTML entity. - """ - - str = re.sub(r"""---""", r"""–""", str) # en (yes, backwards) - str = re.sub(r"""--""", r"""—""", str) # em (yes, backwards) - return str - - -def educateDashesOldSchool(str): - """ - Parameter: String. - - Returns: The string, with each instance of "--" translated to - an en-dash HTML entity, and each "---" translated to - an em-dash HTML entity. - """ - - str = re.sub(r"""---""", r"""—""", str) # em (yes, backwards) - str = re.sub(r"""--""", r"""–""", str) # en (yes, backwards) - return str - - -def educateDashesOldSchoolInverted(str): - """ - Parameter: String. - - Returns: The string, with each instance of "--" translated to - an em-dash HTML entity, and each "---" translated to - an en-dash HTML entity. Two reasons why: First, unlike the - en- and em-dash syntax supported by - EducateDashesOldSchool(), 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.) - """ - str = re.sub(r"""---""", r"""–""", str) # em - str = re.sub(r"""--""", r"""—""", str) # en - return str - - - -def educateEllipses(str): - """ - Parameter: String. - Returns: The string, with each instance of "..." translated to - an ellipsis HTML entity. - - Example input: Huh...? - Example output: Huh…? - """ - - str = re.sub(r"""\.\.\.""", r"""…""", str) - str = re.sub(r"""\. \. \.""", r"""…""", str) - return str - - -def stupefyEntities(str): - """ - Parameter: String. - Returns: The string, with each SmartyPants HTML entity translated to - its ASCII counterpart. - - Example input: “Hello — world.” - Example output: "Hello -- world." - """ - - str = re.sub(r"""–""", r"""-""", str) # en-dash - str = re.sub(r"""—""", r"""--""", str) # em-dash - - str = re.sub(r"""‘""", r"""'""", str) # open single quote - str = re.sub(r"""’""", r"""'""", str) # close single quote - - str = re.sub(r"""“""", r'''"''', str) # open double quote - str = re.sub(r"""”""", r'''"''', str) # close double quote - - str = re.sub(r"""…""", r"""...""", str)# ellipsis - - return str - - -def processEscapes(str): - r""" - Parameter: String. - Returns: The string, with after processing the following backslash - escape sequences. This is useful if you want to force a "dumb" - quote or other character to appear. - - Escape Value - ------ ----- - \\ \ - \" " - \' ' - \. . - \- - - \` ` - """ - str = re.sub(r"""\\\\""", r"""\""", str) - str = re.sub(r'''\\"''', r""""""", str) - str = re.sub(r"""\\'""", r"""'""", str) - str = re.sub(r"""\\\.""", r""".""", str) - str = re.sub(r"""\\-""", r"""-""", str) - str = re.sub(r"""\\`""", r"""`""", str) - - return str - - -def _tokenize(str): - """ - Parameter: String containing HTML markup. - Returns: 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> - """ - - pos = 0 - length = len(str) - tokens = [] - - depth = 6 - nested_tags = "|".join(['(?:<(?:[^<>]',] * depth) + (')*>)' * depth) - #match = r"""(?: <! ( -- .*? -- \s* )+ > ) | # comments - # (?: <\? .*? \?> ) | # directives - # %s # nested tags """ % (nested_tags,) - tag_soup = re.compile(r"""([^<]*)(<[^>]*>)""") + # should we translate " entities into normal quotes? + convert_quot = 0 + + # Parse attributes: + # 0 : do nothing + # 1 : set all + # 2 : set all, using old school en- and em- dash shortcuts + # 3 : set all, using inverted old school en and em- dash shortcuts + # + # q : quotes + # b : backtick quotes (``double'' only) + # B : backtick quotes (``double'' and `single') + # d : dashes + # D : old school dashes + # i : inverted old school dashes + # e : ellipses + # w : convert " entities to " for Dreamweaver users + + skipped_tag_stack = [] + do_dashes = 0 + do_backticks = 0 + do_quotes = 0 + do_ellipses = 0 + do_stupefy = 0 + + if attr == "0": + # Do nothing. + return text + elif attr == "1": + do_quotes = 1 + do_backticks = 1 + do_dashes = 1 + do_ellipses = 1 + elif attr == "2": + # Do everything, turn all options on, use old school dash shorthand. + do_quotes = 1 + do_backticks = 1 + do_dashes = 2 + do_ellipses = 1 + elif attr == "3": + # Do everything, turn all options on, use inverted old school dash + # shorthand. + do_quotes = 1 + do_backticks = 1 + do_dashes = 3 + do_ellipses = 1 + elif attr == "-1": + # Special "stupefy" mode. + do_stupefy = 1 + else: + for c in attr: + if c == "q": + do_quotes = 1 + elif c == "b": + do_backticks = 1 + elif c == "B": + do_backticks = 2 + elif c == "d": + do_dashes = 1 + elif c == "D": + do_dashes = 2 + elif c == "i": + do_dashes = 3 + elif c == "e": + do_ellipses = 1 + elif c == "w": + convert_quot = 1 + else: + pass + # ignore unknown option + + 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. + + 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 = processEscapes(t) + + if convert_quot: + t = re.sub('"', '"', t) + + if do_dashes: + if do_dashes == 1: + t = educateDashes(t) + if do_dashes == 2: + t = educateDashesOldSchool(t) + if do_dashes == 3: + t = educateDashesOldSchoolInverted(t) + + if do_ellipses: + t = educateEllipses(t) + + # Note: backticks need to be processed before quotes. + if do_backticks: + t = educateBackticks(t) + + if do_backticks == 2: + t = educateSingleBackticks(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 = educateQuotes(t) + + if do_stupefy == 1: + t = stupefyEntities(t) + + prev_token_last_char = last_char + result.append(t) + + return "".join(result) + + +def educateQuotes(text): + """ + Parameter: String. + + Returns: The string, with "educated" curly quote HTML entities. + + >>> print(educateQuotes('"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): + """ + Parameter: String. + Returns: The string, with ``backticks'' -style double quotes + translated into HTML curly quote entities. + + >>> print(educateBackticks("``Isn't this fun?''")) + “Isn't this fun?” + """ + + text = re.sub('``', '“', text) + text = re.sub("''", '”', text) + return text + + +def educateSingleBackticks(text): + """ + Parameter: String. + Returns: The string, with `backticks' -style single quotes + translated into HTML curly quote entities. + + >>> print(educateSingleBackticks("`Isn't this fun?'")) + ‘Isn’t this fun?’ + """ + + text = re.sub('`', '‘', text) + text = re.sub("'", '’', text) + return text + + +def educateDashes(text): + """ + Parameter: String. + + Returns: The string, with each instance of "--" translated to + an em-dash HTML entity. + """ + + text = re.sub('---', '–', text) # en (yes, backwards) + text = re.sub('--', '—', text) # em (yes, backwards) + return text + + +def educateDashesOldSchool(text): + """ + Parameter: String. + + Returns: The string, with each instance of "--" translated to + an en-dash HTML entity, and each "---" translated to + an em-dash HTML entity. + """ + + text = re.sub('---', '—', text) # em (yes, backwards) + text = re.sub('--', '–', text) # en (yes, backwards) + return text + + +def educateDashesOldSchoolInverted(text): + """ + Parameter: String. + + Returns: The string, with each instance of "--" translated to + an em-dash HTML entity, and each "---" translated to + an en-dash HTML entity. Two reasons why: First, unlike the + en- and em-dash syntax supported by + EducateDashesOldSchool(), 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.) + """ + + text = re.sub('---', '–', text) # em + text = re.sub('--', '—', text) # en + return text + + +def educateEllipses(text): + """ + Parameter: String. + Returns: The string, with each instance of "..." translated to + an ellipsis HTML entity. - token_match = tag_soup.search(str) + >>> print(educateEllipses('Huh...?')) + Huh…? + """ - previous_end = 0 - while token_match is not None: - if token_match.group(1): - tokens.append(['text', token_match.group(1)]) + text = re.sub(r"""\.\.\.""", '…', text) + text = re.sub(r"""\. \. \.""", '…', text) + return text - tokens.append(['tag', token_match.group(2)]) - previous_end = token_match.end() - token_match = tag_soup.search(str, token_match.end()) +def stupefyEntities(text): + """ + Parameter: String. + Returns: The string, with each SmartyPants HTML entity translated to + its ASCII counterpart. - if previous_end < len(str): - tokens.append(['text', str[previous_end:]]) + >>> print(stupefyEntities('“Hello — world.”')) + "Hello -- world." + """ - return tokens + 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 -if __name__ == "__main__": + text = re.sub('…', '...', text) # ellipsis - import sys - import locale + return text - try: - locale.setlocale(locale.LC_ALL, '') - except: - pass - from docutils.core import publish_string - try: - lang = sys.argv.pop(1) - except IndexError: - lang = "en" - docstring_html = publish_string(docs[lang], writer_name='html', settings_overrides={'output_encoding': 'utf-8'}) +def processEscapes(text): + r""" + Parameter: String. + Returns: The string, with after processing the following backslash + escape sequences. This is useful if you want to force a "dumb" + quote or other character to appear. - assert type(docstring_html) == bytes, type(docstring_html) - print(docstring_html.decode("utf-8")) + Escape Value + ------ ----- + \\ \ + \" " + \' ' + \. . + \- - + \` ` + """ + 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) - # Unit test output goes out stderr. No worries. - import unittest - sp = smartyPants + return text - class TestSmartypantsAllAttributes(unittest.TestCase): - # the default attribute is "1", which means "all". - def test_dates(self): - self.assertEqual(sp("1440-80's"), "1440-80’s") - self.assertEqual(sp("1440-'80s"), "1440-‘80s") - self.assertEqual(sp("1440---'80s"), "1440–‘80s") - self.assertEqual(sp("1960s"), "1960s") # no effect. - self.assertEqual(sp("1960's"), "1960’s") - self.assertEqual(sp("one two '60s"), "one two ‘60s") - self.assertEqual(sp("'60s"), "‘60s") +def _tokenize(text): + """ + Parameter: String containing HTML markup. + Returns: 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. - def test_skip_tags(self): - self.assertEqual( - sp("""<script type="text/javascript">\n<!--\nvar href = "http://www.google.com";\nvar linktext = "google";\ndocument.write('<a href="' + href + '">' + linktext + "</a>");\n//-->\n</script>"""), - """<script type="text/javascript">\n<!--\nvar href = "http://www.google.com";\nvar linktext = "google";\ndocument.write('<a href="' + href + '">' + linktext + "</a>");\n//-->\n</script>""") - self.assertEqual( - sp("""<p>He said "Let's write some code." This code here <code>if True:\n\tprint "Okay"</code> is python code.</p>"""), - """<p>He said “Let’s write some code.” This code here <code>if True:\n\tprint "Okay"</code> is python code.</p>""") + Based on the _tokenize() subroutine from Brad Choate's MTRegex plugin. + <http://www.bradchoate.com/past/mtregex.php> + """ + tokens = [] - def test_ordinal_numbers(self): - self.assertEqual(sp("21st century"), "21st century") # no effect. - self.assertEqual(sp("3rd"), "3rd") # no effect. + tag_soup = re.compile('([^<]*)(<[^>]*>)') - def test_educated_quotes(self): - self.assertEqual(sp('''"Isn't this fun?"'''), '''“Isn’t this fun?”''') + token_match = tag_soup.search(text) - unittest.main() + previous_end = 0 + while token_match: + if token_match.group(1): + tokens.append(['text', token_match.group(1)]) + tokens.append(['tag', token_match.group(2)]) + 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:]]) -__author__ = "Chad Miller <smartypantspy@chad.org>" -__version__ = "1.5_1.7: Fri, 09 Aug 2013 07:34:16 -0400" -__url__ = "http://wiki.chad.org/SmartyPantsPy" -__description__ = "Smart-quotes, smart-ellipses, and smart-dashes for weblog entries in pyblosxom" + return tokens diff --git a/tests/test.py b/tests/test.py new file mode 100644 index 0000000..0f36e0d --- /dev/null +++ b/tests/test.py @@ -0,0 +1,78 @@ +import doctest +import unittest + +import smartypants +from smartypants import smartyPants as sp + + +class TestSmartypantsAllAttributes(unittest.TestCase): + # the default attribute is "1", which means "all". + + def test_dates(self): + + self.assertEqual(sp("1440-80's"), "1440-80’s") + self.assertEqual(sp("1440-'80s"), "1440-‘80s") + self.assertEqual(sp("1440---'80s"), "1440–‘80s") + self.assertEqual(sp("1960s"), "1960s") # no effect. + self.assertEqual(sp("1960's"), "1960’s") + self.assertEqual(sp("one two '60s"), "one two ‘60s") + self.assertEqual(sp("'60s"), "‘60s") + + def test_skip_tags(self): + + T = sp('''<script type="text/javascript"> +<!-- +var href = "http://www.google.com"; +var linktext = "google"; +document.write('<a href="' + href + '">' + linktext + "</a>"); +//--> +</script>''') + E = '''<script type="text/javascript"> +<!-- +var href = "http://www.google.com"; +var linktext = "google"; +document.write('<a href="' + href + '">' + linktext + "</a>"); +//--> +</script>''' + self.assertEqual(T, E) + + def test_convert_quot(self): + + TEXT = ( + "<p>He said "Let's write some code." " + "This code here <code>if True:\n\tprint "Okay"</code> " + "is python code.</p>") + + T = sp(TEXT) + E = ("<p>He said "Let’s write some code." " + "This code here <code>if True:\n\tprint "Okay"</code> " + "is python code.</p>") + self.assertEqual(T, E) + + T = sp(TEXT, 'w') + E = ('<p>He said "Let\'s write some code." ' + "This code here <code>if True:\n\tprint "Okay"</code> " + "is python code.</p>") + self.assertEqual(T, E) + + T = sp(TEXT, 'qw') + E = ("<p>He said “Let’s write some code.” " + "This code here <code>if True:\n\tprint "Okay"</code> " + "is python code.</p>") + self.assertEqual(T, E) + + def test_ordinal_numbers(self): + + self.assertEqual(sp("21st century"), "21st century") # no effect. + self.assertEqual(sp("3rd"), "3rd") # no effect. + + def test_educated_quotes(self): + + self.assertEqual(sp('"Isn\'t this fun?"'), + '“Isn’t this fun?”') + + +def load_tests(loader, tests, pattern): + + tests.addTests(doctest.DocTestSuite(smartypants)) + return tests diff --git a/tests/test_cli.py b/tests/test_cli.py new file mode 100644 index 0000000..0cf29dc --- /dev/null +++ b/tests/test_cli.py @@ -0,0 +1,64 @@ +# Copyright (c) 2013 Yu-Jie Lin +# Licensed under the BSD License, for detailed license information, see COPYING + +from __future__ import unicode_literals +import os +from subprocess import Popen, PIPE +import tempfile +import unittest + + +CLI_SCRIPT = './smartypants' + + +class TestCLI(unittest.TestCase): + + @staticmethod + def _p(args, T=None): + + if T: + T = T.encode() + + stdin = PIPE if T else None + p = Popen(args, stdin=stdin, stdout=PIPE) + output = p.communicate(input=T)[0] + + if isinstance(output, bytes): + output = output.decode() # Python 3 + + return output + + def test_pipe(self): + + T = '"foobar"' + E = '“foobar”' + + output = self._p([CLI_SCRIPT], T) + self.assertEquals(output, E) + + def test_pipe_attr(self): + + T = """"foo" ``bar''""" + + E = T + output = self._p([CLI_SCRIPT, '--attr', '0'], T) + self.assertEquals(output, E) + + E = """"foo" “bar”""" + output = self._p([CLI_SCRIPT, '--attr', 'b'], T) + self.assertEquals(output, E) + + def test_file(self): + + T = '"foobar"' + E = '“foobar”' + + F = tempfile.mkstemp()[1] + try: + with open(F, 'w') as f: + f.write(T) + + output = self._p([CLI_SCRIPT, F]) + finally: + os.remove(F) + self.assertEquals(output, E) |