plotly / plotly/plotly.py

setting up a development environment is difficult

Open
#4,380 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug infrastructure P2
Dominant language
Python
Stars
18.8k
Forks
2.8k
Avg merge
16h 26m
Merged PRs (30d)
21

Description

I recently spun up a dev environment for contributing a PR to plotly.py and ran into some issues that I think can be addressed fairly readily.

  1. pytest is pinned to 3.5.1 in packages/python/plotly/optional-requirements.txt and this version simply didn't run, failing with an internal TypeError. I upgraded it to 7.4.2 and it worked. Is there a reason its pinned to such an old version? can this be unpinned?
  2. contributing.md does not currently mention the dependancy on Plotly Orca. I was rather surprised to come back to all my tests failing, and somewhat hilariously the orca Ubuntu screen reader reading a large chunk of Pytest's terminal output to me. Just adding an external dependency in the testing section would do the trick I reckon.
  3. There were a number of missing packages required by optional tests that aren't in packages/python/plotly/optional-requirements.txt so those tests failed. The following packages need to be added: polars vaex scikit-image statsmodels pyarrow

btw for 1,the error thrown by pytest 3.5.1 is:

  File "/home/ned/.pyenv/versions/3.11.6/envs/book/lib/python3.11/site-packages/_pytest/assertion/rewrite.py", line 332, in _rewrite_test
    co = compile(tree, fn.strpath, "exec", dont_inherit=True)
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: required field "lineno" missing from alias

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with packages/python/plotly/optional-requirements.txt and contributing.md, then reproduce the pytest 3.5.1 failure in the reported Python 3.11 environment. Check the optional-test dependencies and the testing documentation. Done means the documented setup runs the tests without the reported pytest error or missing-package failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.