forked from pool/python-pypandoc
- Update to 1.13:
* Change when we do source file verification - Drop tests.py file, it is shipped in the source tarball. - Switch to pyproject macros. OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-pypandoc?expand=0&rev=15
This commit is contained in:
Git OBS Bridge
@@ -1,3 +0,0 @@
|
|||||||
version https://git-lfs.github.com/spec/v1
|
|
||||||
oid sha256:fab24b0c4e437a3982820171ad7a3b0125cd05a02ec4578bef243bf239c6d633
|
|
||||||
size 69118
|
|
||||||
3
pypandoc-1.13.tar.gz
Normal file
3
pypandoc-1.13.tar.gz
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:05fc905d23ae3220a301a3226d7366b64f1e226b1706dbaa9aa4009d3c5abe03
|
||||||
|
size 70605
|
||||||
@@ -1,3 +1,11 @@
|
|||||||
|
-------------------------------------------------------------------
|
||||||
|
Thu Mar 14 23:54:12 UTC 2024 - Steve Kowalik <steven.kowalik@suse.com>
|
||||||
|
|
||||||
|
- Update to 1.13:
|
||||||
|
* Change when we do source file verification
|
||||||
|
- Drop tests.py file, it is shipped in the source tarball.
|
||||||
|
- Switch to pyproject macros.
|
||||||
|
|
||||||
-------------------------------------------------------------------
|
-------------------------------------------------------------------
|
||||||
Wed May 24 17:47:42 UTC 2023 - Scott Bradnick <scott.bradnick@suse.com>
|
Wed May 24 17:47:42 UTC 2023 - Scott Bradnick <scott.bradnick@suse.com>
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
#
|
#
|
||||||
# spec file for package python-pypandoc
|
# spec file for package python-pypandoc
|
||||||
#
|
#
|
||||||
# Copyright (c) 2023 SUSE LLC
|
# Copyright (c) 2024 SUSE LLC
|
||||||
#
|
#
|
||||||
# All modifications and additions to the file contributed by third parties
|
# All modifications and additions to the file contributed by third parties
|
||||||
# remain the property of their copyright owners, unless otherwise agreed
|
# remain the property of their copyright owners, unless otherwise agreed
|
||||||
@@ -18,27 +18,24 @@
|
|||||||
|
|
||||||
%define base_name pypandoc
|
%define base_name pypandoc
|
||||||
Name: python-pypandoc
|
Name: python-pypandoc
|
||||||
Version: 1.11
|
Version: 1.13
|
||||||
Release: 0
|
Release: 0
|
||||||
Summary: Thin wrapper for pandoc
|
Summary: Thin wrapper for pandoc
|
||||||
License: MIT
|
License: MIT
|
||||||
Group: Development/Languages/Python
|
|
||||||
URL: https://github.com/bebraw/pypandoc
|
URL: https://github.com/bebraw/pypandoc
|
||||||
Source: https://github.com/NicklasTegner/pypandoc/archive/refs/tags/v%{version}.tar.gz#/pypandoc-%{version}.tar.gz
|
Source: https://github.com/NicklasTegner/pypandoc/archive/refs/tags/v%{version}.tar.gz#/pypandoc-%{version}.tar.gz
|
||||||
Source1: https://raw.githubusercontent.com/NicklasTegner/pypandoc/master/tests.py
|
|
||||||
BuildRequires: %{python_module pandocfilters}
|
BuildRequires: %{python_module pandocfilters}
|
||||||
BuildRequires: %{python_module pip}
|
BuildRequires: %{python_module pip}
|
||||||
|
BuildRequires: %{python_module poetry}
|
||||||
BuildRequires: %{python_module pytest}
|
BuildRequires: %{python_module pytest}
|
||||||
BuildRequires: %{python_module setuptools}
|
|
||||||
BuildRequires: %{python_module wheel}
|
BuildRequires: %{python_module wheel}
|
||||||
BuildRequires: fdupes
|
BuildRequires: fdupes
|
||||||
BuildRequires: pandoc
|
BuildRequires: pandoc
|
||||||
BuildRequires: python-rpm-macros
|
BuildRequires: python-rpm-macros
|
||||||
BuildRequires: texlive-latex-bin
|
BuildRequires: texlive-latex-bin
|
||||||
BuildRequires: texlive-xcolor
|
BuildRequires: texlive-xcolor
|
||||||
|
BuildRequires: tex(bookmark.sty)
|
||||||
Requires: pandoc
|
Requires: pandoc
|
||||||
Requires: python-pip
|
|
||||||
Requires: python-wheel
|
|
||||||
Suggests: ghc-citeproc
|
Suggests: ghc-citeproc
|
||||||
ExcludeArch: %{ix86}
|
ExcludeArch: %{ix86}
|
||||||
BuildArch: noarch
|
BuildArch: noarch
|
||||||
@@ -50,13 +47,11 @@ pypandoc provides a thin wrapper for pandoc, a universal document converter.
|
|||||||
%prep
|
%prep
|
||||||
%setup -q -n pypandoc-%{version}
|
%setup -q -n pypandoc-%{version}
|
||||||
|
|
||||||
cp %{SOURCE1} tests.py
|
|
||||||
|
|
||||||
%build
|
%build
|
||||||
%python_build
|
%pyproject_wheel
|
||||||
|
|
||||||
%install
|
%install
|
||||||
%python_install
|
%pyproject_install
|
||||||
%python_expand %fdupes %{buildroot}%{$python_sitelib}
|
%python_expand %fdupes %{buildroot}%{$python_sitelib}
|
||||||
|
|
||||||
%check
|
%check
|
||||||
@@ -68,6 +63,6 @@ cp %{SOURCE1} tests.py
|
|||||||
%license LICENSE
|
%license LICENSE
|
||||||
%doc README.md
|
%doc README.md
|
||||||
%{python_sitelib}/pypandoc
|
%{python_sitelib}/pypandoc
|
||||||
%{python_sitelib}/pypandoc-%{version}*-info
|
%{python_sitelib}/pypandoc-%{version}.dist-info
|
||||||
|
|
||||||
%changelog
|
%changelog
|
||||||
|
|||||||
664
tests.py
664
tests.py
@@ -1,664 +0,0 @@
|
|||||||
#!/usr/bin/env python
|
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
|
|
||||||
import contextlib
|
|
||||||
import io
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
import re
|
|
||||||
import shutil
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
import tempfile
|
|
||||||
import textwrap
|
|
||||||
import unittest
|
|
||||||
import warnings
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import pypandoc
|
|
||||||
from pypandoc.py3compat import path2url, string_types, unicode_type
|
|
||||||
|
|
||||||
|
|
||||||
@contextlib.contextmanager
|
|
||||||
def capture(command, *args, **kwargs):
|
|
||||||
err, sys.stderr = sys.stderr, io.StringIO()
|
|
||||||
try:
|
|
||||||
command(*args, **kwargs)
|
|
||||||
sys.stderr.seek(0)
|
|
||||||
yield sys.stderr.read()
|
|
||||||
finally:
|
|
||||||
sys.stderr = err
|
|
||||||
|
|
||||||
|
|
||||||
@contextlib.contextmanager
|
|
||||||
def closed_tempfile(suffix, text=None, dir_name=None):
|
|
||||||
file_name = None
|
|
||||||
try:
|
|
||||||
if dir_name:
|
|
||||||
dir_name = tempfile.mkdtemp(suffix=dir_name)
|
|
||||||
|
|
||||||
with tempfile.NamedTemporaryFile('w+t', suffix=suffix, delete=False, dir=dir_name) as test_file:
|
|
||||||
file_name = test_file.name
|
|
||||||
if text:
|
|
||||||
test_file.write(text)
|
|
||||||
test_file.flush()
|
|
||||||
yield file_name
|
|
||||||
finally:
|
|
||||||
if dir_name:
|
|
||||||
shutil.rmtree(dir_name, ignore_errors=True)
|
|
||||||
elif file_name:
|
|
||||||
os.remove(file_name)
|
|
||||||
|
|
||||||
|
|
||||||
# Stolen from pandas
|
|
||||||
def is_list_like(arg):
|
|
||||||
return (hasattr(arg, '__iter__') and
|
|
||||||
not isinstance(arg, string_types))
|
|
||||||
|
|
||||||
|
|
||||||
@contextlib.contextmanager
|
|
||||||
def assert_produces_warning(expected_warning=Warning, filter_level="always",
|
|
||||||
clear=None, check_stacklevel=True):
|
|
||||||
"""
|
|
||||||
Context manager for running code that expects to raise (or not raise)
|
|
||||||
warnings. Checks that code raises the expected warning and only the
|
|
||||||
expected warning. Pass ``False`` or ``None`` to check that it does *not*
|
|
||||||
raise a warning. Defaults to ``exception.Warning``, baseclass of all
|
|
||||||
Warnings. (basically a wrapper around ``warnings.catch_warnings``).
|
|
||||||
>>> import warnings
|
|
||||||
>>> with assert_produces_warning():
|
|
||||||
... warnings.warn(UserWarning())
|
|
||||||
...
|
|
||||||
>>> with assert_produces_warning(False):
|
|
||||||
... warnings.warn(RuntimeWarning())
|
|
||||||
...
|
|
||||||
Traceback (most recent call last):
|
|
||||||
...
|
|
||||||
AssertionError: Caused unexpected warning(s): ['RuntimeWarning'].
|
|
||||||
>>> with assert_produces_warning(UserWarning):
|
|
||||||
... warnings.warn(RuntimeWarning())
|
|
||||||
Traceback (most recent call last):
|
|
||||||
...
|
|
||||||
AssertionError: Did not see expected warning of class 'UserWarning'.
|
|
||||||
..warn:: This is *not* thread-safe.
|
|
||||||
"""
|
|
||||||
with warnings.catch_warnings(record=True) as w:
|
|
||||||
|
|
||||||
if clear is not None:
|
|
||||||
# make sure that we are clearing these warnings
|
|
||||||
# if they have happened before
|
|
||||||
# to guarantee that we will catch them
|
|
||||||
if not is_list_like(clear):
|
|
||||||
clear = [clear]
|
|
||||||
for m in clear:
|
|
||||||
try:
|
|
||||||
m.__warningregistry__.clear()
|
|
||||||
except Exception as e:
|
|
||||||
# ignore...
|
|
||||||
print(str(e))
|
|
||||||
|
|
||||||
saw_warning = False
|
|
||||||
warnings.simplefilter(filter_level)
|
|
||||||
yield w
|
|
||||||
extra_warnings = []
|
|
||||||
|
|
||||||
for actual_warning in w:
|
|
||||||
if (expected_warning and issubclass(actual_warning.category,
|
|
||||||
expected_warning)):
|
|
||||||
saw_warning = True
|
|
||||||
|
|
||||||
if check_stacklevel and issubclass(actual_warning.category,
|
|
||||||
(FutureWarning,
|
|
||||||
DeprecationWarning)):
|
|
||||||
from inspect import getframeinfo, stack
|
|
||||||
caller = getframeinfo(stack()[2][0])
|
|
||||||
msg = (("Warning not set with correct stacklevel. " +
|
|
||||||
"File where warning is raised: {0} != {1}. " +
|
|
||||||
"Warning message: {2}").format(
|
|
||||||
actual_warning.filename, caller.filename,
|
|
||||||
actual_warning.message))
|
|
||||||
assert actual_warning.filename == caller.filename, msg
|
|
||||||
else:
|
|
||||||
extra_warnings.append(actual_warning.category.__name__)
|
|
||||||
if expected_warning:
|
|
||||||
assert saw_warning, ("Did not see expected warning of class %r."
|
|
||||||
% expected_warning.__name__)
|
|
||||||
assert not extra_warnings, ("Caused unexpected warning(s): %r."
|
|
||||||
% extra_warnings)
|
|
||||||
|
|
||||||
|
|
||||||
class TestPypandoc(unittest.TestCase):
|
|
||||||
|
|
||||||
# Python 2 compatibility
|
|
||||||
if not hasattr(unittest.TestCase, 'assertRaisesRegex'):
|
|
||||||
assertRaisesRegex = unittest.TestCase.assertRaisesRegexp
|
|
||||||
|
|
||||||
def setUp(self):
|
|
||||||
if 'HOME' not in os.environ:
|
|
||||||
# if this is used with older versions of pandoc-citeproc
|
|
||||||
# https://github.com/jgm/pandoc-citeproc/issues/35
|
|
||||||
if 'TRAVIS_BUILD_DIR' in os.environ:
|
|
||||||
os.environ["HOME"] = os.environ["TRAVIS_BUILD_DIR"]
|
|
||||||
print("Using TRAVIS_BUILD_DIR as HOME")
|
|
||||||
else:
|
|
||||||
os.environ["HOME"] = str(os.getcwd())
|
|
||||||
print("Using current dir as HOME")
|
|
||||||
print(os.environ["HOME"])
|
|
||||||
|
|
||||||
def test_get_pandoc_formats(self):
|
|
||||||
inputs, outputs = pypandoc.get_pandoc_formats()
|
|
||||||
self.assertTrue("markdown" in inputs)
|
|
||||||
self.assertTrue("json" in inputs)
|
|
||||||
self.assertTrue("twiki" in inputs)
|
|
||||||
self.assertTrue("markdown" in outputs)
|
|
||||||
|
|
||||||
def test_get_pandoc_version(self):
|
|
||||||
assert "HOME" in os.environ, "No HOME set, this will error..."
|
|
||||||
version = pypandoc.get_pandoc_version()
|
|
||||||
self.assertTrue(isinstance(version, pypandoc.string_types))
|
|
||||||
major = int(version.split(".")[0])
|
|
||||||
self.assertTrue(major in [0, 1, 2, 3])
|
|
||||||
|
|
||||||
def test_ensure_pandoc_minimal_version(self):
|
|
||||||
assert "HOME" in os.environ, "No HOME set, this will error..."
|
|
||||||
assert pypandoc.ensure_pandoc_minimal_version(1) == True
|
|
||||||
assert pypandoc.ensure_pandoc_minimal_version(1,1) == True
|
|
||||||
assert pypandoc.ensure_pandoc_minimal_version(999,999) == False
|
|
||||||
|
|
||||||
def test_ensure_pandoc_maximal_version(self):
|
|
||||||
assert "HOME" in os.environ, "No HOME set, this will error..."
|
|
||||||
assert pypandoc.ensure_pandoc_maximal_version(999) == True
|
|
||||||
assert pypandoc.ensure_pandoc_maximal_version(999,999) == True
|
|
||||||
assert pypandoc.ensure_pandoc_maximal_version(1,1) == False
|
|
||||||
|
|
||||||
def test_converts_valid_format(self):
|
|
||||||
self.assertEqualExceptForNewlineEnd(pypandoc.convert_text("ok", format='md', to='rest'), 'ok')
|
|
||||||
|
|
||||||
def test_does_not_convert_to_invalid_format(self):
|
|
||||||
def f():
|
|
||||||
pypandoc.convert_text("ok", format='md', to='invalid')
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(RuntimeError, "Invalid output format! Got invalid but "):
|
|
||||||
f()
|
|
||||||
|
|
||||||
def test_does_not_convert_from_invalid_format(self):
|
|
||||||
def f():
|
|
||||||
pypandoc.convert_text("ok", format='invalid', to='rest')
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(RuntimeError, 'Invalid input format! Got "invalid" but '):
|
|
||||||
f()
|
|
||||||
|
|
||||||
def test_basic_conversion_from_file(self):
|
|
||||||
with closed_tempfile('.md', text='# some title\n') as file_name:
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
received = pypandoc.convert_file(file_name, 'rst')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
def test_basic_conversion_from_multiple_files(self):
|
|
||||||
with closed_tempfile('.md', text='some title') as file_name1:
|
|
||||||
with closed_tempfile('.md', text='some title') as file_name2:
|
|
||||||
expected = '<p>some title</p>\n<p>some title</p>'
|
|
||||||
received = pypandoc.convert_file([file_name1,file_name2], 'html')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
def test_basic_conversion_from_file_pattern(self):
|
|
||||||
received = pypandoc.convert_file("./*.md", 'html')
|
|
||||||
received = received.lower()
|
|
||||||
assert "making a release" in received
|
|
||||||
assert "pypandoc provides a thin wrapper" in received
|
|
||||||
|
|
||||||
def test_basic_conversion_from_file_pattern_with_input_list(self):
|
|
||||||
received = pypandoc.convert_file(["./*.md", "./*.md"], 'html')
|
|
||||||
received = received.lower()
|
|
||||||
assert "making a release" in received
|
|
||||||
assert "pypandoc provides a thin wrapper" in received
|
|
||||||
|
|
||||||
@unittest.skipIf(sys.platform.startswith("win"), "File based urls do not work on windows: "
|
|
||||||
"https://github.com/jgm/pandoc/issues/4613")
|
|
||||||
def test_basic_conversion_from_file_url(self):
|
|
||||||
with closed_tempfile('.md', text='# some title\n') as file_name:
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
# this keeps the : (which should be '|' on windows but pandoc
|
|
||||||
# doesn't like it
|
|
||||||
file_url = path2url(file_name)
|
|
||||||
assert pypandoc._identify_path(file_url)
|
|
||||||
|
|
||||||
received = pypandoc.convert_file(file_url, 'rst')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
def test_basic_conversion_from_http_url(self):
|
|
||||||
url = 'https://raw.githubusercontent.com/bebraw/pypandoc/master/README.md'
|
|
||||||
received = pypandoc.convert_file(url, 'html')
|
|
||||||
assert "GPL2 license" in received
|
|
||||||
|
|
||||||
def test_conversion_with_data_files(self):
|
|
||||||
# remove our test.docx file from our test_data dir if it already exosts
|
|
||||||
test_data_dir = os.path.join(os.path.dirname(__file__), 'test_data')
|
|
||||||
test_docx_file = os.path.join(test_data_dir, 'test.docx')
|
|
||||||
if os.path.exists(test_docx_file):
|
|
||||||
os.remove(test_docx_file)
|
|
||||||
result = pypandoc.convert_file(
|
|
||||||
os.path.join(test_data_dir, 'index.html'),
|
|
||||||
to='docx',
|
|
||||||
format='html',
|
|
||||||
outputfile=test_docx_file,
|
|
||||||
sandbox=True,
|
|
||||||
)
|
|
||||||
print(result)
|
|
||||||
|
|
||||||
def test_convert_with_custom_writer(self):
|
|
||||||
version = pypandoc.get_pandoc_version()
|
|
||||||
major = int(version.split(".")[0])
|
|
||||||
if major == 3:
|
|
||||||
# apparently --print-default-data-file fails on pandoc3x
|
|
||||||
return
|
|
||||||
lua_file_content = self.create_sample_lua()
|
|
||||||
with closed_tempfile('.md', text='# title\n') as file_name:
|
|
||||||
with closed_tempfile('.lua', text=lua_file_content, dir_name="foo-bar+baz") as lua_file_name:
|
|
||||||
expected = u'<h1 id="title">title</h1>{0}'.format(os.linesep)
|
|
||||||
received = pypandoc.convert_file(file_name, lua_file_name)
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
def test_basic_conversion_from_file_with_format(self):
|
|
||||||
with closed_tempfile('.md', text='# some title\n') as file_name:
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
received = pypandoc.convert_file(file_name, 'rst', format='md')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
received = pypandoc.convert_file(file_name, 'rst', format='md')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
def test_basic_conversion_from_string(self):
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
received = pypandoc.convert_text('# some title', 'rst', format='md')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
received = pypandoc.convert_text('# some title', 'rst', format='md')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
def test_conversion_with_markdown_extensions(self):
|
|
||||||
input = '<s>strike</s>'
|
|
||||||
expected_with_extension = u'~~strike~~'
|
|
||||||
expected_without_extension = u'<s>strike</s>'
|
|
||||||
received_with_extension = pypandoc.convert_text(input, 'markdown+strikeout',
|
|
||||||
format='html')
|
|
||||||
received_without_extension = pypandoc.convert_text(input,
|
|
||||||
'markdown-strikeout',
|
|
||||||
format='html')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected_with_extension, received_with_extension)
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected_without_extension, received_without_extension)
|
|
||||||
|
|
||||||
def test_conversion_from_markdown_with_extensions(self):
|
|
||||||
# Apparently without the extension, ~~ gets turned into different code
|
|
||||||
# depending on the pandoc version. So we do not test for that anymore...
|
|
||||||
input = u'~~strike~~'
|
|
||||||
expected_with_extension = u'<p><del>strike</del></p>'
|
|
||||||
received_with_extension = pypandoc.convert_text(input, 'html', format=u'markdown+strikeout')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected_with_extension, received_with_extension)
|
|
||||||
|
|
||||||
def test_basic_conversion_to_file(self):
|
|
||||||
with closed_tempfile('.rst', ) as file_name:
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
received = pypandoc.convert_text('# some title\n', to='rst', format='md', outputfile=file_name)
|
|
||||||
self.assertEqualExceptForNewlineEnd("", received)
|
|
||||||
with io.open(file_name) as f:
|
|
||||||
written = f.read()
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, written)
|
|
||||||
|
|
||||||
# to odf does not work without a file
|
|
||||||
def f():
|
|
||||||
pypandoc.convert_text('# some title\n', to='odf', format='md',
|
|
||||||
outputfile=None)
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(RuntimeError, "Invalid output format! Got odf but "):
|
|
||||||
f()
|
|
||||||
|
|
||||||
def test_conversion_with_empty_filter(self):
|
|
||||||
# we just want to get a temp file name, where we can write to
|
|
||||||
filters = ''
|
|
||||||
written = pypandoc.convert_file('./filter_test.md', to='html', format='md',
|
|
||||||
outputfile=None, filters=filters)
|
|
||||||
import re as re
|
|
||||||
# This should not use the pandoc-citeproc module and will not find the
|
|
||||||
# strings
|
|
||||||
found = re.search(r'Fenner', written)
|
|
||||||
self.assertTrue(found is None)
|
|
||||||
found = re.search(r'10.1038', written)
|
|
||||||
self.assertTrue(found is None)
|
|
||||||
|
|
||||||
def test_conversion_with_python_filter(self):
|
|
||||||
markdown_source = "**Here comes the content.**"
|
|
||||||
python_source = '''\
|
|
||||||
#!{0}
|
|
||||||
|
|
||||||
"""
|
|
||||||
Pandoc filter to convert all regular text to uppercase.
|
|
||||||
Code, link URLs, etc. are not affected.
|
|
||||||
"""
|
|
||||||
|
|
||||||
from pandocfilters import toJSONFilter, Str
|
|
||||||
|
|
||||||
def caps(key, value, format, meta):
|
|
||||||
if key == 'Str':
|
|
||||||
return Str(value.upper())
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
toJSONFilter(caps)
|
|
||||||
'''
|
|
||||||
python_source = textwrap.dedent(python_source)
|
|
||||||
python_source = python_source.format(sys.executable)
|
|
||||||
|
|
||||||
with closed_tempfile(".py", python_source) as tempfile:
|
|
||||||
os.chmod(tempfile, 0o755)
|
|
||||||
output = pypandoc.convert_text(
|
|
||||||
markdown_source, to='html', format='md', outputfile=None, filters=tempfile
|
|
||||||
).strip()
|
|
||||||
expected = '<p><strong>HERE COMES THE CONTENT.</strong></p>'
|
|
||||||
self.assertTrue(output == expected)
|
|
||||||
|
|
||||||
def test_conversion_with_lua_filter(self):
|
|
||||||
markdown_source = "**Here comes the content.**"
|
|
||||||
lua_source = """\
|
|
||||||
-- taken from: https://pandoc.org/lua-filters.html
|
|
||||||
function Strong(elem)
|
|
||||||
return pandoc.SmallCaps(elem.c)
|
|
||||||
end
|
|
||||||
"""
|
|
||||||
lua_source = textwrap.dedent(lua_source)
|
|
||||||
with closed_tempfile(".lua", lua_source) as tempfile:
|
|
||||||
output = pypandoc.convert_text(
|
|
||||||
markdown_source, to='html', format='md', outputfile=None, filters=tempfile
|
|
||||||
).strip()
|
|
||||||
expected = '<p><span class="smallcaps">Here comes the content.</span></p>'
|
|
||||||
self.assertTrue(output == expected)
|
|
||||||
|
|
||||||
def test_conversion_with_mixed_filters(self):
|
|
||||||
markdown_source = "-0-"
|
|
||||||
|
|
||||||
lua = """\
|
|
||||||
function Para(elem)
|
|
||||||
return pandoc.Para(elem.content .. {{"{0}-"}})
|
|
||||||
end
|
|
||||||
"""
|
|
||||||
lua = textwrap.dedent(lua)
|
|
||||||
|
|
||||||
python = """\
|
|
||||||
#!{0}
|
|
||||||
|
|
||||||
from pandocfilters import toJSONFilter, Para, Str
|
|
||||||
|
|
||||||
def func(key, value, format, meta):
|
|
||||||
if key == "Para":
|
|
||||||
return Para(value + [Str("{{0}}-")])
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
toJSONFilter(func)
|
|
||||||
|
|
||||||
"""
|
|
||||||
python = textwrap.dedent(python)
|
|
||||||
python = python.format(sys.executable)
|
|
||||||
|
|
||||||
with closed_tempfile(".lua", lua.format(1)) as temp1, closed_tempfile(".py", python.format(2)) as temp2:
|
|
||||||
os.chmod(temp2, 0o755)
|
|
||||||
|
|
||||||
with closed_tempfile(".lua", lua.format(3)) as temp3, closed_tempfile(".py", python.format(4)) as temp4:
|
|
||||||
os.chmod(temp4, 0o755)
|
|
||||||
|
|
||||||
output = pypandoc.convert_text(
|
|
||||||
markdown_source, to="html", format="md", outputfile=None, filters=[temp1, temp2, temp3, temp4]
|
|
||||||
).strip()
|
|
||||||
expected = "<p>-0-1-2-3-4-</p>"
|
|
||||||
self.assertEquals(output, expected)
|
|
||||||
|
|
||||||
output = pypandoc.convert_text(
|
|
||||||
markdown_source, to="html", format="md", outputfile=None, filters=[temp3, temp1, temp4, temp2]
|
|
||||||
).strip()
|
|
||||||
expected = "<p>-0-3-1-4-2-</p>"
|
|
||||||
self.assertEquals(output, expected)
|
|
||||||
|
|
||||||
def test_classify_pandoc_logging(self):
|
|
||||||
|
|
||||||
test = ("[WARNING] This is some message on\ntwo lines\n"
|
|
||||||
"[ERROR] This is a second message.")
|
|
||||||
|
|
||||||
expected_levels = [30, 40]
|
|
||||||
expected_msgs = ["This is some message on\ntwo lines",
|
|
||||||
"This is a second message."]
|
|
||||||
|
|
||||||
for i, (l, m) in enumerate(pypandoc._classify_pandoc_logging(test)):
|
|
||||||
self.assertEqual(expected_levels[i], l)
|
|
||||||
self.assertEqual(expected_msgs[i], m)
|
|
||||||
|
|
||||||
|
|
||||||
def test_classify_pandoc_logging_default(self):
|
|
||||||
|
|
||||||
test = ("This is some message on\ntwo lines\n"
|
|
||||||
"[ERROR] This is a second message.")
|
|
||||||
expected_levels = [30, 40]
|
|
||||||
expected_msgs = ["This is some message on\ntwo lines",
|
|
||||||
"This is a second message."]
|
|
||||||
|
|
||||||
for i, (l, m) in enumerate(pypandoc._classify_pandoc_logging(test)):
|
|
||||||
self.assertEqual(expected_levels[i], l)
|
|
||||||
self.assertEqual(expected_msgs[i], m)
|
|
||||||
|
|
||||||
|
|
||||||
def test_classify_pandoc_logging_invalid_level(self):
|
|
||||||
|
|
||||||
test = ("[WARN] This is some message on\ntwo lines\n"
|
|
||||||
"[ERR] This is a second message.\n"
|
|
||||||
"[ERROR] This is a third message.")
|
|
||||||
expected_levels = [30, 30, 40]
|
|
||||||
expected_msgs = ["This is some message on\ntwo lines",
|
|
||||||
"This is a second message.",
|
|
||||||
"This is a third message."]
|
|
||||||
|
|
||||||
for i, (l, m) in enumerate(pypandoc._classify_pandoc_logging(test)):
|
|
||||||
self.assertEqual(expected_levels[i], l)
|
|
||||||
self.assertEqual(expected_msgs[i], m)
|
|
||||||
|
|
||||||
|
|
||||||
def test_conversion_stderr(self):
|
|
||||||
|
|
||||||
# Clear logger handlers
|
|
||||||
logger = logging.getLogger("pypandoc")
|
|
||||||
logger.handlers = []
|
|
||||||
|
|
||||||
with closed_tempfile('.docx') as file_name:
|
|
||||||
text = ('\n'
|
|
||||||
'\n')
|
|
||||||
with capture(pypandoc.convert_text,
|
|
||||||
text,
|
|
||||||
to='docx',
|
|
||||||
format='md',
|
|
||||||
outputfile=file_name) as output:
|
|
||||||
output = re.sub(r'\r', '', output)
|
|
||||||
output = output.replace("'missing.png'",
|
|
||||||
"missing.png")
|
|
||||||
output = output.lower()
|
|
||||||
print(output)
|
|
||||||
assert "[warning] could not fetch resource missing.png" in output
|
|
||||||
|
|
||||||
def test_conversion_stderr_nullhandler(self):
|
|
||||||
|
|
||||||
# Replace any logging handlers with a null handler
|
|
||||||
logger = logging.getLogger("pypandoc")
|
|
||||||
logger.handlers = [logging.NullHandler()]
|
|
||||||
|
|
||||||
with closed_tempfile('.docx') as file_name:
|
|
||||||
text = ('\n'
|
|
||||||
'\n')
|
|
||||||
with capture(pypandoc.convert_text,
|
|
||||||
text,
|
|
||||||
to='docx',
|
|
||||||
format='md',
|
|
||||||
outputfile=file_name) as output:
|
|
||||||
self.assertFalse(output)
|
|
||||||
|
|
||||||
|
|
||||||
def test_conversion_error(self):
|
|
||||||
# pandoc dies on wrong commandline arguments
|
|
||||||
def f():
|
|
||||||
pypandoc.convert_text('<h1>Primary Heading</h1>', 'md', format='html', extra_args=["--blah"])
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(RuntimeError, 'Pandoc died with exitcode "6" during conversion: Unknown option --blah'):
|
|
||||||
f()
|
|
||||||
|
|
||||||
def test_unicode_input(self):
|
|
||||||
# make sure that pandoc always returns unicode and does not mishandle it
|
|
||||||
expected = u'üäöîôû{0}'.format(os.linesep)
|
|
||||||
written = pypandoc.convert_text(u'<p>üäöîôû</p>', 'md', format='html')
|
|
||||||
self.assertTrue(isinstance(written, unicode_type))
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, written)
|
|
||||||
bytes = u'<p>üäöîôû</p>'.encode("utf-8")
|
|
||||||
written = pypandoc.convert_text(bytes, 'md', format='html')
|
|
||||||
self.assertTrue(expected == written)
|
|
||||||
self.assertTrue(isinstance(written, unicode_type))
|
|
||||||
|
|
||||||
# Only use german umlauts in the next test, as iso-8859-15 covers that
|
|
||||||
expected = u'äüäö{0}'.format(os.linesep)
|
|
||||||
bytes = u'<p>äüäö</p>'.encode("iso-8859-15")
|
|
||||||
|
|
||||||
# Without encoding, this fails as we expect utf-8 per default
|
|
||||||
|
|
||||||
def f():
|
|
||||||
written = pypandoc.convert_text(bytes, 'md', format='html')
|
|
||||||
|
|
||||||
assert expected != written
|
|
||||||
|
|
||||||
def f():
|
|
||||||
# we have to use something which interprets '\xa4', so latin and -1 does not work :-/
|
|
||||||
written = pypandoc.convert_text(bytes, 'md', format='html', encoding="utf-16")
|
|
||||||
|
|
||||||
assert expected != written
|
|
||||||
# with the right encoding it should work...
|
|
||||||
written = pypandoc.convert_text(bytes, 'md', format='html', encoding="iso-8859-15")
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, written)
|
|
||||||
self.assertTrue(isinstance(written, unicode_type))
|
|
||||||
|
|
||||||
def test_conversion_from_non_plain_text_file(self):
|
|
||||||
with closed_tempfile('.docx') as file_name:
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
# let's just test conversion (to and) from docx, testing e.g. odt
|
|
||||||
# as well would really be testing pandoc rather than pypandoc
|
|
||||||
received = pypandoc.convert_text('# some title\n', to='docx', format='md', outputfile=file_name)
|
|
||||||
self.assertEqualExceptForNewlineEnd("", received)
|
|
||||||
received = pypandoc.convert_file(file_name, to='rst')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received)
|
|
||||||
|
|
||||||
def test_pdf_conversion(self):
|
|
||||||
with closed_tempfile('.pdf') as file_name:
|
|
||||||
ret = pypandoc.convert_text('# some title\n', to='pdf', format='md', outputfile=file_name)
|
|
||||||
assert ret == ""
|
|
||||||
with io.open(file_name, mode='rb') as f:
|
|
||||||
written = f.read()
|
|
||||||
assert written[:4] == b"%PDF"
|
|
||||||
# TODO: find a test for the content?
|
|
||||||
|
|
||||||
def f():
|
|
||||||
# needs an outputfile
|
|
||||||
pypandoc.convert_text('# some title\n', to='pdf', format='md')
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(RuntimeError, "Output to pdf only works by using a outputfile"):
|
|
||||||
f()
|
|
||||||
|
|
||||||
# outputfile needs to end in pdf
|
|
||||||
with closed_tempfile('.WRONG') as file_name:
|
|
||||||
def f():
|
|
||||||
pypandoc.convert_text('# some title\n', to='pdf', format='md', outputfile=file_name)
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(RuntimeError, 'PDF output needs an outputfile with ".pdf" as a fileending'):
|
|
||||||
f()
|
|
||||||
|
|
||||||
# no extensions allowed
|
|
||||||
with closed_tempfile('.pdf') as file_name:
|
|
||||||
def f():
|
|
||||||
pypandoc.convert_text('# some title\n', to='pdf+something', format='md', outputfile=file_name)
|
|
||||||
|
|
||||||
with self.assertRaisesRegex(RuntimeError, r"PDF output can't contain any extensions: pdf\+something"):
|
|
||||||
f()
|
|
||||||
|
|
||||||
def test_get_pandoc_path(self):
|
|
||||||
result = pypandoc.get_pandoc_path()
|
|
||||||
assert "pandoc" in result
|
|
||||||
|
|
||||||
def test_call_with_nonexisting_file(self):
|
|
||||||
files = ['/file/does/not/exists.md',
|
|
||||||
'file:///file/does/not/exists.md'
|
|
||||||
'',
|
|
||||||
42,
|
|
||||||
None
|
|
||||||
]
|
|
||||||
|
|
||||||
def f(filepath):
|
|
||||||
pypandoc.convert_file(filepath, 'rst')
|
|
||||||
|
|
||||||
for filepath in files:
|
|
||||||
with self.assertRaisesRegex(RuntimeError, "source_file is not a valid path"):
|
|
||||||
f(filepath)
|
|
||||||
|
|
||||||
def test_convert_text_with_existing_file(self):
|
|
||||||
with closed_tempfile('.md', text='# some title\n') as file_name:
|
|
||||||
received = pypandoc.convert_text(file_name, 'rst', format='md')
|
|
||||||
self.assertTrue("title" not in received)
|
|
||||||
|
|
||||||
# The following is a problematic case
|
|
||||||
received = pypandoc.convert_file(file_name, 'rst', format='md')
|
|
||||||
self.assertTrue("title" in received)
|
|
||||||
|
|
||||||
def create_sample_lua(self):
|
|
||||||
args = [pypandoc.get_pandoc_path(), '--print-default-data-file', 'sample.lua']
|
|
||||||
p = subprocess.Popen(args, stdout=subprocess.PIPE)
|
|
||||||
out, err = p.communicate()
|
|
||||||
return out.decode('utf-8')
|
|
||||||
|
|
||||||
def test_basic_conversion_from_file_pathlib(self):
|
|
||||||
with closed_tempfile('.md', text='# some title\n') as file_name:
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
received_from_str_filename_input = pypandoc.convert_file(file_name, 'rst')
|
|
||||||
received_from_path_filename_input = pypandoc.convert_file(Path(file_name), 'rst')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received_from_str_filename_input)
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received_from_path_filename_input)
|
|
||||||
|
|
||||||
def test_basic_conversion_from_multiple_files_pathlib(self):
|
|
||||||
with closed_tempfile('.md', text='some title') as file_name1:
|
|
||||||
with closed_tempfile('.md', text='some title') as file_name2:
|
|
||||||
expected = '<p>some title</p>\n<p>some title</p>'
|
|
||||||
received_from_str_filename_input = pypandoc.convert_file([file_name1, file_name2], 'html')
|
|
||||||
received_from_path_filename_input = pypandoc.convert_file([Path(file_name1), Path(file_name2)], 'html')
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received_from_str_filename_input)
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, received_from_path_filename_input)
|
|
||||||
|
|
||||||
def test_basic_conversion_from_file_pattern_pathlib_glob(self):
|
|
||||||
received_from_str_filename_input = pypandoc.convert_file("./*.md", 'html').lower()
|
|
||||||
received_from_path_filename_input = pypandoc.convert_file(Path(".").glob("*.md"), 'html').lower()
|
|
||||||
assert received_from_str_filename_input == received_from_path_filename_input
|
|
||||||
|
|
||||||
def test_basic_conversion_from_file_pattern_with_input_list_pathlib_glob(self):
|
|
||||||
received_from_str_filename_input = pypandoc.convert_file(["./*.md", "./*.md"], 'html').lower()
|
|
||||||
received_from_path_filename_input = pypandoc.convert_file([*Path(".").glob("*.md"), *Path(".").glob("*.md")],
|
|
||||||
'html').lower()
|
|
||||||
assert received_from_str_filename_input == received_from_path_filename_input
|
|
||||||
|
|
||||||
def test_basic_conversion_to_pathlib_file(self):
|
|
||||||
with closed_tempfile('.rst', ) as file_name:
|
|
||||||
expected = u'some title{0}=========={0}{0}'.format(os.linesep)
|
|
||||||
received = pypandoc.convert_text('# some title\n', to='rst', format='md', outputfile=Path(file_name))
|
|
||||||
self.assertEqualExceptForNewlineEnd("", received)
|
|
||||||
with io.open(file_name) as f:
|
|
||||||
written = f.read()
|
|
||||||
self.assertEqualExceptForNewlineEnd(expected, written)
|
|
||||||
|
|
||||||
def assertEqualExceptForNewlineEnd(self, expected, received): # noqa
|
|
||||||
# output written to a file does not seem to have os.linesep
|
|
||||||
# handle everything here by replacing the os linesep by a simple \n
|
|
||||||
expected = expected.replace(os.linesep, "\n")
|
|
||||||
received = received.replace(os.linesep, "\n")
|
|
||||||
self.assertEqual(expected.rstrip('\n'), received.rstrip('\n'))
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
suite = unittest.TestLoader().loadTestsFromTestCase(TestPypandoc)
|
|
||||||
ret = unittest.TextTestRunner(verbosity=2).run(suite)
|
|
||||||
sys.exit(0 if ret.wasSuccessful() else 1)
|
|
||||||
Reference in New Issue
Block a user