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

Additional deprecations #685

Merged
merged 29 commits into from
Apr 12, 2022
Merged

Additional deprecations #685

merged 29 commits into from
Apr 12, 2022

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Feb 21, 2022

Description

This PR contains a number of deprecations as well as TODO comments indicated proposed deprecations. I have intentionally been a little bit aggressive with some of the proposals to spark discussion on whether certain APIs should continue to exist in the long term or not.

Motivation and Context

Aiming to slim down the API as much as possible in 2.0 as well as planning for future developments.

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.

@vyasr vyasr added this to the v1.8.0 milestone Feb 21, 2022
@vyasr vyasr self-assigned this Feb 21, 2022
@vyasr vyasr requested review from a team as code owners February 21, 2022 19:55
@vyasr vyasr requested review from atravitz and SchoeniPhlippsn and removed request for a team February 21, 2022 19:55
@vyasr vyasr marked this pull request as draft February 21, 2022 19:58
@codecov
Copy link

codecov bot commented Feb 21, 2022 •
edited
Loading

Codecov Report

Merging #685 (d146952) into master (1135390) will increase coverage by 0.04%.
The diff coverage is 92.72%.

❗ Current head d146952 differs from pull request most recent head 4e9c777. Consider uploading reports for the commit 4e9c777 to get more accurate results

@@            Coverage Diff             @@
##           master     #685      +/-   ##
==========================================
+ Coverage   78.34%   78.39%   +0.04%     
==========================================
  Files          66       66              
  Lines        7231     7256      +25     
  Branches     1586     1589       +3     
==========================================
+ Hits         5665     5688      +23     
- Misses       1251     1253       +2     
  Partials      315      315
Impacted Files Coverage Δ
signac/testing.py 100.00% <ø> (ø)
signac/contrib/linked_view.py 83.91% <50.00%> (ø)
signac/sync.py 82.50% <66.66%> (ø)
signac/contrib/import_export.py 78.30% <71.42%> (ø)
signac/contrib/job.py 90.18% <92.59%> (-0.46%) ⬇️
signac/contrib/project.py 85.18% <97.43%> (+0.14%) ⬆️
signac/__main__.py 71.82% <100.00%> (+0.15%) ⬆️
signac/cite.py 52.38% <100.00%> (+2.38%) ⬆️
signac/contrib/indexing.py 70.95% <100.00%> (ø)
signac/contrib/schema.py 95.55% <100.00%> (+0.06%) ⬆️
... and 2 more

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 1135390...4e9c777. Read the comment docs.

csadorf
csadorf reviewed Feb 24, 2022
View reviewed changes
signac/contrib/job.py Outdated Show resolved Hide resolved
signac/contrib/job.py Outdated Show resolved Hide resolved
signac/contrib/project.py Outdated Show resolved Hide resolved
signac/contrib/project.py Show resolved Hide resolved
signac/contrib/schema.py Outdated Show resolved Hide resolved
signac/contrib/schema.py Show resolved Hide resolved
signac/contrib/schema.py Show resolved Hide resolved
signac/testing.py Show resolved Hide resolved
bdice
bdice reviewed Feb 26, 2022
View reviewed changes
Copy link
Member

@bdice bdice left a comment

Choose a reason for hiding this comment

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

Comments attached. Thanks so much for helping with this! This takes off a portion of the requires-1.x-deprecation label. I'm not sure what's left. Maybe we should add the remaining ones to a milestone, or remove the label for the ones that are complete.

signac/contrib/schema.py Outdated Show resolved Hide resolved
signac/contrib/schema.py Outdated Show resolved Hide resolved
signac/contrib/schema.py Outdated Show resolved Hide resolved
signac/contrib/schema.py Outdated Show resolved Hide resolved
signac/contrib/schema.py Outdated Show resolved Hide resolved
signac/core/utility.py Outdated Show resolved Hide resolved
signac/core/utility.py Outdated Show resolved Hide resolved
signac/testing.py Show resolved Hide resolved
tests/test_project.py Outdated Show resolved Hide resolved
tests/test_project.py Outdated Show resolved Hide resolved
@vyasr vyasr force-pushed the additional_deprecations branch from fddb95e to d4a347a Compare March 5, 2022 01:33
@vyasr vyasr marked this pull request as ready for review March 5, 2022 01:33
csadorf
csadorf reviewed Mar 7, 2022
View reviewed changes
signac/contrib/job.py Outdated Show resolved Hide resolved
signac/contrib/job.py Outdated Show resolved Hide resolved
signac/contrib/project.py Outdated Show resolved Hide resolved
signac/contrib/schema.py Show resolved Hide resolved
signac/contrib/schema.py Show resolved Hide resolved
@vyasr vyasr requested review from bdice and csadorf March 13, 2022 23:38
csadorf
csadorf requested changes Mar 15, 2022
View reviewed changes
signac/__main__.py Outdated Show resolved Hide resolved
signac/contrib/project.py Outdated Show resolved Hide resolved
@bdice bdice mentioned this pull request Mar 16, 2022
Merged
6 tasks
@vyasr vyasr requested a review from csadorf March 19, 2022 21:14
csadorf
csadorf approved these changes Mar 21, 2022
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.

Perfect! 👍

bdice
bdice approved these changes Mar 22, 2022
View reviewed changes
Copy link
Member

@bdice bdice left a comment •
edited
Loading

Choose a reason for hiding this comment

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

A few comments but nothing that should block this PR based on our current pace and goal of gradual forward progress. Some review comments may warrant future work / may be worth tracking in an issue.

signac/__main__.py Show resolved Hide resolved
signac/contrib/job.py Show resolved Hide resolved
signac/contrib/project.py Outdated Show resolved Hide resolved
signac/contrib/project.py Outdated Show resolved Hide resolved
signac/contrib/project.py Show resolved Hide resolved
@vyasr
Copy link
Contributor Author

vyasr commented Apr 2, 2022

We'll discuss the cached property question at the next dev meeting then I think this PR is good to go.

@cbkerr cbkerr mentioned this pull request Apr 5, 2022
Closed
@vyasr vyasr enabled auto-merge (squash) April 12, 2022 05:45
@vyasr vyasr merged commit aca1315 into master Apr 12, 2022
@vyasr vyasr deleted the additional_deprecations branch April 12, 2022 05:49
This was referenced May 2, 2022
Merged
Closed
@cbkerr cbkerr mentioned this pull request May 7, 2022
Open
@cbkerr cbkerr linked an issue May 7, 2022 that may be closed by this pull request
Replace data space with workspace in docstrings #743
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bdice bdice bdice approved these changes

@csadorf csadorf csadorf approved these changes

@Athul0491 Athul0491 Athul0491 approved these changes

@atravitz atravitz Awaiting requested review from atravitz atravitz was automatically assigned from glotzerlab/signac-committers

@SchoeniPhlippsn SchoeniPhlippsn Awaiting requested review from SchoeniPhlippsn SchoeniPhlippsn was automatically assigned from glotzerlab/signac-contributors

Assignees

@vyasr vyasr

Labels
None yet
Projects
None yet
Milestone
v1.8.0
Development

Successfully merging this pull request may close these issues.

Replace data space with workspace in docstrings
4 participants
@vyasr @csadorf @bdice @Athul0491