deflector

Deflector

📘 Documentation - Under Construction

Why does Deflector exist?

💡 Deflector is a minimalist testing library for Python designed to simplify test writing with a clear and intuitive syntax, allowing developers to create and run tests quickly and efficiently without unnecessary complications.

High isolation level per file
Performant and lightweight
Fully typed library

Quickstart

Install

$ pip install deflector

Or with poetry

poetry add deflector -G dev

Test

tests/test_file1.py

from deflector import affirm affirm.equal(1, 1, "My first test with deflector")

Run

deflector # or poetry run deflector

Or defining the directory where the tests are:

deflector --dir tests

Features

Main

Function	Description
affirm	🔍 Test assertion.
it	🤹🏻‍♀️ Isolate tests.
describe	🤹🏻‍♀️ Grouping tests.
before_each • after_each	🃏 Functions for test setup and teardown.

Affirm

The affirm is used to create tests that validate whether the behavior of your code is as expected, checking the correspondence between values ​​and triggering errors if there are discrepancies.

from deflector import affirm

Function	Description
ok	Checks if a value is truthy.
equal	Compares if two values are equal.
not_equal	Verifies if two values are different.
match_re	Checks if a string matches a regex.
does_not_match_re	Verifies if a string does not match a regex.

Ok

affirm.ok(value, message)

affirm.ok(True, "Ok")

Equals

affirm.equal(value, expected, message)

affirm.equal(1 + 2, 3, "Equal: Sum 1+2=3")

Not Equals

affirm.not_equal(value, expected, message)

affirm.not_equal(1 + 2, 4, "Not Equal: Sum 1+2!=4")

Match Regex

affirm.match_re(value, reg_exp, message)

affirm.match_re("acab", "ab", "Match Regex: ab in acab")

Does Not Match Regex

affirm.does_not_match_re(value, reg_exp, message)

affirm.does_not_match_re("ab", "abc", "Does Not Match Regex: ab not in a")

It

from deflector import affirm, it

@it("It Test 1")
def test_1() -> None:
    affirm.ok(True, "Ok")
    affirm.equal(1 + 1, 2, "Equal")
    affirm.not_equal(1 + 2, 1, "Not Equal")
    affirm.match_re("acab", "ab", "Match Re")
    affirm.does_not_match_re("a", "ab", "Does Not Match Re")

Describe

from deflector import affirm, describe, it

@describe("Main 1")
def describe_main() -> None:
    @it("It Test 1")
    def test1() -> None:
        affirm.equal(1 + 1, 2, "Equal 1+1=2")

    @it("It Test 2")
    def test2() -> None:
        affirm.match_re("acab", "ab", "Match Re")

Before Each • After Each

from deflector import affirm, describe, it

@describe("Main 1")
def describe_main() -> None:
    x = 1

    @before_each()
    async def start() -> bool:
        nonlocal x
        await asyncio.sleep(1)
        x += 1
        return True

    @after_each()
    async def end_() -> bool:
        nonlocal x
        await asyncio.sleep(1)
        x = 1
        return True

    @it("It Test 1")
    def test1() -> None:
        affirm.equal(x, 2, "Equal Before Each")
        affirm.equal(1 + 1, 2, "Equal 1")
        affirm.equal(1 + 1, 2, "Equal 2")

    @it("It Test 2")
    def test2() -> None:
        affirm.equal(x, 2, "Equal After Each")
        affirm.equal(1 + 1, 2, "Equal")
        affirm.not_equal(1 + 1, 1, "Not Equal")
        affirm.ok(True, "Ok")
        affirm.match_re("acab", "ab", "Match Re")
        affirm.does_not_match_re("a", "ab", "Does Not Match Re")