Refactored internal use of get_statepoints

[vishav1771]

Description

Refactored the internal use of a deprecated method get_statepoints from project.py

Motivation and Context

Fixes #227

Types of Changes

• Documentation update
• Bug fix
• New feature
• Breaking change¹

¹The change breaks (or has the potential to break) existing functionality.

Checklist:

• I am familiar with the Contributing Guidelines.
• I agree with the terms of the Contributor Agreement.
• My name is on the list of contributors.
• My code follows the code style guideline of this project.
• The changes introduced by this pull request are covered by existing or newly introduced tests.

If necessary:

• I have updated the API documentation as part of the package doc-strings.
• I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
• I have updated the changelog and added all related issue and pull request numbers for future reference (if applicable). See example below.

Example for a changelog entry: Fix issue with launching rockets to the moon (#101, #212).

[csadorf]

I have only superficially looked over the code for now, but before we move forward, I would like to point out that the Project.get_statepoint() function has side-effects, specifically it ensures that the retrieved state point is cached:

signac/signac/contrib/project.py

Line 857 in c9810b9

self._sp_cache[jobid] = sp

For the sake of this refactorization, it might be better to simply alias the Project.get_statepoint with Project._get_statepoint as a first step and then see what further optimization we can do from there.

[bdice]

@vishav1771 I like what @csadorf suggested. Replacing internal uses of get_statepoint with _get_statepoint is a clean way to solve this for now. However, we need to restore the public API of get_statepoint. We adhere to Semantic Versioning, which means we will not remove features from the public API without incrementing the major version number (e.g. to signac 2.0).

Here are the steps to address this:

• Add back the line in the documentation referring to this method.
• Add back the @deprecated decorator, function get_statepoint, and docstring, and replaces its contents with return _get_statepoint(arguments)

[codecov]

Codecov Report

Merging #282 into master will increase coverage by 0.01%.
The diff coverage is 90%.

@@            Coverage Diff             @@
##           master     #282      +/-   ##
==========================================
+ Coverage   64.93%   64.94%   +0.01%     
==========================================
  Files          40       40              
  Lines        5635     5637       +2     
==========================================
+ Hits         3659     3661       +2     
  Misses       1976     1976

Impacted Files	Coverage Δ
signac/contrib/project.py	90.54% <90%> (+0.02%)	⬆️

---

Continue to review full report at Codecov.

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

[vishav1771]

@bdice I have done the changes you asked. Kindly check if something needs to be changed?

[bdice]

@vishav1771 Yes, that's right! Can you review the checklist for this PR again and check the boxes? (Agree to the contributor agreement, etc.)

Also please add a changelog line, under "Changed": "Refactored internal use of deprecated get_statepoint function (#227, #282)." (Note that the code font in rST requires two backticks, just follow the examples.)

[bdice]

@csadorf You can merge this after you review. Thanks again, @vishav1771!

[csadorf]

Perfect! I think that is all what was needed for the scope of this issue. Thank you very much.