fix/Replace nbqa-ruff with ruff

[Rjchauhan18]

Description

• I have changed .pre-commit-config.yaml file and added ruff.toml for lint the jupyter notebook.

Fixes # (issue)

• This PR fix this issue : Replace nbqa-ruff with ruff #3476

Type of change

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist:

• No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
• All tests pass: $ python run-tests.py --all (or $ nox -s tests)
• The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[agriyakhetarpal]

We should specifically use ruff.toml (docs) instead of pyproject.toml for now, since PyBaMM is not configured to support the pyproject.toml build format yet

[Rjchauhan18]

We should specifically use ruff.toml (docs) instead of pyproject.toml for now, since PyBaMM is not configured to support the pyproject.toml build format yet

Can you please review it again?

[Saransh-cpp]

Suggested change

	[lint]
	ignore = ["E402","E703"]
	[lint.per-file-ignores]
	**.ipynb = ["E402", "E703"]

[Rjchauhan18]

okay it work if we use double quote and then **.ipynb inside it.

[lint.per-file-ignores]
"**.ipynb" = ["E402", "E703"]

[Saransh-cpp]

Can you also move these configs to ruff.toml?

[Rjchauhan18]

how can i do that ?

if using docs i add this to ruff.toml it not works

[agriyakhetarpal]

The documentation for ruff.toml (https://docs.astral.sh/ruff/configuration/#using-rufftoml) mentions "though in the ruff.toml and .ruff.toml versions, the [tool.ruff] header is omitted", which should help

[Rjchauhan18]

test run smoothly but i don't have any effect on code even after i remove E703 from list of ignore.

it means after removing 10th line from pre-commit-config.yaml and improving ruff.toml is not working.

ruff.toml like this and with removed 10th line in pre-commit-config.yaml

[Saransh-cpp]

@Rjchauhan18, it would be easier for us to help you if you push your changes (don't worry about the CI failing once you push it - we can help you fix the CI, but it becomes challenging to help you without looking at your entire changes).

Also, avoid adding screenshots of your logs; instead, copy-paste them into markdown (good practice).

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (618b481) 99.58% compared to head (6cb6347) 99.58%.

❗ Current head 6cb6347 differs from pull request most recent head 5431dec. Consider uploading reports for the commit 5431dec to get more accurate results

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3482   +/-   ##
========================================
  Coverage    99.58%   99.58%           
========================================
  Files          256      256           
  Lines        20048    20048           
========================================
  Hits         19965    19965           
  Misses          83       83           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[agriyakhetarpal]

Note: this PR (like the earlier one as @Saransh-cpp had mentioned) is also from the develop branch of your fork, which is not recommended and would cause issues should you wish to contribute further with subsequent PRs

[Rjchauhan18]

Note: this PR (like the earlier one as @Saransh-cpp had mentioned) is also from the develop branch of your fork, which is not recommended and would cause issues should you wish to contribute further with subsequent PRs

so do you want that i make PR from new branch? and close this one.

[agriyakhetarpal]

Yes. You can cherry-pick the commits that are already here so that you don't lose any progress

[Saransh-cpp]

No need to cherry-pick, you can simply checkout to a new branch, push the changes, and create a new PR -

# changes to a new branch
git checkout -b <my_new_branch_name>   # create and checkout to a new branch (the new branch will automatically get your commits from develop)
git push --set-upstream origin <my_new_branch_name>   # push your branch to your fork
create a pull request from github

# syncing your local develop branch
git remote add upstream https://github.com/pybamm-team/PyBaMM   # will add a new remote from which you'll be able to pull
git fetch --all   # fetches everything from origin (your fork) and upstream (original pybamm repo)
git checkout develop   # go back to develop
git reset --hard upstream/develop   # reset your local develop branch and make it the exact copy of pybamm's develop
git push -f   # force push to sync your fork's develop branch on GitHub with pybamm's develop branch

This might look a bit intimidating at start but you'll get used to the commands as you work more with git 🙂

[agriyakhetarpal]

Closing since #3483 has been opened