Quick code review

[PeterC-DLS]

Some issues from a quick review of the code without examining its semantics or coding style

• names of module should not have suffices such as _class or _functions
• .gitignore should contain common python cache directories and build artifacts (see https://github.com/github/gitignore)
• missing __all__ in __init__.py to declare wildcard imports
• require.txt is superfluous if you declare your dependencies in the project file
• some unused imports and missing annotations
• modern way of writing and running tests is to use pytest
• one test fails (test_edge_cases)

Have you used ruff to check and format it? And mypy or pylance to analyse it?

[DanPorter]

Thanks very much @PeterC-DLS for the code review!

I've created a branch and made the changes you've suggested. The pull request #2 is now available for you to check.

I've primarily used the inbuilt linter/ analysis in PyCharm for the project, but I've checked it against ruff and mypy as well.

Interestingly PyCharm's inbuilt type checking and the mypy plugin show now errors, but if you run mypy directly it still gives a load, although the are pretty insignificant so I've stuck to the built in ones.

[DanPorter]

Merged pull request #2, all issues addressed. Some additional comments addressed in #4