Skip to content

Update python 3.14#186

Closed
danielsirakov wants to merge 19 commits into
diffpy:mainfrom
danielsirakov:update-python-3.14
Closed

Update python 3.14#186
danielsirakov wants to merge 19 commits into
diffpy:mainfrom
danielsirakov:update-python-3.14

Conversation

@danielsirakov

Copy link
Copy Markdown
Contributor

@stevenhua0320 ready to review

@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.71%. Comparing base (a9eae82) to head (986689c).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #186      +/-   ##
==========================================
+ Coverage   71.63%   71.71%   +0.08%     
==========================================
  Files          25       25              
  Lines        3437     3437              
==========================================
+ Hits         2462     2465       +3     
+ Misses        975      972       -3     
Files with missing lines Coverage Δ
tests/test_builder.py 100.00% <ø> (ø)
tests/test_characteristicfunctions.py 16.03% <100.00%> (+3.77%) ⬆️
tests/test_constraint.py 96.96% <ø> (ø)
tests/test_contribution.py 99.51% <ø> (ø)
tests/test_equation.py 100.00% <ø> (ø)
tests/test_fitrecipe.py 99.76% <ø> (ø)
tests/test_literals.py 99.17% <ø> (ø)
tests/test_objcrystparset.py 10.27% <ø> (ø)
tests/test_profile.py 99.33% <ø> (ø)
tests/test_recipeorganizer.py 99.69% <ø> (ø)
... and 4 more

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge

Copy link
Copy Markdown
Contributor

We finally made it, thanks @danielsirakov but this is a horribly dirty PR at this point with lots of nasty merge commits from work done by the bot. Could we maybe redo this on a clean branch in just a few commits?

@danielsirakov

Copy link
Copy Markdown
Contributor Author

Sounds good, I'll redo it

@cadenmyers13 cadenmyers13 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@sbillinge @danielsirakov See inline. The way docformatter 1.7.8 works can make some of the docstrings display poorly. Although, this doesn't affect the mouse-over view for users.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This edit is made by docformatter

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another docformatter edit that looks odd

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would prefer if we didn't have to add these FIXME lines. Why not just use docformatter v1.7.7? This just adds technical debt and v1.7.7 works fine enough

Context: This line is added just to prevent black and docformatter conflicts. See this convo for reference: #184 (comment)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

My understanding was that there is no python 3.14 support for 1.7.7

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@sbillinge yes I discovered this. I'm wondering if theres a better way to handle this than just adding the extra lines but this might be fine for now

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We decided this was the least technical debt. We want to keep using docformatter and we want to push out 3:14 and all the other options were way more TD

@cadenmyers13

Copy link
Copy Markdown
Contributor

@danielsirakov The pre-commit bot looks to be making lots of edits on your PR. This likely means you don't have pre-commit set up locally. To set it up locally,

  1. create a new env and install pre-commit into it
conda create -n my-env pre-commit
  1. activate the env
conda activate my-env
  1. install pre-commit hooks
pre-commit install

This will run pre-commit every time you make a commit. This makes life a lot easier for you too because you will not have to deal with differences in your remote branch and local branch 😅 . Let me know if you need help with anything!

@danielsirakov

Copy link
Copy Markdown
Contributor Author

Hi Caden, I redid this as a new PR (#187), which got merged to main as this one was carrying over my long and messy history from a previous PR (#184). I shouldn't have left this PR open after doing that, so sorry for any confusion. Also, I was able to figure out the issues with the pre-commit bot's edits, but I still appreciate the help : ) I'll check if the odd docformatter edits are still there in the version that got merged to main

@cadenmyers13

Copy link
Copy Markdown
Contributor

@danielsirakov Okay no problem. Let me know what you find. Can you please close this then?

@danielsirakov

Copy link
Copy Markdown
Contributor Author

I ended up finding that the weird stuff docformatter was doing is still present in the version that got merged to main. We had a lot of issues with docstrings (especially with triple quotes) and docformatter in PR (#184), and we had a couple of workarounds and solutions in that PR as well. I could double-check if this is something that we have a known solution for or if this is a new issue later today, and we could figure out the best approach from there.

@sbillinge

Copy link
Copy Markdown
Contributor

Please see my comments on Slack about docformatter. @cadenmyers13 we basically went through the whole thought process you are having wrt the docformatter update earlier in the summer when you were away and arrived back to where we are now.

@cadenmyers13

Copy link
Copy Markdown
Contributor

@sbillinge I saw it. thanks! its clear to me.

@cadenmyers13

Copy link
Copy Markdown
Contributor

@sbillinge I am going to try to spend some time (might have to be next week) getting v3.3.0 merged to main so we can release the deprecation warnings. I would really like to get that effort release ASAP

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.

3 participants