Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eliminate use of dead and deprecated imports and options in setup.py #2070

Merged
merged 3 commits into from
Jan 26, 2025

Conversation

ni-jfitzger
Copy link
Collaborator

@ni-jfitzger ni-jfitzger commented Jan 25, 2025

  • This contribution adheres to CONTRIBUTING.md.
  • I've updated CHANGELOG.md if applicable.
  • [ ] I've added tests applicable for this pull request

What does this Pull Request accomplish?

Delete deprecated / unsupported imports and distribution options from setup.py. By doing this proactively, we can avoid being broken in the future.

According to GitHub Copilot, setuptools.command.test provides a way to setup for and run tests. It would happen in this case when users run python setup.py test.

The problems with that are:

  1. We don't ship tests with our python packages
  2. If someone has cloned the repo, we have guidelines for how to run tests and they don't involve making that call
  3. 2 of the distribution options associated with this feature (tests_require and test_suite) are no longer recognized.
  4. setuptools.command.test has been deprecated for years

For these reasons, it makes sense to just remove the import and everything related to it.

I also eliminated the setup_requires because it's considered deprecated and we won't be needing pytest-runner.

List issues fixed by this Pull Request below, if any.

What testing has been done?

PR Checks

@ni-jfitzger ni-jfitzger marked this pull request as ready for review January 25, 2025 23:57
@ni-jfitzger ni-jfitzger changed the title Eliminate use of dead& deprecated imports and options in setup.py Eliminate use of dead and deprecated imports and options in setup.py Jan 25, 2025
@codecov-commenter
Copy link

codecov-commenter commented Jan 26, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.34%. Comparing base (afd791e) to head (8df73c6).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2070   +/-   ##
=======================================
  Coverage   91.33%   91.34%           
=======================================
  Files          66       66           
  Lines       16274    16274           
=======================================
+ Hits        14864    14865    +1     
+ Misses       1410     1409    -1     
Flag Coverage Δ
codegenunittests 84.95% <ø> (ø)
nidcpowersystemtests 94.59% <ø> (+0.04%) ⬆️
nidcpowerunittests 89.53% <ø> (ø)
nidigitalsystemtests 92.20% <ø> (ø)
nidigitalunittests 68.45% <ø> (ø)
nidmmsystemtests 92.72% <ø> (ø)
nifakeunittests 87.24% <ø> (ø)
nifgensystemtests 94.86% <ø> (ø)
nimodinstsystemtests 73.85% <ø> (ø)
nimodinstunittests 94.20% <ø> (ø)
niscopesystemtests 92.94% <ø> (ø)
niscopeunittests 43.20% <ø> (ø)
nisesystemtests 91.50% <ø> (ø)
niswitchsystemtests 82.03% <ø> (ø)
nitclksystemtests 94.87% <ø> (ø)
nitclkunittests 98.26% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update afd791e...8df73c6. Read the comment docs.

CHANGELOG.md Show resolved Hide resolved
@ni-jfitzger ni-jfitzger merged commit a817654 into ni:master Jan 26, 2025
35 checks passed
@ni-jfitzger ni-jfitzger deleted the replace-setuptools.command.test branch January 27, 2025 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecated import: setuptools.command.test
3 participants