Add Ruff linter/formatter

[evanderiel]

Adds Ruff configuration and does initial reformatting for all files.

If you want to run Ruff on the codebase, it's

ruff check aana

You can automatically fix some issues with the --fix and --unsafe-fixes options. (Be sure to install the dev dependencies: poetry install --with=dev. )

To run the auto-formatter, it's

ruff format aana

If you want to enable this as a local pre-commit hook, additionally run the following:

git config core.hooksPath .githooks

You can also simply run .githooks/pre-commit manually if you prefer.

A Github Action for the same thing to run as a hook isn't present yet due to problems I've run into getting poetry to work correctly.

[HRashidi]

Currently I got a error related to the poetry lock. Do we need to update the lock on the repo each times (as you added the rufff) or we can add it to gitignore!>

[HRashidi]

ruff throw errors for using assert inside the utils. Should it be deactivated or maybe change the the assert to use the value_error instead

[movchan74]

I suggest we add ruff extension as recommendations to .vscode/extensions.json and add it to the devcontainer.json.

[movchan74]

Looks good. I added few suggestions.

And I think these issues need to be fixed before merge:

1. What you mentioned in the PR description should be added to the README.
2. devcontainer needs to run poetry install with --with=dev. Maybe add pre-commit hooks too.
3. There is one issue reported by ruff: aana/tests/utils.py:32:5: S101 Use of assert detected

[evanderiel]

Currently I got a error related to the poetry lock. Do we need to update the lock on the repo each times (as you added the rufff) or we can add it to gitignore!>

Poetry guidelines say to include the lock file in source control, but it seems like it's causing more trouble than it's worth at the moment. @movchan74 what do you think? Should we .gitignore it for now until we can figure out what's making it cause problems?

[movchan74]

Currently I got a error related to the poetry lock. Do we need to update the lock on the repo each times (as you added the rufff) or we can add it to gitignore!>

Poetry guidelines say to include the lock file in source control, but it seems like it's causing more trouble than it's worth at the moment. @movchan74 what do you think? Should we .gitignore it for now until we can figure out what's making it cause problems?

I'm not sure. Sometimes it helps, sometimes it creates problems. For example, it was useful when onnx-runtime updated the package but didn't release all wheels so poetry install was failing. So it is useful for reproducibility, but we have to make sure we keep it up-to-date. I would keep it.

[evanderiel]

1. What you mentioned in the PR description should be added to the README.
   Done.

2. devcontainer needs to run poetry install with --with=dev. Maybe add pre-commit hooks too.

Can I just add this to install.sh? Or does it need to done differently? I've never used dev containers.

3. There is one issue reported by ruff: aana/tests/utils.py:32:5: S101 Use of assert detected

Fixed.

[movchan74]

1. What you mentioned in the PR description should be added to the README.
   Done.

2. devcontainer needs to run poetry install with --with=dev. Maybe add pre-commit hooks too.

Can I just add this to install.sh? Or does it need to done differently? I've never used dev containers.

3. There is one issue reported by ruff: aana/tests/utils.py:32:5: S101 Use of assert detected

Fixed.

install.sh is also used in Dockerfile for a "production" image. So we probably need a flag for install.sh to set it to dev.