Linting and formatting, semi-lax. #172
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- `tox` now runs `black` and `ruff` on the project (the environment is called `lint`). - tox runs `ruff` with --fix to resolve fixable issues. - There is no pre-commit hook or CI integration as of yet. ### Code changes To adhere to even semi-lax linting, there were changes required in the code. These are: - Migrated use of python builtin identifiers (`type`, `id`, and `print`) to more appropriate names. - Some cases of long string literals were using implicit concatenation, which is now explicit (by adding a set of parentheses). ### Outstanding changes with current settings - `print` in history.py (shadowing builtin) was not fixed as it needs a bit more debugging to figure out exactly how it is used. ### Notes There is still a lot to do with regards to linting, formatting, and typing. This PR does not seek to resolve these issues, but attempts to create a baseline of requirements for the codebase to adhere to.
- In the future it would probably be a good idea to integreate `ci/run_testsuite_and_record.sh` into the tox setup.
oyvindhagberg
approved these changes
Oct 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial linting and formatting adherence
toxnow runsblackandruffon the project (the environment is calledlint).ruffwith --fix to resolve fixable issues.Code changes
To adhere to even semi-lax linting, there were changes required in the code. These are:
type,id, andprint) to more appropriate names.# noqa: F401following the import will be removed by ruff.except Exceptionrewritten to explicit exceptions) and cases where exceptions within exceptions did not specify if one was to include the previous exception or not (usefromeither from the previous exception orNoneexplicitly).Outstanding changes with current settings
printin history.py (shadowing builtin) was not fixed as it needs a bit more debugging to figure out exactly how it is used.Notes
There is still a lot to do with regards to linting, formatting, and typing. This PR does not seek to resolve these issues, but attempts to create a baseline of requirements for the codebase to adhere to.