UserWarning: Unknown distribution option: 'tests_require'

Open
#101 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python

Research direction

Start with setup.py in the launch_system_modes package and reproduce the reported colcon build and colcon test output using the stated ROS, Ubuntu, Python, and setuptools versions. Compare the current tests_require configuration with the reported extras_require change, then use launch_system_modes.log and the build directory to determine whether the warning, test execution, and pytest.xml output are resolved.

Written by the indexing model from the issue text.

Description

  • ROS Version: Humble

  • OS Version: Ubuntu22.04

  • Python Version: 3.10.12

  • setuptools Version: 75.2.0

Hello, when I build this project from source, some warnings occurred.

Hers is the output of the command colcon build:

Starting >>> launch_system_modes
/home/qiguanxiao/.local/lib/python3.10/site-packages/setuptools/_distutils/dist.py:261: UserWarning: Unknown distribution option: 'tests_require'
  warnings.warn(msg)                           
--- stderr: launch_system_modes

/home/qiguanxiao/.local/lib/python3.10/site-packages/setuptools/_distutils/dist.py:261: UserWarning: Unknown distribution option: 'tests_require'
  warnings.warn(msg)
---
Finished <<< launch_system_modes [1.53s]

These warnings show the tests_require option is expired. But the python is the default package with ubuntu 22.04 and setuptools is installed by pip.

And then I use colcon test to test this project, there were also some warnings.

Here is the output about the command colcon test:

Starting >>> launch_system_modes

/home/qiguanxiao/.local/lib/python3.10/site-packages/setuptools/_distutils/dist.py:261: UserWarning: Unknown distribution option: 'tests_require'
  warnings.warn(msg)
--- stderr: launch_system_modes                                    

----------------------------------------------------------------------
Ran 0 tests in 0.000s

OK
---
Finished <<< launch_system_modes [0.72s]


It seems like that there were no python testing programs to run and no result file pytest.xml was generated in build directory.

Then I tried to modify the setup.py file in package launch_system_modes and replaced the option tests_require with extras_require.

Finally it can be built and test correctly.

Here is the modified content in setpu.py file:

tests_require=['pytest'],  # remove
extras_require={
        'test': ['pytest'],
 },  # add

But there are some format errors after running colcon test. Here is the result:

launch_system_modes.log

Now the python and setuptools version are updated very quickly, could you tell me if it is necessary to replace the tests_require option to adapt to the current environment.

Thanks!

Dominant language
C++
Stars
45
Forks
13
PR merge metrics
No merged PRs in 30d

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.

More from micro-ROS/system_modes

All issues in micro-ROS/system_modes

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.