Switch linting to Ruff #3710

akx · 2023-03-30T11:38:51Z

Description

This PR switches the linting + import formatting for Gradio from flake8 + isort to Ruff.

Ruff is a lot faster than flake8 and isort, and also catches more errors; see some of the fixes done here, and I didn't even configure any additional lint rules.

Please see each individual commit and commit message for further detail.

gradio-pr-bot · 2023-03-30T15:00:02Z

🎉 The demo notebooks match the run.py files! 🎉

gradio-pr-bot · 2023-03-30T15:02:45Z

All the demos for this PR have been deployed at https://huggingface.co/spaces/gradio-pr-deploys/pr-3710-all-demos

abidlabs · 2023-03-30T23:47:04Z

Thanks @akx for initiating this PR. Let me discuss with the other maintainers of this repo if we'd like to make this change. Just FYI we prefer if contributors raise major changes as issue so we can discuss there before opening a PR directly.

freddyaboulton · 2023-03-31T16:53:31Z

pyproject.toml

+]
+
+[tool.ruff.per-file-ignores]
+"demo/*" = [


In my opinion, it's fine if we don't lint the demo files

freddyaboulton · 2023-03-31T16:54:47Z

website/check_version.py

@@ -1,8 +1,7 @@
-import time


Also fine if we don't lint the website

scripts/lint_backend.sh

abidlabs · 2023-03-31T22:45:59Z

Agree with @freddyaboulton's suggestion about not linting the demos. Because the demos are code that we embed in our documentation and guides, there are times when we don't want to be following pep8 standards, e.g. because it might add too much whitespace. For the website, I don't know, maybe we should actually be linting it -- it might help us catch bugs. WDYT @freddyaboulton @aliabd?

akx · 2023-04-03T13:47:36Z

there are times when we don't want to be following pep8 standards, e.g. because it might add too much whitespace.

ruff doesn't do formatting (yet), just linting. If you look at the changes enacted for the demos, they're pretty much just removals of unused imports and variables.

freddyaboulton

Thanks @akx ! This looks good to me - just left some minor comments. @abidlabs Any further thoughts before merging?

gradio/__init__.py

freddyaboulton · 2023-04-03T18:23:22Z

gradio/components.py

@@ -3073,7 +3063,6 @@ def update(
            "interactive": interactive,
            "visible": visible,
            "value": value,
-            "interactive": interactive,


Lol nice catch by ruff

freddyaboulton · 2023-04-03T18:28:50Z

pyproject.toml

+  "F405", # Demos may use star imports
+  "I", # Don't care about import order
+]
+"gradio/__init__.py" = [


We can get rid of this since you already added __all__ right?

Nope - that was a different module (client/python/gradio_client/__init__.py).

I felt like adding about 80 __all__ entries would've been a bigger change that can be done separately. 😁

freddyaboulton

Thanks for the contribution @akx ! This looks good to me. Will leave open in case @abidlabs wants to make any further comments. Should be good to merge shortly

abidlabs · 2023-04-03T22:05:33Z

test/test_examples.py

-            trimmed_words = []
-            for w, l in zip(words, lens):
-                trimmed_words.append(w[:l])


Was this caught by ruff or did you change manually @akx?

ruff was complaining about l being an ambiguous name, so while renaming, I fixed these up to the equivalent listcomp.

abidlabs · 2023-04-03T22:12:20Z

LGTM as well. It looks like ruff is catching some additional things that are good to fix. I'm curious if there are things that ruff is missing that would be caught by isort/flake? I don't think anything major and it looks like the other HF libraries are moving towards ruff as well, so I'm in favor of making this change

In terms of whether we should ruff:

the demos: I was initially concerned about whitespace but this doesn't seem to have been affected, while other unnecessary imports seem to have removed so it looks like a positive change
the website: Let's just make sure @aliabd, @aliabid94, and anyone else who works on the website is aware that now they'll have to run format_backend.sh to ensure that the website python files are linted

abidlabs · 2023-04-03T22:48:10Z

Merging now, thanks for this nice PR @akx!

akx · 2023-04-04T07:10:34Z

they'll have to run format_backend.sh to ensure that the website python files are linted

I could follow up with a PR that switches the formatting/linting from those scripts to pre-commit, if that helps :)

* Sort requirements.in * Switch flake8 + isort to ruff * Apply ruff import order fixes * Fix ruff complaints in demo/ * Fix ruff complaints in test/ * Use `x is not y`, not `not x is y` * Remove unused listdir from website generator * Clean up duplicate dict keys * Add changelog entry * Clean up unused imports (except in gradio/__init__.py) * add space --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co>

* update gallery styles * Set theme name from load (#3595) * Add name + test * Add theme names * CHANGELOG * Delete theme in interface * Trigger event when Slider number input is released (#3589) * Add event * Add unit test * CHANGELOG * Sets up the Python `gradio` client (#3300) * placeholder * changelog * added to readme * client * implement futures * utils * scripts * lint * reorg * scripts * serialization * cleanup * fns * serialize * cache * callbacks * updates * formatting * packaging * requirements * remove changelog * client * access token * formatting * deprecate * format backend * client replace * updates * moving from utils * remove code duplication * rm duplicates * simplify * galleryserializer * serializable * load serializers * fixing errors * errors * typing * tests * changelog * lint * fix lint * fixing files * formatting * type * fix type checking * changelog * changelog * Update client/python/gradio_client/client.py Co-authored-by: Lucain <lucainp@gmail.com> * formatting, tests * formatting, tests * gr.load * refactoring * refactoring' * formatting * formatting * tests * tests * fix tests * cleanup * added tests * adding scripts * formatting * address review comments * readme * serialize info * remove from changelog * version 0.0.2 released * lint * type fix * check * type issues * hf_token * update hf token * telemetry * docs, circle dependency * hf token * formatting * updates * sort * script * external * docs * formatting * fixes * scripts * requirements * fix tests * context * changes * formatting * fixes * format fix --------- Co-authored-by: Lucain <lucainp@gmail.com> * Translate "or" for i18n (#3599) * Translate or for i18n * CHANGELOG * Fixes Blocks exit issue (#3600) * fix * changelog * blocks * formatting * Use gradio-api-server for telemetry (#3488) * analytics * changelog * remove interface analytics * ip * remove import * format * theme name * theme analytics * format * changelog * fixes * format * remove unused param --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Simplify tests (#3608) * simplify tests * imports * imports * formatting * removed cometml typing * simplify * changelog * fix wc error in dev mode (#3572) Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * A few small fixes to docs / demos (#3611) * fixes * remove binaries * doc * changelog * typing * run on windows * cancels * added clarifications * Add docs for HF Json saver (#3604) * Add docs for flagging * Fix params * CHANGELOG --------- Co-authored-by: freddyaboulton <alfonsoboulton@gmail.com> * ensure css loads before mounting app (#3573) * ensure css loads before mounting app * changelog * fix tests * change? * changelog * fix issue with missing version (#3632) Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Fixes chatbot autoscroll + Textbox lines > 20 issue (#3637) * fixes * changelog * Update gradio/components.py Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix embedded demos (#3638) Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Add Windows CI (#3628) * Add Windows CI * Update changelog * fix * Skip one test on Windows * Preserve virtualenv path * Skip another test on Windows * Make conditional flaky * Requested changes * consistent os * cleanup * fix test for windows * remove unnecessary check * lint * lint --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * move files (#3605) * move files * commit the rest of the files * fix lockfile * fix workflow * fix type errors * fix tests * only run ci when certain files change * run correct test command in ci * version * fix pypi script --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Support empty lists being used in `gr.Dataframe` (#3646) * Support empty lists being used in `gr.Dataframe` * Update changelog * Add empty dataframe test --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix windows flake (#3650) * fix windows flake * format backend --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Raise errror if event queued but queue is not enabled (#3640) * Raise Error * CHANGELOG * Add progress tracking validate_queue_settings * Update gradio/blocks.py Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix test --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Copy everything in website Dockerfile, fix build issues (#3659) * dockerfile * copy everything from repo * correct dir * changelog * Correct the documentation of `gr.File` component (#3660) This closes #3658. Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Nit in ValueError (#3669) * Nit in ValueError * CHANGELOG --------- Co-authored-by: freddyaboulton <alfonsoboulton@gmail.com> * Load upstream theme (#3641) * theme loading * upstream theme * version * format themes * fixes * tests * one more test * fix test * address review * Add job for python client ci (#3674) * Add job + lint * Fix path * Fix path * Fix path * Checkout * Add test requirements * Fix syntax * Fix test * Lint * Fix deps + README * Move dependency * Hide dropdown if in single-select mode (#3678) * Hide dropdown if in single-select mode * Update changelog --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix default parameters value and gr.Progress in same function (#3671) * Fix default parameters value and gr.Progress in same function * Update changelog * Fix tests * Format * Expand tests for other types of special function arguments * Augment SelectData tests --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * warning * changelog * ghangelog * changelog * object fit optional * Add status for Python Client Jobs (#3645) * Add status + unit test (flaky) for now * Install client * Fix tests * Lint backend + tests * Add non-queue test * Fix name * Use lock instead * Add simplify implementation + fix tests * Restore changes to scripts * Fix README typo * Fix CI * Add two concurrent test * Fix broken spaces in docs (#3698) * fix examples in sentence_builder * fix sklearn error in titanic demo * regenerate notebooks * changelgo * Add download button for video (#3581) * Add download buttom * Add missing imports * CHANGELOG * Update CHANGELOG.md * Trigger CI * Fix visibility * Try to fix ci * Fix deps * download button change * Lint --------- Co-authored-by: Dawood <dawoodkhan82@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix outdated sharing your app guide (#3699) * fix embed this space screenshot * fix use via api * changelog --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Add orig_name field to video outputs (#3700) * Add orig_name to video * Fix test * CHANGELOG * Lint * Theme builder (#3664) * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * Update CHANGELOG.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update gradio/themes/builder.py Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * fix dropdowns, release 3.24 (#3713) * changes * changes * Update version.txt * New Version Docs (#3715) * [create-pull-request] automated change * fix changelog --------- Co-authored-by: abidlabs <abidlabs@users.noreply.github.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix chatbot newline issue (#3717) * changes * changes * changes * changelog --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * New Version Docs (#3720) * [create-pull-request] automated change * Trigger Build --------- Co-authored-by: aliabd <aliabd@users.noreply.github.com> Co-authored-by: aliabd <ali.si3luwa@gmail.com> * Fix Serializer Mapping (#3722) * Fix mapping and test * Bump gradio version * Revert gradio version bump * Fix some bugs related to Python client (#3721) * client format * docs * formatting * fix tests * fixed bug * api endpoint changes * fix tests * fix tests * formatting * Add support for sessions [python client] (#3731) * client * add state and tests * remove session param * node support for js client (#3692) * bundle js client + gen types * changeset * changeset * fix bugs * fix deps * fix deps * format * fix ci * fix types * Support IPv6 addresses for --server-name (#3695) * Support IPv6 addresses for --server-name * Update changelog now that I have a PR number. --------- Co-authored-by: freddyaboulton <alfonsoboulton@gmail.com> * Increase timeout for analytics request + remove exception print (#3647) * increase timeout * merge * Add changelog --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Switch linting to Ruff (#3710) * Sort requirements.in * Switch flake8 + isort to ruff * Apply ruff import order fixes * Fix ruff complaints in demo/ * Fix ruff complaints in test/ * Use `x is not y`, not `not x is y` * Remove unused listdir from website generator * Clean up duplicate dict keys * Add changelog entry * Clean up unused imports (except in gradio/__init__.py) * add space --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix missing docstrings (new PR) (#3740) * Move documentation for _js into docstring, not a stray comment * Add missing argument docstrings (and remove non-existent ones) * Add changelog entry * updated docstrings * changelog * contributors * changelog * formatting * removed _js --------- Co-authored-by: Aarni Koskela <akx@iki.fi> * import (#3742) * Import Literal from typing extensions in client (#3741) * Fix typing extensions * Import typing_extensions --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Access http token for ws connection (#3735) * Access unsecure token * CHANGELOG --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Add root_url to serializers in gradio_client (#3736) * Add root_url to serializers * Add url fix * Respect fn parameter * Fix docstring * Add other test * Pass to method * CI tweaks (#3752) * Adds a pypi release action for the gradio python client (#3743) * release action * fixes * name * Update version.txt * Update version.txt * update * fixes * version * rename * action * fix token * custom dir * fixes * change password * revert back to token * scripts * remove twine * Get Intermediate Results from Python Client (#3694) * Add status + unit test (flaky) for now * Install client * Fix tests * Lint backend + tests * Add non-queue test * Fix name * Use lock instead * Add simplify implementation + fix tests * Restore changes to scripts * Fix README typo * Fix CI * Add intermediate results to python client * Type check * Typecheck again * Catch exception: * Thinking * Dont read generator from config * add no queue test * Remove unused method * Fix types * Remove breakpoint * Fix code * Fix test * Fix tests * Unpack list * Add docstring --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * changes (#3760) * Make Client Jobs Iterable (#3762) * Add iterator * Break if done * Add test for early termination * changelog * notebooks --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: Lucain <lucainp@gmail.com> Co-authored-by: pngwn <hello@pngwn.io> Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> Co-authored-by: Ali Abdalla <ali.si3luwa@gmail.com> Co-authored-by: space-nuko <24979496+space-nuko@users.noreply.github.com> Co-authored-by: Luo Peng <luopeng.he@gmail.com> Co-authored-by: aliabid94 <aabid94@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: abidlabs <abidlabs@users.noreply.github.com> Co-authored-by: aliabd <aliabd@users.noreply.github.com> Co-authored-by: Dan Sully <dan+github@sully.org> Co-authored-by: Aarni Koskela <akx@iki.fi>

Sort requirements.in

a569095

akx marked this pull request as ready for review March 30, 2023 11:39

akx force-pushed the ruff branch from 4ea8661 to 787780e Compare March 30, 2023 11:41

akx added 2 commits March 30, 2023 14:50

Switch flake8 + isort to ruff

f446aa3

Apply ruff import order fixes

95861de

akx force-pushed the ruff branch from a19e9dd to 9e22be0 Compare March 30, 2023 11:50

akx added 7 commits March 30, 2023 18:07

Fix ruff complaints in demo/

de5f052

Fix ruff complaints in test/

d8734ba

Use x is not y, not not x is y

c371cb2

Remove unused listdir from website generator

9412a4f

Clean up duplicate dict keys

62b160e

Add changelog entry

4328af3

Clean up unused imports (except in gradio/__init__.py)

068cc2e

akx force-pushed the ruff branch from 9e22be0 to 068cc2e Compare March 30, 2023 15:07

akx and others added 2 commits March 31, 2023 09:38

Merge branch 'main' into ruff

879a6b2

Merge branch 'main' into ruff

ddcea43

freddyaboulton reviewed Mar 31, 2023

View reviewed changes

pyproject.toml

]

[tool.ruff.per-file-ignores]

"demo/*" = [

Copy link

Collaborator

freddyaboulton Mar 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, it's fine if we don't lint the demo files

freddyaboulton reviewed Mar 31, 2023

View reviewed changes

website/check_version.py

@@ -1,8 +1,7 @@

import time

Copy link

Collaborator

freddyaboulton Mar 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also fine if we don't lint the website

freddyaboulton reviewed Mar 31, 2023

View reviewed changes

scripts/lint_backend.sh Show resolved Hide resolved

freddyaboulton reviewed Apr 3, 2023

View reviewed changes

freddyaboulton approved these changes Apr 3, 2023

View reviewed changes

abidlabs added 2 commits April 3, 2023 16:52

Merge branch 'main' into ruff

cc41bfe

add space

ae089eb

abidlabs reviewed Apr 3, 2023

View reviewed changes

abidlabs merged commit ef3862e into gradio-app:main Apr 3, 2023

akx mentioned this pull request Apr 26, 2023

Ruff update + strictening #3979

Merged

7 tasks

akx mentioned this pull request May 9, 2023

Replace pylint CI with ruff AUTOMATIC1111/stable-diffusion-webui#10233

Merged

akx deleted the ruff branch June 27, 2023 10:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch linting to Ruff #3710

Switch linting to Ruff #3710

akx commented Mar 30, 2023 •

edited

Loading

gradio-pr-bot commented Mar 30, 2023 •

edited

Loading

gradio-pr-bot commented Mar 30, 2023

abidlabs commented Mar 30, 2023

freddyaboulton Mar 31, 2023

freddyaboulton Mar 31, 2023

abidlabs commented Mar 31, 2023

akx commented Apr 3, 2023

freddyaboulton left a comment

freddyaboulton Apr 3, 2023

freddyaboulton Apr 3, 2023

akx Apr 3, 2023

freddyaboulton left a comment

abidlabs Apr 3, 2023

akx Apr 4, 2023

abidlabs commented Apr 3, 2023

abidlabs commented Apr 3, 2023

akx commented Apr 4, 2023

Switch linting to Ruff #3710

Switch linting to Ruff #3710

Conversation

akx commented Mar 30, 2023 • edited Loading

Description

gradio-pr-bot commented Mar 30, 2023 • edited Loading

gradio-pr-bot commented Mar 30, 2023

abidlabs commented Mar 30, 2023

freddyaboulton Mar 31, 2023

Choose a reason for hiding this comment

freddyaboulton Mar 31, 2023

Choose a reason for hiding this comment

abidlabs commented Mar 31, 2023

akx commented Apr 3, 2023

freddyaboulton left a comment

Choose a reason for hiding this comment

freddyaboulton Apr 3, 2023

Choose a reason for hiding this comment

freddyaboulton Apr 3, 2023

Choose a reason for hiding this comment

akx Apr 3, 2023

Choose a reason for hiding this comment

freddyaboulton left a comment

Choose a reason for hiding this comment

abidlabs Apr 3, 2023

Choose a reason for hiding this comment

akx Apr 4, 2023

Choose a reason for hiding this comment

abidlabs commented Apr 3, 2023

abidlabs commented Apr 3, 2023

akx commented Apr 4, 2023

akx commented Mar 30, 2023 •

edited

Loading

gradio-pr-bot commented Mar 30, 2023 •

edited

Loading