switch to ruff #5218

gvwilson · 2025-06-05T13:48:38Z

This PR converts linting and formatting from black to ruff.

Remove requires-optional.txt (no longer used, version conflict was confusing).
Convert commands.py to use argparse instead of hand-rolled.
Rationalize imports in codegen/__init__.py (all at top level).
Update "dev" section of pyproject.toml to using ruff instead of black.
- And to install inflect and requests.
Add uv.lock file used by uv.
Modify code reformatting in codegen/__init__.py to use ruff instead of black.
Add new function to use ruff to reformat existing code (run python commands.py format).
Add new function to use ruff to check code (run python commands.py lint).

TODO:

This PR does not reformat generated code, tests, or utilities: that, and cleaning up all the problems identified by ruff, will be done once this PR is approved.
This PR currently fails the build because Circle CI is expecting requires-optional.txt, which this PR removes. We need to decide if we're leaving build on Circle CI or moving it to GitHub.

pyproject.toml

codegen/__init__.py

emilykl · 2025-06-05T15:04:02Z

@gvwilson big picture comments --

I have a STRONG preference for also committing the ruff-formatted files as part of this PR. (To avoid cluttering up this PR, the formatting changes themselves could be done on a separate branch which branches off of this one.) But if we don't do the actual formatting step as part of this PR, we'll miss issues and then have to fix them later once this is on main.
The CONTRIBUTING.md needs to be updated to remove references to requires-optional.txt, and it needs some general updates as well. I'd be happy to work on that.
Could we add the uv.lock in a separate PR? I'm not opposed, but CONTRIBUTING.md needs to be updated to explain how to use the lockfile in development, otherwise things will get messy.

- Switch to `argparse` and clean up imports in `commands.py`. - Remove `requires-optional.txt` and `test_requirements/*` (put dependencies in `pyproject.toml` instead). - Remove `black` and use `ruff` instead. - Add `--noformat` option to `python commands.py codegen` for experimenting. - Pass output directory around to control what is formatted and linted. - Add `python commands.py format` to only do formatting. - Add `python commands.py lint` to check code. - Reformat comments in `codegen/*.py`. - Use double-quoted strings for (most) code generation. - Update various GitHub templates. - Update CONTRIBUTING.md to reflect switch from black to ruff: - Reorganize sections. - Rewrite chunks of prose. - Replace mentions of `black` with mentions of `ruff`. - And describe `uv` usage. Note: 1. Only the generated code is formatted and linted: - `plotly/validators/**/*.py` - `plotly/graph_objs/**/*.py` - `plotly/graph_objects/__init__.py` 2. The strings in the data used by code generation are (for example) `"'some_name'"` (i.e., have embedded single quotes). This PR does not try to fix that: instead, we rely on reformatting to turn all the single-quoted strings into double-quoted strings. 3. `CONTRIBUTING.md` refers to `pre-commit` and the old `requires-optional.txt` installed it, but there isn't a `.pre-commit-config.yaml` file in this repository. Wuzzup?

emilykl · 2025-06-06T19:16:59Z

pyproject.toml

+    "geopandas",
+    "inflect",
+    "jupyter",
+    "kaleido==1.0.0rc15",


Suggested change

"kaleido==1.0.0rc15",

"plotly[kaleido]",

emilykl · 2025-06-06T19:30:36Z

CONTRIBUTING.md

- other pure-Python submodules are: `plotly.io` (low-level interface for
-  displaying, reading and writing figures), `plotly.subplots` (helper function
-  for layout of multi-plot figures)
+-   Tests are found in `plotly/tests`.


Suggested change

- Tests are found in `plotly/tests`.

- Tests are found in `tests/`.

emilykl · 2025-06-06T19:32:12Z

CONTRIBUTING.md

+-   The documentation is in this repository,
+    and its structure is described in [its README file](doc/README.md).


Suggested change

- The documentation is in this repository,

and its structure is described in [its README file](doc/README.md).

- Documentation is found in `doc/`, and its structure is described in [its README file](doc/README.md).

emilykl · 2025-06-06T19:32:30Z

CONTRIBUTING.md

-  https://github.com/plotly/plotly.py/issues/1965. If you have writing skills,
-  the wording of existing examples can also be improved in places.
+Code and documentation are not the only way to contribute:
+you can also hepl the project by:


Suggested change

you can also hepl the project by:

you can also help the project by:

emilykl · 2025-06-06T19:32:56Z

CONTRIBUTING.md


- reporting bugs (see below).
+-   Submitting feature request (also at <https://github.com/plotly/plotly.py/issues>).


Suggested change

- Submitting feature request (also at <https://github.com/plotly/plotly.py/issues>).

- Submitting a feature request (also at <https://github.com/plotly/plotly.py/issues>).

emilykl · 2025-06-06T19:33:44Z

CONTRIBUTING.md

-## Have a Bug Report?
+This section explains how to set up a development environment so that you can contribute code and/or tests.
+Note that if you are modifying a single documentation page,
+you can do it directly on Github by clicking on the "Edit this page on GitHub" link without cloning the repository.


Suggested change

you can do it directly on Github by clicking on the "Edit this page on GitHub" link without cloning the repository.

you can do it directly on GitHub by clicking on the "Edit this page on GitHub" link without cloning the repository.

emilykl · 2025-06-06T19:34:23Z

CONTRIBUTING.md

-## Have Questions about Plotly?
+We use Git and GitHub to manage our project;
+if you are not familiar with them,
+there are great resources like <http://try.github.io/> to get your started.


Suggested change

there are great resources like <http://try.github.io/> to get your started.

there are great resources like <http://try.github.io/> to get you started.

emilykl · 2025-06-06T19:38:37Z

CONTRIBUTING.md

-```bash
-(plotly_dev) $ pip install -e .
-```
+This command also creates an *editable install* of plotly.py


Suggested change

This command also creates an *editable install* of plotly.py

If using `conda` or `virtualenv`, you can install all packages with:

```bash

pip install -e '.[dev]'

```

These commands creates an *editable install* of plotly.py

emilykl · 2025-06-06T19:43:52Z

CONTRIBUTING.md

+This repo uses [ruff](https://astral.sh/ruff) to format Python code consistently
+and the [pre-commit](https://pre-commit.com/) library to manage a Git commit hook to run ruff prior to each commit.
+Both pre-commit and ruff are included in `pyproject.toml`,
+so you should have them installed already if you've been following along.


We are not using pre-commit hooks currently

Suggested change

This repo uses [ruff](https://astral.sh/ruff) to format Python code consistently

and the [pre-commit](https://pre-commit.com/) library to manage a Git commit hook to run ruff prior to each commit.

Both pre-commit and ruff are included in `pyproject.toml`,

so you should have them installed already if you've been following along.

This repo uses [ruff](https://astral.sh/ruff) to format Python code consistently. Ruff is included in the `plotly[dev]` install, so you should have it installed already if you've been following along.

emilykl · 2025-06-06T20:06:12Z

CONTRIBUTING.md

+To enable the ruff formatting Git hook,
+run this command in your virtual environment:

 ```bash
-(plotly_dev) $ pre-commit install
+pre-commit install
 ```

-Now, whenever you perform a commit, the Black formatter will run.  If the formatter
-makes no changes, then the commit will proceed.  But if the formatter does make changes,
-then the commit will abort.  To proceed, stage the files that the formatter
-modified and commit again.
+ruff will now run automatically whenever you perform a commit.
+The commit will proceed if the formatter makes no changes,
+but will be aborted if it does.
+To proceed,
+add the files that the formatter modified and commit again.

-If you don't want to use `pre-commit`, then you can run black manually prior to making
-a PR as follows.
+If you don't want to use `pre-commit`,
+you can run ruff manually prior to making a PR with:

 ```bash
-(plotly_dev) $ black .
+ruff check .
 ```


Remove this section -- we're not currently using pre-commit hooks in the dev process, and the pre-commit install command fails because pre-commit is not in the dev requirements

emilykl · 2025-06-06T20:12:49Z

CONTRIBUTING.md


 ```bash
-$ python commands.py updateplotlyjs
+pytest tests


Suggested change

pytest tests

python -m pytest tests

emilykl · 2025-06-06T20:13:05Z

CONTRIBUTING.md

 ```bash
-python commands.py updateplotlyjsdev --devrepo reponame --devbranch branchname
+pytest tests/test_plotly/test_plot.py


Suggested change

pytest tests/test_plotly/test_plot.py

python -m pytest tests/test_plotly/test_plot.py

emilykl · 2025-06-06T20:16:45Z

CONTRIBUTING.md


-```bash
-# In your plotly.js/ directory, prepare the package:
+### Generating the JavaScript Bundle


Suggested change

### Generating the JavaScript Bundle

### Generating the JavaScript Bundles for Jupyter

emilykl · 2025-06-06T20:18:30Z

CONTRIBUTING.md

-$ npm pack
-$ mv plotly.js-*.tgz plotly.js.tgz
+To test `go.FigureWidget` locally, you'll need to generate the JavaScript bundle as follows:

-# In your plotly.py/ directory:
-$ python commands.py updateplotlyjsdev --local /path/to/your/plotly.js/
+```
+cd js
+npm install && npm run build
 ```


emilykl · 2025-06-06T20:19:49Z

CONTRIBUTING.md

-```bash
-pytest -v tests/
-```
+### CircleCI Release


Suggested change

### CircleCI Release

### Using a development branch of Plotly.js

emilykl · 2025-06-06T21:25:07Z

pyproject.toml

+    "numpy",
+    "pandas",


Suggested change

"numpy",

"pandas",

"numpy",

"orjson",

"pandas",

gvwilson requested a review from emilykl June 5, 2025 13:48

emilykl reviewed Jun 5, 2025

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

emilykl reviewed Jun 5, 2025

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

emilykl reviewed Jun 5, 2025

View reviewed changes

codegen/__init__.py Outdated Show resolved Hide resolved

gvwilson force-pushed the switch-to-ruff branch 3 times, most recently from 8bb233e to 6999c5d Compare June 6, 2025 12:53

gvwilson force-pushed the switch-to-ruff branch from af41d30 to 9c60129 Compare June 6, 2025 16:23

emilykl reviewed Jun 6, 2025

View reviewed changes

CONTRIBUTING.md

```bash

$ python commands.py updateplotlyjs

pytest tests

Copy link

Contributor

emilykl Jun 6, 2025

Choose a reason for hiding this comment

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

Suggested change

pytest tests

python -m pytest tests

emilykl reviewed Jun 6, 2025

View reviewed changes

	- Tests are found in `plotly/tests`.
	- Tests are found in `tests/`.

		- The documentation is in this repository,
		and its structure is described in [its README file](doc/README.md).

	- The documentation is in this repository,
	and its structure is described in [its README file](doc/README.md).
	- Documentation is found in `doc/`, and its structure is described in [its README file](doc/README.md).

	you can also hepl the project by:
	you can also help the project by:


		- reporting bugs (see below).
		- Submitting feature request (also at <https://github.com/plotly/plotly.py/issues>).

	- Submitting feature request (also at <https://github.com/plotly/plotly.py/issues>).
	- Submitting a feature request (also at <https://github.com/plotly/plotly.py/issues>).

	you can do it directly on Github by clicking on the "Edit this page on GitHub" link without cloning the repository.
	you can do it directly on GitHub by clicking on the "Edit this page on GitHub" link without cloning the repository.

	there are great resources like <http://try.github.io/> to get your started.
	there are great resources like <http://try.github.io/> to get you started.

-This command also creates an *editable install* of plotly.py
+If using `conda` or `virtualenv`, you can install all packages with:
+```bash
+pip install -e '.[dev]'
+```
+These commands creates an *editable install* of plotly.py

	pytest tests/test_plotly/test_plot.py
	python -m pytest tests/test_plotly/test_plot.py

	### Generating the JavaScript Bundle
	### Generating the JavaScript Bundles for Jupyter

	### CircleCI Release
	### Using a development branch of Plotly.js

Uh oh!

switch to ruff #5218

Are you sure you want to change the base?

switch to ruff #5218

Uh oh!

Conversation

gvwilson commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emilykl commented Jun 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emilykl Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emilykl Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gvwilson commented Jun 5, 2025 •

edited

Loading

emilykl Jun 6, 2025 •

edited

Loading

emilykl Jun 6, 2025 •

edited

Loading