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.

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

Remove index arguments and state point backups #599

Merged
merged 18 commits into from
Aug 10, 2021
Merged

Conversation

bdice
Copy link
Member

@bdice bdice commented Aug 6, 2021

Description

Additional cleanup related to #588. This PR removes index arguments from a number of methods of Project and the CLI.

I also removed the public methods read_statepoints, write_statepoints, and dump_statepoints from the public API (see #579).

Finally, I removed the deprecated function get_statepoint from the public API because it used FN_STATEPOINTS which was removed as a part of the previously mentioned read/write/dump_statepoints changes. I would have split this into two pull requests but there would have been a couple annoying merge conflicts. Since this is a pure removal, I thought it would be fine to combine the two sets of changes to avoid having to deal with the conflicts.

Deprecations for the index argument will need to be added to signac 1.x.

Motivation and Context

signac 2.0 API cleanup. There is no longer a public method for generating an index, so it no longer makes sense to allow users to supply one as an argument.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

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 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.

@bdice bdice added the requires-1.x-deprecation Changes for 2.0 that require a deprecation to be added in 1.x. label Aug 6, 2021
@bdice bdice added this to the v2.0.0 milestone Aug 6, 2021
@bdice bdice changed the base branch from master to next August 6, 2021 19:22
@codecov
Copy link

codecov bot commented Aug 6, 2021

Codecov Report

Merging #599 (62034d8) into next (5f3d162) will increase coverage by 0.19%.
The diff coverage is 100.00%.

❗ Current head 62034d8 differs from pull request most recent head 0a490d0. Consider uploading reports for the commit 0a490d0 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             next     #599      +/-   ##
==========================================
+ Coverage   85.32%   85.52%   +0.19%     
==========================================
  Files          52       52              
  Lines        5207     5120      -87     
  Branches      957      928      -29     
==========================================
- Hits         4443     4379      -64     
+ Misses        551      540      -11     
+ Partials      213      201      -12     
Impacted Files Coverage Δ
signac/contrib/filterparse.py 88.04% <ø> (+3.50%) ⬆️
signac/__main__.py 75.75% <100.00%> (+0.57%) ⬆️
signac/contrib/import_export.py 77.83% <100.00%> (-0.06%) ⬇️
signac/contrib/linked_view.py 89.60% <100.00%> (+1.45%) ⬆️
signac/contrib/project.py 86.34% <100.00%> (+0.06%) ⬆️

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 5f3d162...0a490d0. Read the comment docs.

@bdice bdice marked this pull request as ready for review August 10, 2021 01:29
@bdice bdice requested review from a team as code owners August 10, 2021 01:29
@bdice bdice changed the title Remove index arguments Remove index arguments and state point backups Aug 10, 2021
signac/contrib/project.py Outdated Show resolved Hide resolved
signac/contrib/project.py Outdated Show resolved Hide resolved
tests/test_project.py Outdated Show resolved Hide resolved
@bdice bdice requested a review from csadorf August 10, 2021 13:43
@bdice bdice enabled auto-merge (squash) August 10, 2021 13:54
@bdice bdice merged commit 6290256 into next Aug 10, 2021
@bdice bdice deleted the remove-index-arguments branch August 10, 2021 14:02
vyasr pushed a commit that referenced this pull request Nov 9, 2021
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
bdice added a commit that referenced this pull request Dec 5, 2021
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Dec 25, 2021
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Jan 4, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Jan 27, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Feb 4, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Feb 21, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Feb 21, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Mar 14, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Apr 19, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Apr 21, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request May 2, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
bdice added a commit that referenced this pull request Jun 14, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
bdice added a commit that referenced this pull request Aug 1, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
bdice added a commit that referenced this pull request Oct 7, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
bdice added a commit that referenced this pull request Oct 27, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
vyasr pushed a commit that referenced this pull request Oct 30, 2022
* Remove index argument from _find_job_ids and CLI.

* Remove index argument from linked views.

* Remove access modules.

* Remove index argument from detect_schema.

* Improve docstrings.

* Remove unused _read_index function.

* Use generator in the same line it is constructed; remove unclear variable name jsi.

* Rename sp_index to statepoint_index.

* Remove index argument from repair method.

* Clarify docstrings.

* Remove index from docstring.

* Remove deprecated state point backup functions.

* Remove docs for removed methods.

* Fix tests for repair function to use only the persistent cache.

* Remove public get_statepoint method.

* Remove error.

* Improve rigor of state point validation after repair.

* Clarify docstring notes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
requires-1.x-deprecation Changes for 2.0 that require a deprecation to be added in 1.x.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants