codorectorate 0.0.2

Uses decorators to print comments before function invocation

Codorectorate

Simple util module that makes it possible to use decorators to comment before a function or method is run. Useful in E2E testing using Selenium or just normally when running code that should be manually verified to run.

Example - simple

from codorectorate import comment, silent_comment

@comment("Hello")
def test(arg):
    print("world")

@silent_comment("Silent comment")
def test_silent(arg):
    print("Only this gets printed")

Example - in tests

import os
import time
import requests
from django.contrib.staticfiles.testing import StaticLiveServerTestCase
from selenium import webdriver
from selenium.webdriver.chrome.options import Options
from http import HTTPStatus

def comment(argument):
    def decorator(function):
        def wrapper(*args, **kwargs):
            print(argument)
            result = function(*args, **kwargs)
            return result
        return wrapper
    return decorator

class TestNavigationTabs(StaticLiveServerTestCase):
    def setUp(self):
        options = Options()
        IS_CI = os.environ.get('CI')
        if IS_CI:
            print("Running Acceptance Test in headless mode because of CI")
            options.add_argument("--headless")
        self.browser = webdriver.Chrome(options=options)

    def tearDown(self):
        self.browser.quit()

    @comment("Selenium doesnt expose status code in their API")
    def test_404(self):
        url = f'{self.live_server_url}/nosuchurl/'
        self.browser.get(url)
        response = requests.head(url)
        self.assertEqual(response.status_code, HTTPStatus.NOT_FOUND)
        

Publishing

1. python3 -m build
2. twine upload dist/*

pip3 install codecorate