Rewrite Python Test Framework docs

[kazk]

• reference
• guide/tutorial

---

We currently have two Python test framework docs.

• https://github.com/codewars/docs/blob/master/wiki/codewars-python-test-framework.md
• https://github.com/codewars/docs/blob/master/wiki/codewars-python-test-framework-v2.md

Based on these, we should create:

• A guide for writing good tests with it (read few times when starting)
• A reference manual you can refer to (read multiple times)

The guide should describe how to write tests. The reference should list all the assertion functions and example usages.

Later, we can also add another page for specific topics, e.g., writing random tests.

Feel free to comment for any thoughts. Also, assign yourself to let the other members know you're going to work on it.

[Blind4Basics]

do we agree to describe only v2? (saying that v1 still exists in old katas should be enough. Only PUs will be facing old codes to maintain anyway, I guess)

I'll begin with the reference manual.

[Blind4Basics]

BTW, now that we're talking about it... Should we add my module forbidder to the test framework? That would require some work, but it's already in the wild in a lot of katas and it's spreading. And it has some flaws and it already became impossible to update it everywhere, since I don't know all the places... :/

(yeah, it's "a bit" off topic... x) )

[kazk]

Yeah, focus on the v2. We can add some notes about the old one later.

For module forbidder, can you open a new issue at https://github.com/codewars/python-test-framework?

[Blind4Basics]

done

is that repo the last version? (I believe not?) I'd like to have the code on hand so that I can check what I write about it. XD

[kazk]

Yeah, it's the version being used on Codewars.

[hobovsky]

On structuring the test suite with describe/it:

Assertions directly in describe should be avoided. It happens to work at the moment, but it's awkward.
Top-level it should be fine. Many test frameworks don't have describe.
Top-level assertions are strongly discouraged.

So describe -> it -> assertions best, it -> assertions ok, describe -> assertions bad, assertions bad.

[hobovsky]

Created an issue dedicated to the guide here: #191.

[hobovsky]

@kazk now #191 and #197 are done, do you consider anything more necessary in scope of this issue, or can it be closed?

[kazk]

This can be closed. Thanks everyone, for writing them.