File: test_rst_is_valid.py

package info (click to toggle)
python-hypothesis 6.138.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 15,272 kB
  • sloc: python: 62,853; ruby: 1,107; sh: 253; makefile: 41; javascript: 6
file content (50 lines) | stat: -rw-r--r-- 1,544 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# This file is part of Hypothesis, which may be found at
# https://github.com/HypothesisWorks/hypothesis/
#
# Copyright the Hypothesis Authors.
# Individual contributors are listed in AUTHORS.rst and the git log.
#
# This Source Code Form is subject to the terms of the Mozilla Public License,
# v. 2.0. If a copy of the MPL was not distributed with this file, You can
# obtain one at https://mozilla.org/MPL/2.0/.

import os
import re
from pathlib import Path

import hypothesistooling as tools
from hypothesistooling.projects import hypothesispython as hp
from hypothesistooling.scripts import pip_tool


def is_sphinx(f):
    f = os.path.abspath(f)
    return f.startswith(os.path.join(hp.HYPOTHESIS_PYTHON, "docs"))


ALL_RST = [
    f
    for f in tools.all_files()
    if os.path.basename(f) not in ["RELEASE.rst", "RELEASE-sample.rst"]
    and f.endswith(".rst")
]


def test_passes_rst_lint():
    pip_tool("rst-lint", *(f for f in ALL_RST if not is_sphinx(f)))


def test_rst_code_blocks():
    # has bitten us before https://github.com/HypothesisWorks/hypothesis/pull/4273
    pattern = re.compile(r"^\.\.\s+code-block:\s+", re.MULTILINE)
    for f in ALL_RST:
        matches = pattern.search(Path(f).read_text())
        assert not matches, (
            f"incorrect code block syntax in {f}. Use `.. code-block::` "
            "instead of `.. code-block:`"
        )


def disabled_test_passes_flake8():
    # TODO: get these whitespace checks without flake8?
    pip_tool("flake8", "--select=W191,W291,W292,W293,W391", *ALL_RST)