Deprecate hmn and lgc modules from the node_classification package
#5166
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Condense all node-classification tests into single test module one level up.
Add a deprecation warning whenever the hmn or lgc attributes are accessed.
jarrodmillman
approved these changes
Nov 6, 2021
dschult
pushed a commit
to dschult/networkx
that referenced
this pull request
Jan 25, 2022
…age (networkx#5166) * Reorganize tests. Condense all node-classification tests into single test module one level up. * Add tests for deprecation warnings. * Prevent test crosstalk. * Refactor pkg with __getattr__ and __dir__. Add a deprecation warning whenever the hmn or lgc attributes are accessed. * Add deprecation reminder to developer docs. * Add release note.
MridulS
pushed a commit
to MridulS/networkx
that referenced
this pull request
Feb 4, 2023
…age (networkx#5166) * Reorganize tests. Condense all node-classification tests into single test module one level up. * Add tests for deprecation warnings. * Prevent test crosstalk. * Refactor pkg with __getattr__ and __dir__. Add a deprecation warning whenever the hmn or lgc attributes are accessed. * Add deprecation reminder to developer docs. * Add release note.
cvanelteren
pushed a commit
to cvanelteren/networkx
that referenced
this pull request
Apr 22, 2024
…age (networkx#5166) * Reorganize tests. Condense all node-classification tests into single test module one level up. * Add tests for deprecation warnings. * Prevent test crosstalk. * Refactor pkg with __getattr__ and __dir__. Add a deprecation warning whenever the hmn or lgc attributes are accessed. * Add deprecation reminder to developer docs. * Add release note.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deprecates the
hmnandlgcmodules in thenode_classificationpackage. These names are not particularly descriptive, and are more of an implementation detail than useful objects or namespaces.Refactors the
node_classification/__init__.pywith__getattr__and__dir__so that the same functions are visible/accessible from the package, but a deprecation warning is raised if a user tries to access thehmnorlgcattributes specifically. Access to the functions they define (harmonic_functionandlocal_and_global_consistency, respectively) should be exactly the same as before.This deprecation is in preparation for refactoring
node_classificationfrom a package to a module for NetworkX 3.0. The functions defined inlgc.pyandhmn.py, along with an internal function in the currently unexposedutils.py, will be moved to anode_classification.pymodule, which will replace the current package. I've taken the liberty of combining thehmnandlgctests into one top-leveltest_node_classification.pyfile that lives one level up. I left the tests themselves entirely unchanged.I've also added tests to ensure that deprecation warnings are raised at the appropriate times.