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 deprecated features and FutureWarnings #239

Merged
merged 58 commits into from
Mar 18, 2024
Merged

Conversation

Jakob-Unfried
Copy link
Member

@Jakob-Unfried Jakob-Unfried commented Apr 27, 2023

Removing support for deprecated features, FutureWarnings, etc.

I am heavily using rebase and force push on this branch, to get a clean commit history.
If you want to base anything on the commits in this branch, let me know, so i can be considerate of your history...

Wait with merging!

Should wait for all other features of release 1.0, then release a version 0.99 which includes all those features but still hast the FutureWarnings and backwards compatibilities.
Then we merge this PR on top of 0.99 to release 1.0.

Plan

  • Go through the explicit checklist in FutureWarnings to be removed #47
  • Search for FutureWarning
  • Search for .. deprecated ::
  • Search for uses of Config.deprecated_alias
  • changelog
    • Have a WIP version that lists all current changes.
    • Nice rst formatting
    • todos in the v1.0.0.rst file

TODO list / single issues:

  • test_mps generates warnings?
    • It also does on the current main branch, so i did not introduce this here, see Test coverage #240 .
  • Is FutureWarning filtering in the tests, e.g. in test_np_conserved.py via warnings.simplefilter("ignore", FutureWarning) still intended? (also in test_hdf5 and test_pickle)
  • fix doctests
  • CouplingModel.add_coupling arguments

@Jakob-Unfried Jakob-Unfried added this to the Release 1.0 milestone Apr 27, 2023
@Jakob-Unfried Jakob-Unfried changed the title Future warnings Remove deprecated features and FutureWarnings Apr 27, 2023
@Jakob-Unfried Jakob-Unfried force-pushed the future_warnings branch 2 times, most recently from 9104648 to aabe755 Compare April 27, 2023 14:54
@Jakob-Unfried Jakob-Unfried linked an issue Apr 27, 2023 that may be closed by this pull request
@Jakob-Unfried Jakob-Unfried force-pushed the future_warnings branch 14 times, most recently from 5734a06 to 6eea83c Compare May 2, 2023 14:11
@Jakob-Unfried
Copy link
Member Author

@jhauschild
There is one open questions from my side, see below.
Otherwise the PR looks done to me, except for the changelog, which we will touch up anyway, when we are ready to release.
Could you review anytime before v1.0.0?

There is a deprecation notice in the docstring of models.CouplingModel.add_coupling:

tenpy/tenpy/models/model.py

Lines 1008 to 1009 in 8c8e8db

.. deprecated:: 0.4.0
The arguments `str_on_first` and `raise_op2_left` will be removed in version 1.0.0.

I am not sure why those arguments should be removed?
Also, we have not issued warnings so far, so just removing the args would be quite harsh.

@Jakob-Unfried Jakob-Unfried force-pushed the future_warnings branch 2 times, most recently from f53f050 to f7abfca Compare May 2, 2023 16:50
@Jakob-Unfried Jakob-Unfried marked this pull request as draft May 12, 2023 19:35
@Jakob-Unfried Jakob-Unfried force-pushed the future_warnings branch 2 times, most recently from 96129a1 to e8d56e5 Compare July 17, 2023 20:05
@Jakob-Unfried Jakob-Unfried marked this pull request as ready for review March 18, 2024 19:25
@Jakob-Unfried Jakob-Unfried merged commit 5090afe into v1 Mar 18, 2024
6 of 9 checks passed
@Jakob-Unfried Jakob-Unfried deleted the future_warnings branch March 18, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FutureWarnings to be removed
1 participant