Sourcery refactored main branch

[sourcery-ai[bot]]

Branch main refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

• VS Code
• PyCharm

Review changes via command line

To manually merge these changes, make sure you're on the main branch, then run:

git fetch origin sourcery/main
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

[sourcery-ai[bot]]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.20%.

Quality metrics	Before	After	Change
Complexity	15.16 🙂	15.27 🙂	0.11 👎
Method Length	47.40 ⭐	47.27 ⭐	-0.13 👍
Working memory	8.42 🙂	8.56 🙂	0.14 👎
Quality	67.46% 🙂	67.26% 🙂	-0.20% 👎

Other metrics	Before	After	Change
Lines	2680	2706	26

Changed files	Quality Before	Quality After	Quality Change
mkdoxy/cache.py	93.70% ⭐	93.70% ⭐	0.00%
mkdoxy/constants.py	97.26% ⭐	98.46% ⭐	1.20% 👍
mkdoxy/doxygen.py	54.01% 🙂	54.02% 🙂	0.01% 👍
mkdoxy/doxyrun.py	68.31% 🙂	68.38% 🙂	0.07% 👍
mkdoxy/finder.py	74.16% 🙂	70.89% 🙂	-3.27% 👎
mkdoxy/generatorAuto.py	76.76% ⭐	76.71% ⭐	-0.05% 👎
mkdoxy/generatorBase.py	63.81% 🙂	65.78% 🙂	1.97% 👍
mkdoxy/generatorSnippets.py	70.55% 🙂	70.02% 🙂	-0.53% 👎
mkdoxy/markdown.py	92.12% ⭐	92.12% ⭐	0.00%
mkdoxy/node.py	62.64% 🙂	62.20% 🙂	-0.44% 👎
mkdoxy/property.py	82.61% ⭐	82.72% ⭐	0.11% 👍
mkdoxy/utils.py	72.96% 🙂	72.81% 🙂	-0.15% 👎
mkdoxy/xml_parser.py	24.55% ⛔	24.50% ⛔	-0.05% 👎
tests/basic.py	98.67% ⭐	99.17% ⭐	0.50% 👍
tests/doxygenSubprocess.py	82.62% ⭐	82.78% ⭐	0.16% 👍
tests/metaDataParse.py	74.81% 🙂	75.10% ⭐	0.29% 👍
tests/parseMdTags.py	77.57% ⭐	75.83% ⭐	-1.74% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
mkdoxy/xml_parser.py	XmlParser.paras	118 ⛔	1141 ⛔	28 ⛔	1.26% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
mkdoxy/node.py	Node.codeblock	57 ⛔	439 ⛔	15 😞	11.54% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
mkdoxy/node.py	Node._check_for_children	49 ⛔	580 ⛔	10 😞	19.97% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
mkdoxy/node.py	Node.__init__	15 🙂	509 ⛔	17 ⛔	26.14% 😞	Try splitting into smaller methods. Extract out complex expressions
mkdoxy/doxygen.py	Doxygen.__init__	15 🙂	465 ⛔	17 ⛔	26.38% 😞	Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[Jonadabe]

Hi there,

Any reason for not accepting this pull request? Seems clean and nice. :-)

[JakubAndrysek]

Hi, have you tested it? It`s an older project and I am not maintaining it right now.

[JakubAndrysek]

Are you using this API generator for your project? I created it a year ago, bud I didn`t have much time to finish it. If you would like to help me I will appreciate you. Thanks

[Jonadabe]

No, not yet. But was considering to use it.

[JakubAndrysek]

No, not yet. But was considering to use it.

Hi, I have refactored the code and I have also created an extra example repo.