chore: deprecate assignUniqueLabels - #158
sbillinge merged 4 commits into
Conversation
Sorry, something went wrong.
sbillinge
left a comment
There was a problem hiding this comment.
I will merge this but @stevenhua0320 and @cadenmyers13 please can you see my comment
Sorry, something went wrong.
| @@ -0,0 +1,23 @@ | |||
| **Added:** | |||
|
|
|||
| * No News Added: deprecate assignUniqueLabels method | |||
There was a problem hiding this comment.
Why is this no news. Don't we need to list what we deprecate and what we add?
Sorry, something went wrong.
|
|
||
| def test_assignUniqueLabels(self): | ||
| """Check Structure.assignUniqueLabels()""" | ||
| """Duplicate test with the deprecated assignUniqueLabels method. |
There was a problem hiding this comment.
I don't think we need to do this. This test will start failing when we remove the function so these will be easy to find and remove.
Sorry, something went wrong.
There was a problem hiding this comment.
@sbillinge So, what we need to contain here? should we maintain the original docstring here?
Sorry, something went wrong.
|
Actually, I can't merge because of the news. I am afraid that I may have merged som no-news's that should have had news in them. Please can you take a look @stevenhua0320 and add PRs if I did? |
Sorry, something went wrong.
|
@sbillinge It's safe right now since nothing deprecation's PR has been merged yet. I would now change the news and see anything that we need edit here. |
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #158 +/- ##
=======================================
Coverage 98.93% 98.93%
=======================================
Files 13 13
Lines 1878 1884 +6
=======================================
+ Hits 1858 1864 +6
Misses 20 20
|
Sorry, something went wrong.
@sbillinge ready to review.
Now the test for this function would give deprecationWarning shown below.
(diffpy.structure) ~/dbs/diffpy.structure git:[deprecate-assignUniqueLabels] pytest ============================================================================================================== test session starts ============================================================================================================== platform darwin -- Python 3.14.3, pytest-9.0.2, pluggy-1.6.0 rootdir: /Users/huarundong/dbs/diffpy.structure configfile: pyproject.toml collected 138 items tests/test_atom.py .. [ 1%] tests/test_lattice.py ............ [ 10%] tests/test_loadstructure.py ...... [ 14%] tests/test_p_cif.py ..................... [ 29%] tests/test_p_discus.py ..... [ 33%] tests/test_p_pdffit.py ......... [ 39%] tests/test_parsers.py ............. [ 49%] tests/test_spacegroups.py ..... [ 52%] tests/test_structure.py ........................................ [ 81%] tests/test_supercell.py ... [ 84%] tests/test_symmetryutilities.py ..................... [ 99%] tests/test_version.py . [100%] =============================================================================================================== warnings summary ================================================================================================================ tests/test_structure.py::TestStructure::test_assignUniqueLabels /Users/huarundong/dbs/diffpy.structure/tests/test_structure.py:128: DeprecationWarning: 'diffpy.structure.Structure.assignUniqueLabels' is deprecated and will be removed in version 4.0.0. Please use 'diffpy.structure.Structure.assign_unique_labels' instead. self.stru.assignUniqueLabels() -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html ======================================================================================================== 138 passed, 1 warning in 0.63s =========================================================================================================