code_pydocstyle.py

import os
import random
from datetime import date, timedelta
from glob import glob

import pydocstyle

print(f"Pydocstyle version: {pydocstyle.__version__}")

UNTRACKED_MODULES = ['fitting.py']

file_list = filter(
    lambda z: not z.endswith("__init__.py") and not any(z.endswith(module) for module in UNTRACKED_MODULES),
    [y for x in os.walk("./volmdlr") for y in glob(os.path.join(x[0], "*.py"))],
)

UNWATCHED_ERRORS = [
    # Do not watch these errors
    'D100', 'D104', 'D105', 'D107',
    'D200', 'D202', 'D203', 'D204', 'D206', 'D210', 'D212',
    'D301', 'D302',
    'D401', 'D402', 'D407', 'D408', 'D409',
    'D412', 'D415', 'D418'
]

MAX_ERROR_BY_TYPE = {
    # If the error code is not in this dict, then there is no tolerance on the error.
    # http://www.pydocstyle.org/en/stable/error_codes.html
    "D101": 53,
    "D102": 347,
    "D103": 3,
    "D205": 77,

    "D400": 67,
}

error_detected = False
error_over_ratchet_limit = False
EFFECTIVE_DATE = date(2022, 11, 28)
DAYS_TIME_EFFECT_LIMITING = 21

limit_time_effect = False
if os.environ.get('DRONE_BRANCH', '') in ['master', 'testing']:
    limit_time_effect = True
    print(f"Limiting time effect of 21 days as we are on {os.environ['DRONE_BRANCH']}")

if os.environ.get('DRONE_TARGET_BRANCH', '') in ['master', 'testing']:
    limit_time_effect = True
    print(f"Limiting time effect of 21 days as we are targeting {os.environ['DRONE_TARGET_BRANCH']}")

if limit_time_effect:
    EFFECTIVE_DATE += timedelta(days=21)

today = date.today()
weekly_decrease = 5
time_decrease = int((today - EFFECTIVE_DATE).days / 7.0 * weekly_decrease)
ratchet_limit = 5 + int(DAYS_TIME_EFFECT_LIMITING / 7.0 * weekly_decrease)


code_to_errors = {}
for error in pydocstyle.check(file_list, ignore=UNWATCHED_ERRORS):
    code_to_errors.setdefault(error.code, [])
    code_to_errors[error.code].append(error)

code_to_number = {code: len(errors) for code, errors in code_to_errors.items()}

for error_code, number_errors in code_to_number.items():
    if error_code not in UNWATCHED_ERRORS:
        max_errors = max(MAX_ERROR_BY_TYPE.get(error_code, 0) - time_decrease, 0)

        if number_errors > max_errors:
            # The number of errors is above the maximum acceptable
            error_detected = True
            print(f"\nFix some {error_code} errors: {number_errors}/{max_errors}")

            errors = code_to_errors[error_code]
            errors_to_show = sorted(
                random.sample(errors, min(30, len(errors))), key=lambda m: (m.filename, m.line)
            )
            for error in errors_to_show:
                print(f"{error.filename} line {error.line}: {error.message}")

        elif max_errors - ratchet_limit <= number_errors < max_errors:
            # The number of errors is below the maximum acceptable, but above the ratchet_limit:
            # the user can reduce the maximum number of errors
            print(
                f"\nYou can adjust number of admissible errors (in code_pydocstyle.py) of {error_code} to {number_errors + time_decrease} (actual {max_errors + time_decrease})"
            )

        elif number_errors < max_errors - ratchet_limit:
            # The number of errors is below the maximum acceptable, and below the ratchet_limit:
            # the user must reduce the maximum number of errors
            error_over_ratchet_limit = True
            print(
                f"\nYou MUST adjust number of admissible errors (in code_pydocstyle.py) of {error_code} to {number_errors + time_decrease} (actual {max_errors + time_decrease})"
            )

if error_detected:
    raise RuntimeError("Too many errors\nRun pydocstyle volmdlr to get the errors")

if error_over_ratchet_limit:
    raise RuntimeError(
        "Please lower the error limits in code_pydocstyle.py MAX_ERROR_BY_TYPE according to warnings above"
    )