diff --git a/README.md b/README.md index 92f78c862a89..c0d8f30da8d1 100644 --- a/README.md +++ b/README.md @@ -16,69 +16,69 @@ Programming language: Python The coverage tool [coverage.py](https://coverage.readthedocs.io/en/7.5.3/) was used for this project. After installing the dependencies and executing `coverage run -m pytest` we get the following output: -![63781](https://github.com/tthijm/sep/assets/74216566/0962f4e0-a7f4-45c0-ab12-59110c55d6c2) +![63781](https://github.com/tthijm/sep-1/assets/74216566/0962f4e0-a7f4-45c0-ab12-59110c55d6c2) Running `coverage html` and opening the document in the browser gives the following: -![23724](https://github.com/tthijm/sep/assets/74216566/5991a9ef-81a1-494f-8016-700ee72d375e) -![4629](https://github.com/tthijm/sep/assets/74216566/83bdba3d-9217-4be0-a67c-9ae2f0db3ad9) +![23724](https://github.com/tthijm/sep-1/assets/74216566/5991a9ef-81a1-494f-8016-700ee72d375e) +![4629](https://github.com/tthijm/sep-1/assets/74216566/83bdba3d-9217-4be0-a67c-9ae2f0db3ad9) ### Your own coverage tool #### Thijmen -[`flatten_literal_params`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1087) +[`flatten_literal_params`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1087) -[commit](https://github.com/tthijm/sep/commit/2afde74ee94eb7e6cdc476356aa41f1ca09d87cf) +[commit](https://github.com/tthijm/sep-1/commit/2afde74ee94eb7e6cdc476356aa41f1ca09d87cf) ![](./assets/flatten_literal_params_custom.png) -[`_human_join`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1397) +[`_human_join`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1397) -[commit](https://github.com/tthijm/sep/commit/88c98ebc05c4d67bcdce7d3046ffa786f79b9284) +[commit](https://github.com/tthijm/sep-1/commit/88c98ebc05c4d67bcdce7d3046ffa786f79b9284) ![](./assets/_human_join_custom.png) #### Maurice -[`_string_width`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L824) +[`_string_width`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L824) -[commit](https://github.com/tthijm/sep/commit/2a0411b2ed3f982b0b0ad9c6ac99ee4d3210b2dc) +[commit](https://github.com/tthijm/sep-1/commit/2a0411b2ed3f982b0b0ad9c6ac99ee4d3210b2dc) ![](./assets/string_width_custom.png) -[`escape_markdown`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L946) +[`escape_markdown`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L946) -[commit](https://github.com/tthijm/sep/commit/fa81a81e90b4623bbaf7e9a2ee2d46e4f26556e9) +[commit](https://github.com/tthijm/sep-1/commit/fa81a81e90b4623bbaf7e9a2ee2d46e4f26556e9) ![](./assets/escape_markdown_custom.png) #### Yasin -[`_get`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L484) and [`_aget`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L502) +[`_get`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L484) and [`_aget`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L502) -[commit](https://github.com/tthijm/sep/commit/017ddcd6bcf0fb838a9e5b3fc427ab7a746ddce6) +[commit](https://github.com/tthijm/sep-1/commit/017ddcd6bcf0fb838a9e5b3fc427ab7a746ddce6) ![](./assets/_get_custom.png) -[`json_or_text`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/http.py#L106) +[`json_or_text`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/http.py#L106) -[commit](https://github.com/tthijm/sep/commit/c8f9434b7caa2fffe7a4b5d92a5af532f82bfb5e) + -[commit](https://github.com/tthijm/sep/commit/17c4a758b69a2f9fed324376e5388e50df7d8089) +[commit](https://github.com/tthijm/sep-1/commit/c8f9434b7caa2fffe7a4b5d92a5af532f82bfb5e) + +[commit](https://github.com/tthijm/sep-1/commit/17c4a758b69a2f9fed324376e5388e50df7d8089) Note: the second commmit is the final instrumentation ![](./assets/json_or_text_custom.png) #### Frank -[`parse_rgb_number`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L55) +[`parse_rgb_number`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L55) -[commit](https://github.com/tthijm/sep/commit/45156c574d1be11a2da25e0f74efe866d3e2cc97) +[commit](https://github.com/tthijm/sep-1/commit/45156c574d1be11a2da25e0f74efe866d3e2cc97) ![](./assets/parse_rgb_number_custom.png) -[`from_str`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L178) +[`from_str`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L178) -[commit](https://github.com/tthijm/sep/commit/51d176fb44faf01d429e81d5cbd5673fb4b42a8b) +[commit](https://github.com/tthijm/sep-1/commit/51d176fb44faf01d429e81d5cbd5673fb4b42a8b) ![](./assets/from_str_custom.png) @@ -88,9 +88,9 @@ Note: the second commmit is the final instrumentation #### Thijmen -[`test_flatten_literal_params`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L374) +[`test_flatten_literal_params`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L374) -[commit](https://github.com/tthijm/sep/commit/18e8104041610c32f9dedff6740688c4d1934550) + [commit](https://github.com/tthijm/sep/commit/138ca9a4c4b0a5f8fba254271f6b913b80d20b95) +[commit](https://github.com/tthijm/sep-1/commit/18e8104041610c32f9dedff6740688c4d1934550) + [commit](https://github.com/tthijm/sep-1/commit/138ca9a4c4b0a5f8fba254271f6b913b80d20b95) ![](./assets/flatten_literal_params_before.png) @@ -99,9 +99,9 @@ Note: the second commmit is the final instrumentation The coverage improvement is +100%. The coverage has been improved, because `flatten_literal_params` used to not be tested, while the new `test_flatten_literal_params` considers every branch to be taken. -[`test__human_join`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L378) +[`test__human_join`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L378) -[commit](https://github.com/tthijm/sep/commit/92796db0afb5feff4b51b3c7e4874c2ba0eae7b9) +[commit](https://github.com/tthijm/sep-1/commit/92796db0afb5feff4b51b3c7e4874c2ba0eae7b9) ![](./assets/_human_join_before.png) @@ -112,9 +112,9 @@ The coverage has been improved, because `_human_join` used to not be tested, whi #### Maurice -[`test_escape_markdown`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L396) +[`test_escape_markdown`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L396) -[commit](https://github.com/tthijm/sep/commit/24b0b85075038a36dacd82dedc434a858ff342da) +[commit](https://github.com/tthijm/sep-1/commit/24b0b85075038a36dacd82dedc434a858ff342da) ![](./assets/escape_markdown_before.png) @@ -123,10 +123,10 @@ The coverage has been improved, because `_human_join` used to not be tested, whi The coverage improvement is +100%. The coverage has been improved, because `escape_markdown` used to not be tested, while the new `test_escape_markdown` considers every branch to be taken. -[`test_string_width`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L385) +[`test_string_width`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L385) -[commit](https://github.com/tthijm/sep/commit/1a5311c4eefde4af064bb28abed0b97659bfaee2) + -[commit](https://github.com/tthijm/sep/commit/fa81a81e90b4623bbaf7e9a2ee2d46e4f26556e9) +[commit](https://github.com/tthijm/sep-1/commit/1a5311c4eefde4af064bb28abed0b97659bfaee2) + +[commit](https://github.com/tthijm/sep-1/commit/fa81a81e90b4623bbaf7e9a2ee2d46e4f26556e9) ![](./assets/string_width_before.png) @@ -137,9 +137,9 @@ The coverage has been improved, because `string_width` used to not be tested, wh #### Yasin -[`test_get_find`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L73) +[`test_get_find`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_utils.py#L73) -[commit](https://github.com/tthijm/sep/commit/02cb0d7aebe7c96c9dc6d734c5a6056f08761565) +[commit](https://github.com/tthijm/sep-1/commit/02cb0d7aebe7c96c9dc6d734c5a6056f08761565) ![](./assets/_get_before.png) @@ -148,9 +148,9 @@ The coverage has been improved, because `string_width` used to not be tested, wh The coverage improvement is 88%. The coverage has been improved, because the previous test_get_find only considered the sync and asyn get with single values. I extended the test so that it tests these functions with multiple attributes as well, this way it currently reaches more branches and therefore the coverage improved. Additionally the previous test did not consider the case where we loop through the array and we don't find the corresponding item we are looking for, we added this case by giving an empty array as argument, which causes the code to not enter the for loop and thus reach more branches. -[`test_json_or_text`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_http.py#L15) +[`test_json_or_text`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_http.py#L15) -[commit](https://github.com/tthijm/sep/commit/590afe1584d3e8f2dcc0a806202ddd4f2c4d7a69) +[commit](https://github.com/tthijm/sep-1/commit/590afe1584d3e8f2dcc0a806202ddd4f2c4d7a69) ![](./assets/json_or_text_before.png) @@ -161,9 +161,9 @@ The coverage has been improved, because the previously there was no test for jso #### Frank -[`test_from_str_failures`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_colour.py#L71) +[`test_from_str_failures`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_colour.py#L71) -[commit](https://github.com/tthijm/sep/commit/51a7b35a9b4af8058cc9d513085b02306ae63a43) +[commit](https://github.com/tthijm/sep-1/commit/51a7b35a9b4af8058cc9d513085b02306ae63a43) ![](./assets/parse_rgb_number_before.png) @@ -171,9 +171,9 @@ The coverage has been improved, because the previously there was no test for jso The coverage of the function has improved from the original 78% to 100%, since the other two branches (1 and 3) were also covered. -[`test_from_str_failures`](https://github.com/tthijm/sep/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_colour.py#L71) +[`test_from_str_failures`](https://github.com/tthijm/sep-1/blob/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/tests/test_colour.py#L71) -[commit](https://github.com/tthijm/sep/commit/d5de3d9bd413d9ddab2facc30d57f3016284db57) +[commit](https://github.com/tthijm/sep-1/commit/d5de3d9bd413d9ddab2facc30d57f3016284db57) ![](./assets/from_str_before.png) @@ -195,21 +195,21 @@ The total coverage after adding our own tests #### Thijmen -- Created a custom coverage tool [`cov`](https://github.com/tthijm/sep/tree/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/cov)(https://github.com/tthijm/sep/pull/2) -- Measured and increased the coverage of [`flatten_literal_params`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1087)(https://github.com/tthijm/sep/pull/5) -- Measured and increased the coverage of [`_human_join`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1397)(https://github.com/tthijm/sep/pull/6) +- Created a custom coverage tool [`cov`](https://github.com/tthijm/sep-1/tree/a9bede17cf39fb44b606dc1e1cfdf3bcf4aa4340/cov)(https://github.com/tthijm/sep-1/pull/2) +- Measured and increased the coverage of [`flatten_literal_params`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1087)(https://github.com/tthijm/sep-1/pull/5) +- Measured and increased the coverage of [`_human_join`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L1397)(https://github.com/tthijm/sep-1/pull/6) #### Maurice -- Measured and increased the coverage of [`_string_width`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L824)(https://github.com/tthijm/sep/pull/17) -- Measured and increased the coverage of [`escape_markdown`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L946)(https://github.com/tthijm/sep/pull/17) +- Measured and increased the coverage of [`_string_width`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L824)(https://github.com/tthijm/sep-1/pull/17) +- Measured and increased the coverage of [`escape_markdown`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L946)(https://github.com/tthijm/sep-1/pull/17) #### Yasin -- Measured and increased the coverage of [`_get`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L484) and [`_aget`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L502)(https://github.com/tthijm/sep/pull/11) -- Measured and increased the coverage of [`json_or_text`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/http.py#L106)(https://github.com/tthijm/sep/pull/13) +- Measured and increased the coverage of [`_get`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L484) and [`_aget`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/utils.py#L502)(https://github.com/tthijm/sep-1/pull/11) +- Measured and increased the coverage of [`json_or_text`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/http.py#L106)(https://github.com/tthijm/sep-1/pull/13) #### Frank -- Measured and increased the coverage of [`parse_rgb_number`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L55)(https://github.com/tthijm/sep/pull/8) -- Measured and increased the coverage of [`from_str`](https://github.com/tthijm/sep/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L178)(https://github.com/tthijm/sep/pull/19) +- Measured and increased the coverage of [`parse_rgb_number`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L55)(https://github.com/tthijm/sep-1/pull/8) +- Measured and increased the coverage of [`from_str`](https://github.com/tthijm/sep-1/blob/0e58a927ddbc300a17ef0137d948faa659565313/discord/colour.py#L178)(https://github.com/tthijm/sep-1/pull/19)