Skip to content

Commit

Permalink
Remove public get_statepoint method.
Browse files Browse the repository at this point in the history
  • Loading branch information
bdice committed Aug 10, 2021
1 parent 7ca12b2 commit 93ef230
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 41 deletions.
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ omit =

[tool:pytest]
filterwarnings =
ignore: .*[get_statepoint | Use of.+as key] is deprecated.*: DeprecationWarning
ignore: .*[Use of.+as key] is deprecated.*: DeprecationWarning

[bumpversion:file:setup.py]

Expand Down
41 changes: 1 addition & 40 deletions signac/contrib/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -1049,7 +1049,7 @@ def _get_statepoint_from_workspace(self, job_id):
raise JobsCorruptedError([job_id])
raise KeyError(job_id)

def _get_statepoint(self, job_id, fn=None):
def _get_statepoint(self, job_id):
"""Get the state point associated with a job id.
The state point is retrieved from the internal cache, from
Expand All @@ -1059,9 +1059,6 @@ def _get_statepoint(self, job_id, fn=None):
----------
job_id : str
A job id to get the state point for.
fn : str
The filename of the file containing the state points, defaults
to :attr:`~signac.Project.FN_STATEPOINTS`.
Returns
-------
Expand Down Expand Up @@ -1101,42 +1098,6 @@ def _get_statepoint(self, job_id, fn=None):
self._sp_cache[job_id] = statepoint
return statepoint

@deprecated(
deprecated_in="1.3",
removed_in="2.0",
current_version=__version__,
details="Use open_job(id=jobid).statepoint() function instead.",
)
def get_statepoint(self, jobid, fn=None):
"""Get the state point associated with a job id.
The state point is retrieved from the internal cache, from
the workspace or from a state points file.
Parameters
----------
jobid : str
A job id to get the state point for.
fn : str
The filename of the file containing the state points, defaults
to :attr:`~signac.Project.FN_STATEPOINTS`.
Returns
-------
dict
The state point corresponding to jobid.
Raises
------
KeyError
If the state point associated with jobid could not be found.
:class:`signac.errors.JobsCorruptedError`
If the state point manifest file corresponding to jobid is
inaccessible or corrupted.
"""
return self._get_statepoint(job_id=jobid, fn=fn)

def create_linked_view(self, prefix=None, job_ids=None, path=None):
"""Create or update a persistent linked view of the selected data space.
Expand Down

0 comments on commit 93ef230

Please sign in to comment.