tests.validation_test.teardown_module()

Complexity

Conditions

14

Size

Total Lines	68
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

"""
def teardown_module(module):

The argument module seems to be unused.

    """ The teardown (module) function is called when all tests in this module are complete

    This function will collect and report on the results of all validation tests. That is, their correctness and their

This line is too long as per the coding-style (118/100).

    run-times. These reports are collated into ordered CSV files, each capturing up to 100 contiguous tests:

This line is too long as per the coding-style (108/100).

    * tests 1-100
    * tests 101-200
    * etc.

    These CSVs will be picked up by other code to ultimately build the documented project. These CSVs will contribute

This line is too long as per the coding-style (117/100).

    to the tables of solutions and their respective run-times.

    :param module: the module under teardown (i.e. :mod:`tests.validation_test`)
    :return: None
    """

    def build_csv(start_problem: int, end_problem: int) -> None:
        """ Helper function to build a CSV for 100 problems in a 10x10 grid """

        # Check that start_problem and end_problem define a block of 100 problems
        assert isinstance(start_problem, int), "start_problem must be an integer"
        assert isinstance(end_problem, int), "end_problem must be an integer"
        assert start_problem % 100 == 1, "start_problem must be 1 modulo 100"
        assert end_problem % 100 == 0, "end_problem must be 0 modulo 100"
        assert start_problem < end_problem, "start_problem must be less than end_problem"
        assert end_problem - start_problem + 1 == 100, "start_problem and end_problem must be 100 apart"

This line is too long as per the coding-style (104/100).

        global results  # map the local results variable to the globally shared variable

The name results does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

Usage of the global statement should be avoided.

        header = [""] + ["***{}**".format(i % 10) for i in range(1, 11)]

        path = os.path.join(DOC_ROOT, "{}-{}.csv".format(start_problem, end_problem))
        with open(path, "w", newline="") as fp:

The name fp does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            # Open a CSV file and create a header row
            cw = csv.writer(fp)

The name cw does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            cw.writerow(header)

            row = []  # temporary list to hold each row as it is populated

            for i in range(start_problem, end_problem + 1):
                # Add the row range to the start of a CSV row
                if i % 10 == 1:
                    row.append("**{} - {}**".format(i, i + 9))

                # Add the results for problem number i to the next cell in the CSV
                try:
                    if results[i]["correct"]:
                        row.append("|tick| :doc:`{:.2f} <solutions/{}>`".format(results[i]["time"], i))

This line is too long as per the coding-style (103/100).

                    else:
                        row.append("|warning| :doc:`{:.2f} <solutions/{}>`".format(results[i]["time"], i))

This line is too long as per the coding-style (106/100).

                except KeyError:
                    # KeyError caused by results[i], i.e. there isn't a solution for problem number i

This line is too long as per the coding-style (101/100).

                    row.append("|cross|")

                # Flush the 10-long row to the CSV file
                if i % 10 == 0:
                    cw.writerow(row)
                    row = []  # blank row for the next one

    # Construct CSVs in blocks of 100 problems
    build_csv(1, 100)
    build_csv(101, 200)
    build_csv(201, 300)
    build_csv(301, 400)
    build_csv(401, 500)
    build_csv(501, 600)
    build_csv(601, 700)