207 |
208 | {{#sources?}}
209 |
210 | Jump To …
211 |
212 |
213 | {{#sources}}
214 |
{{ basename }}
215 | {{/sources}}
216 |
217 |
218 |
219 | {{/sources?}}
220 |
223 |
224 | {{#sections}}
225 |
226 |
227 |
230 | {{{ docs_html }}}
231 |
232 |
233 | {{{ code_html }}}
234 |
235 |
236 |
237 | {{/sections}}
238 |
239 |
240 | """
241 |
242 |
243 | def template(source):
244 | return lambda context: pystache.render(source, context)
245 | # Create the template that we will use to generate the Pycco HTML page.
246 | pycco_template = template(html)
247 |
--------------------------------------------------------------------------------
/requirements.test.txt:
--------------------------------------------------------------------------------
1 | coveralls==1.9.2
2 | hypothesis==4.56.1
3 | mock~=2.0
4 | pytest-cov~=2.8.1
5 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | pystache==0.5.4
2 | Pygments==2.5.2
3 | markdown==2.6.11
4 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from setuptools import setup, find_packages
2 |
3 | description = (
4 | "A Python port of Docco: the original quick-and-dirty, "
5 | "hundred-line-long, literate-programming-style documentation "
6 | "generator."
7 | )
8 |
9 | setup(
10 | name="Pycco",
11 | version="0.6.0",
12 | description=description,
13 | author="Zach Smith",
14 | author_email="subsetpark@gmail.com",
15 | url="https://pycco-docs.github.io/pycco/",
16 | packages=find_packages(),
17 | entry_points={
18 | 'console_scripts': [
19 | 'pycco = pycco.main:main',
20 | ]
21 | },
22 | install_requires=['markdown', 'pygments', 'pystache', 'smartypants'],
23 | extras_require={'monitoring': 'watchdog'},
24 | )
25 |
--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/pycco-docs/pycco/27b1bf012e204c4beda18fb48cdf4b378f68ba8d/tests/__init__.py
--------------------------------------------------------------------------------
/tests/test_pycco.py:
--------------------------------------------------------------------------------
1 | from __future__ import absolute_import
2 |
3 | import copy
4 | import os
5 | import os.path
6 | import tempfile
7 | import time
8 |
9 | import pytest
10 |
11 | import pycco.generate_index as generate_index
12 | import pycco.main as p
13 | from hypothesis import assume, example, given
14 | from hypothesis.strategies import booleans, lists, none, text, sampled_from, data
15 | from pycco.languages import supported_languages
16 |
17 | try:
18 | from unittest.mock import patch
19 | except ImportError:
20 | from mock import patch
21 |
22 |
23 |
24 | PYTHON = supported_languages['.py']
25 | PYCCO_SOURCE = 'pycco/main.py'
26 | FOO_FUNCTION = """def foo():\n return True"""
27 |
28 |
29 | def get_language(data):
30 | return data.draw(sampled_from(list(supported_languages.values())))
31 |
32 |
33 | @given(lists(text()), text())
34 | def test_shift(fragments, default):
35 | if fragments == []:
36 | assert p.shift(fragments, default) == default
37 | else:
38 | fragments2 = copy.copy(fragments)
39 | head = p.shift(fragments, default)
40 | assert [head] + fragments == fragments2
41 |
42 |
43 | @given(text(), booleans(), text(min_size=1))
44 | @example("/foo", True, "0")
45 | def test_destination(filepath, preserve_paths, outdir):
46 | dest = p.destination(
47 | filepath, preserve_paths=preserve_paths, outdir=outdir)
48 | assert dest.startswith(outdir)
49 | assert dest.endswith(".html")
50 |
51 |
52 | @given(data(), text())
53 | def test_parse(data, source):
54 | lang = get_language(data)
55 | parsed = p.parse(source, lang)
56 | for s in parsed:
57 | assert {"code_text", "docs_text"} == set(s.keys())
58 |
59 |
60 | def test_skip_coding_directive():
61 | source = "# -*- coding: utf-8 -*-\n" + FOO_FUNCTION
62 | parsed = p.parse(source, PYTHON)
63 | for section in parsed:
64 | assert "coding" not in section['code_text']
65 |
66 |
67 | def test_multi_line_leading_spaces():
68 | source = "# This is a\n# comment that\n# is indented\n"
69 | source += FOO_FUNCTION
70 | parsed = p.parse(source, PYTHON)
71 | # The resulting comment has leading spaces stripped out.
72 | assert parsed[0]["docs_text"] == "This is a\ncomment that\nis indented\n"
73 |
74 |
75 | def test_comment_with_only_cross_ref():
76 | source = (
77 | '''# ==Link Target==\n\ndef test_link():\n """[[testing.py#link-target]]"""\n pass'''
78 | )
79 | sections = p.parse(source, PYTHON)
80 | p.highlight(sections, PYTHON, outdir=tempfile.gettempdir())
81 | assert sections[1][
82 | 'docs_html'] == '
testing.py
'
83 |
84 |
85 | @given(text(), text())
86 | def test_get_language_specify_language(source, code):
87 | assert p.get_language(
88 | source, code, language_name="python") == supported_languages['.py']
89 |
90 | with pytest.raises(ValueError):
91 | p.get_language(source, code, language_name="non-existent")
92 |
93 |
94 | @given(text() | none())
95 | def test_get_language_bad_source(source):
96 | code = "#!/usr/bin/python\n"
97 | code += FOO_FUNCTION
98 | assert p.get_language(source, code) == PYTHON
99 | with pytest.raises(ValueError) as e:
100 | assert p.get_language(source, "badlang")
101 |
102 | msg = "Can't figure out the language!"
103 | try:
104 | assert e.value.message == msg
105 | except AttributeError:
106 | assert e.value.args[0] == msg
107 |
108 |
109 | @given(text() | none())
110 | def test_get_language_bad_code(code):
111 | source = "test.py"
112 | assert p.get_language(source, code) == PYTHON
113 |
114 |
115 | @given(text(max_size=64))
116 | def test_ensure_directory(dir_name):
117 | tempdir = os.path.join(tempfile.gettempdir(),
118 | str(int(time.time())), dir_name)
119 |
120 | # Use sanitization from function, but only for housekeeping. We
121 | # pass in the unsanitized string to the function.
122 | safe_name = p.remove_control_chars(dir_name)
123 |
124 | if not os.path.isdir(safe_name) and os.access(safe_name, os.W_OK):
125 | p.ensure_directory(tempdir)
126 | assert os.path.isdir(safe_name)
127 |
128 |
129 | def test_ensure_multiline_string_support():
130 | code = '''x = """
131 | multi-line-string
132 | """
133 |
134 | y = z # comment
135 |
136 | # *comment with formatting*
137 |
138 | def x():
139 | """multi-line-string
140 | """'''
141 |
142 | docs_code_tuple_list = p.parse(code, PYTHON)
143 |
144 | assert docs_code_tuple_list[0]['docs_text'] == ''
145 | assert "#" not in docs_code_tuple_list[1]['docs_text']
146 |
147 |
148 | def test_indented_block():
149 |
150 | code = '''"""To install Pycco, simply
151 |
152 | pip install pycco
153 | """
154 | '''
155 | parsed = p.parse(code, PYTHON)
156 | highlighted = p.highlight(parsed, PYTHON, outdir=tempfile.gettempdir())
157 | pre_block = highlighted[0]['docs_html']
158 | assert '
' in pre_block
159 | assert '
' in pre_block
160 |
161 |
162 | def test_generate_documentation():
163 | p.generate_documentation(PYCCO_SOURCE, outdir=tempfile.gettempdir())
164 |
165 |
166 | @given(booleans(), booleans(), data())
167 | def test_process(preserve_paths, index, data):
168 | lang_name = data.draw(sampled_from([l["name"] for l in supported_languages.values()]))
169 | p.process([PYCCO_SOURCE], preserve_paths=preserve_paths,
170 | index=index,
171 | outdir=tempfile.gettempdir(),
172 | language=lang_name)
173 |
174 |
175 | @patch('pygments.lexers.guess_lexer')
176 | def test_process_skips_unknown_languages(mock_guess_lexer):
177 | class Name:
178 | name = 'this language does not exist'
179 | mock_guess_lexer.return_value = Name()
180 |
181 | with pytest.raises(ValueError):
182 | p.process(['LICENSE'], outdir=tempfile.gettempdir(), skip=False)
183 |
184 | p.process(['LICENSE'], outdir=tempfile.gettempdir(), skip=True)
185 |
186 |
187 | one_or_more_chars = text(min_size=1, max_size=255)
188 | paths = lists(one_or_more_chars, min_size=1, max_size=30)
189 | @given(
190 | lists(paths, min_size=1, max_size=255),
191 | lists(one_or_more_chars, min_size=1, max_size=255)
192 | )
193 | def test_generate_index(path_lists, outdir_list):
194 | file_paths = [os.path.join(*path_list) for path_list in path_lists]
195 | outdir = os.path.join(*outdir_list)
196 | generate_index.generate_index(file_paths, outdir=outdir)
197 |
198 |
199 | def test_flatten_sources(tmpdir):
200 | sources = [str(tmpdir)]
201 | expected_sources = []
202 |
203 | # Setup the base dir
204 | td = tmpdir.join("test.py")
205 | td.write("#!/bin/env python")
206 | expected_sources.append(str(td))
207 |
208 | # Make some more directories, each with a file present
209 | for d in ["foo", "bar", "buzz"]:
210 | dd = tmpdir.mkdir(d)
211 | dummy_file = dd.join("test.py")
212 | dummy_file.write("#!/bin/env python")
213 | expected_sources.append(str(dummy_file))
214 |
215 | # Get the flattened version of the base directory
216 | flattened = p._flatten_sources(sources)
217 |
218 | # Make sure that the lists are the same
219 | assert sorted(expected_sources) == sorted(flattened)
220 |
--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
1 | [tox]
2 | envlist = py27,py36,codestyle
3 |
4 | [testenv]
5 | deps = -rrequirements.test.txt
6 | commands = pytest
7 |
8 | [testenv:codestyle]
9 | deps = pycodestyle
10 | # E501 - line too long
11 | commands = pycodestyle --ignore=E501 pycco
12 |
--------------------------------------------------------------------------------