1792 Add docstrings to upgrade.py

[arjxn-py]

Should fix #1792

This PR adds file-level documentation strings for upgrade.py

What does this implement/fix?

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds a feature)
• Breaking change (fix or feature that would cause existing features not to work as expected)
• Documentation Update
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no API changes)
• Build related changes
• Other (please describe):

Testing

• Did you test the pull request locally?
• Did you add new tests?

[viniciusdc]

Looking great, we will be reviewing this during the week, we're in the process of releasing, so if this does not enter in this current release, it will be in the next 🚀

[dcmcand]

Hi @arjxn-py, thanks so much for your contribution. There are some minor style changes needed, but once that is done, we can get this merged!

[arjxn-py]

Thanks for the constructive review @dcmcand, i've made the suggested changes, hope I interpreted it correctly.
I'd like to know how can i run pre-commit hook correctly locally before committing my changes.
I'm doing pre-commit run which is returning me -

fix end of files.....................................(no files to check)Skipped
trim trailing whitespace.............................(no files to check)Skipped
check json...........................................(no files to check)Skipped
check yaml...........................................(no files to check)Skipped
check toml...........................................(no files to check)Skipped
check that executables have shebangs.................(no files to check)Skipped
codespell............................................(no files to check)Skipped
black................................................(no files to check)Skipped
ruff.................................................(no files to check)Skipped
isort................................................(no files to check)Skipped
Terraform fmt........................................(no files to check)Skipped

[arjxn-py]

In addition to that, I see that python==3.10 & python==3.11 tests are failing because the @override decorator is actually available in the typing module starting from Python 3.12. See also - https://docs.python.org/3/whatsnew/3.12.html#pep-698-override-decorator-for-static-typing

So should I use typing_extensions instead?

[dcmcand]

In addition to that, I see that python==3.10 & python==3.11 tests are failing because the @override decorator is actually available in the typing module starting from Python 3.12. See also - https://docs.python.org/3/whatsnew/3.12.html#pep-698-override-decorator-for-static-typing

So should I use typing_extensions instead?

ah, good catch, yes, use typing_extensions

[dcmcand]

Thanks for the constructive review @dcmcand, i've made the suggested changes, hope I interpreted it correctly. I'd like to know how can i run pre-commit hook correctly locally before committing my changes. I'm doing pre-commit run which is returning me -

fix end of files.....................................(no files to check)Skipped
trim trailing whitespace.............................(no files to check)Skipped
check json...........................................(no files to check)Skipped
check yaml...........................................(no files to check)Skipped
check toml...........................................(no files to check)Skipped
check that executables have shebangs.................(no files to check)Skipped
codespell............................................(no files to check)Skipped
black................................................(no files to check)Skipped
ruff.................................................(no files to check)Skipped
isort................................................(no files to check)Skipped
Terraform fmt........................................(no files to check)Skipped

You should be able to run it. Use pre-commit run --all-files

[arjxn-py]

You should be able to run it. Use pre-commit run --all-files

Yes, thanks it works 🚀

[arjxn-py]

Oh Conda build failing, I just noticed that conda has the latest release of version 4.11.0 for typing_extensions, on it to fix it.
Edit: Done.

[dcmcand]

Thanks for the quality contribution @arjxn-py 🚀