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.

Sign up for GitHub

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

Jump to bottom

Remove index from Project.find_jobs() #135

Merged
merged 3 commits into from
Feb 24, 2019
Merged

Remove index from Project.find_jobs() #135

merged 3 commits into from
Feb 24, 2019

Conversation

bdice
Copy link
Member

@bdice bdice commented Feb 24, 2019 •
edited
Loading

Motivation and Context

Resolves #131.

Types of Changes

  • New feature
  • Breaking change1

This pull request is based on

  • develop, because it introduces a new feature.

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

Checklist:

If necessary:

  • I have updated the API documentation as part of the package doc-strings.
  • I have updated the changelog.

@bdice bdice requested review from csadorf and a team as code owners February 24, 2019 18:38
@bdice bdice changed the base branch from master to develop February 24, 2019 18:38
@bdice
Copy link
Member Author

bdice commented Feb 24, 2019

@csadorf I made this PR since it was one of the last remaining items on the Milestone 1.0 list. I'm going to fix the tests, then feel free to update it directly as needed.

bdice
bdice commented Feb 24, 2019
View reviewed changes
signac/contrib/project.py
.. note::
Providing a pre-calculated index may vastly increase the
performance of this function.

:param filter: A mapping of key-value pairs that all
indexed job statepoints are compared against.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstrings may need to be updated here, I'm not sure if using the word "indexed" is still appropriate. Since the argument was already unused, these may have been out of date already?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, in fact we should go through all doc strings to check for other incomplete deprecations and inconsistencies.

@bdice bdice added this to the v1.0.0 milestone Feb 24, 2019
@bdice bdice self-assigned this Feb 24, 2019
csadorf
csadorf requested changes Feb 24, 2019
View reviewed changes
Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would generally approve this PR, but since we already decided that we want to remove all deprecations, can we remove the find_statepoints() function directly?

signac/contrib/project.py
@@ -630,7 +626,7 @@ def to_dataframe(self, *args, **kwargs):
"""
return self.find_jobs().to_dataframe(*args, **kwargs)

def find_statepoints(self, filter=None, doc_filter=None, index=None, skip_errors=False):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is deprecated. Can you remove it?

@csadorf
Copy link
Contributor

csadorf commented Feb 24, 2019

The Project.find_statepoints() and Project.find_job_documents methods are both deprecated. Can you remove them as part of this PR?

@csadorf csadorf deleted the feature/remove_find_jobs_index branch February 24, 2019 22:31
@csadorf csadorf merged commit e07a92e into develop Feb 24, 2019
@csadorf csadorf mentioned this pull request Feb 25, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@csadorf csadorf csadorf approved these changes

Assignees

@bdice bdice

Labels
None yet
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@bdice @csadorf