WIP: Ruff #184

jeanconn · 2024-11-29T15:17:32Z

Description

Ruff

Interface impacts

Testing

Unit tests

Mac

(ska3-flight-latest) flame:chandra_aca jean$ git rev-parse HEAD
9aea615ee5f84fd7ceb1106c6f0bc9adaf539a47
(ska3-flight-latest) flame:chandra_aca jean$ pytest
================================================================================== test session starts ===================================================================================
platform darwin -- Python 3.11.8, pytest-8.0.2, pluggy-1.4.0
PyQt5 5.15.9 -- Qt runtime 5.15.8 -- Qt compiled 5.15.8
rootdir: /Users/jean/git
configfile: pytest.ini
plugins: astropy-0.11.0, qt-4.4.0, cov-5.0.0, timeout-2.2.0, remotedata-0.4.1, anyio-4.3.0, filter-subpackage-0.2.0, doctestplus-1.2.1, astropy-header-0.2.2, hypothesis-6.112.0, arraydiff-0.6.1, mock-3.14.0
collected 231 items                                                                                                                                                                      

chandra_aca/tests/test_aca_image.py ...................                                                                                                                            [  8%]
chandra_aca/tests/test_all.py ........................                                                                                                                             [ 18%]
chandra_aca/tests/test_attitude.py .............................................................                                                                                   [ 45%]
chandra_aca/tests/test_dark_model.py ............                                                                                                                                  [ 50%]
chandra_aca/tests/test_dark_subtract.py ........                                                                                                                                   [ 53%]
chandra_aca/tests/test_drift.py ..........................                                                                                                                         [ 64%]
chandra_aca/tests/test_maude_decom.py .........................                                                                                                                    [ 75%]
chandra_aca/tests/test_planets.py ...............                                                                                                                                  [ 82%]
chandra_aca/tests/test_psf.py ...                                                                                                                                                  [ 83%]
chandra_aca/tests/test_residuals.py ss...                                                                                                                                          [ 85%]
chandra_aca/tests/test_star_probs.py .................................                                                                                                             [100%]

==================================================================================== warnings summary ====================================================================================
chandra_aca/chandra_aca/tests/test_residuals.py::test_obc
  /Users/jean/miniforge3/envs/ska3-flight-latest/lib/python3.11/site-packages/django/utils/encoding.py:266: DeprecationWarning: 'locale.getdefaultlocale' is deprecated and slated for removal in Python 3.15. Use setlocale(), getencoding() and getlocale() instead.
    encoding = locale.getdefaultlocale()[1] or 'ascii'

chandra_aca/chandra_aca/tests/test_residuals.py::test_obc
  /Users/jean/miniforge3/envs/ska3-flight-latest/lib/python3.11/site-packages/django/http/request.py:1: DeprecationWarning: 'cgi' is deprecated and slated for removal in Python 3.13
    import cgi

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
================================================================= 229 passed, 2 skipped, 2 warnings in 66.54s (0:01:06)

Independent check of unit tests by [REVIEWER NAME]

[PLATFORM]:

Functional tests

No functional testing.

Copilot reviewed 15 out of 30 changed files in this pull request and generated no suggestions.

Files not reviewed (15)

.github/workflows/black.yml: Language not supported
.github/workflows/flake8.yml: Language not supported
chandra_aca/centroid_resid.py: Evaluated as low risk
chandra_aca/darkbins.py: Evaluated as low risk
chandra_aca/dark_model.py: Evaluated as low risk
chandra_aca/attitude.py: Evaluated as low risk
chandra_aca/tests/test_attitude.py: Evaluated as low risk
chandra_aca/drift.py: Evaluated as low risk
chandra_aca/aca_image.py: Evaluated as low risk
chandra_aca/tests/test_aca_image.py: Evaluated as low risk
chandra_aca/tests/test_all.py: Evaluated as low risk
chandra_aca/plot.py: Evaluated as low risk
chandra_aca/planets.py: Evaluated as low risk
chandra_aca/tests/test_dark_model.py: Evaluated as low risk
chandra_aca/star_probs.py: Evaluated as low risk

taldcroft

Looks mostly good, thanks!

taldcroft · 2024-11-29T16:38:43Z

chandra_aca/maude_decom.py

-        frames and not blobs
-    ), "Specify only one of 'frames' or blobs"
+    # check that only one of blobs or frames is set
+    if blobs and frames:


This is not logically equivalent to the original.

taldcroft · 2024-11-29T16:47:25Z

chandra_aca/plot.py

@@ -340,7 +341,7 @@ def plot_stars(
    r, c = yagzag_to_pixels(zeros, yz_ticks)
    ax.set_yticks(c)
    ax.set_yticklabels(yz_ticks)
-    ax.grid()
+    ax.grid(grid)


Woohoo, caught a bug!

taldcroft · 2024-11-29T16:51:22Z

chandra_aca/star_probs.py

@@ -1022,22 +1053,22 @@ def guide_count(mags, t_ccd, count_9th=False):
    ref_t_ccd = -10.9
    ref_mags0 = (9.0 if count_9th else 9.95) + np.array([0.0, 0.2, 0.3, 0.4])
    ref_mags = {}
-    for t_ccd in np.unique(t_ccds):
+    for t in np.unique(t_ccds):


Avoid single-letter variable names. Instead you could use t_ccd_.

OK, I used t_ccd_local in the other spot.

In this case t_ccd_unique would work and be meaningful.

taldcroft · 2024-11-29T16:54:28Z

chandra_aca/tests/test_aca_image.py

@@ -423,7 +422,7 @@ def test_aca_image_operators():
 def test_flicker_numba():
    a = ACAImage(np.linspace(0, 800, 9).reshape(3, 3))
    a.flicker_init(flicker_mean_time=1000, flicker_scale=1.5, seed=10)
-    for ii in range(10):
+    for _ii in range(10):


_ is the preferred variable for an unused loop parameter. You don't need to bother changing this in test code but keep it in mind for the future.

I think it was the VS code preference to make underscore named throw-away vars - I assume so that they could actually be accessed in test failure.

_ behaves like any other variable to Python and pytest. It is just humans and linters that give it a special meaning.

jeanconn · 2024-11-29T17:03:22Z

PS I hadn't asked for review yet until #174 is reviewed and merged.

taldcroft · 2024-11-29T19:21:02Z

PS I hadn't asked for review yet until #174 is reviewed and merged.

Oops, I guess I just got excited. And ruff review is about where I'm at today.

jeanconn added 17 commits November 27, 2024 13:28

Set for ruff

46f79ab

Ruff format (auto)

95c4749

Ruff check --fix

b3b2e50

Docs fixes

8f089af

Exclude borrowed cubic_spline code from ruff

77bcd8d

Remove noqa not needed

1c42d89

Remove some asserts

aee6e35

Replace relative imports

eb1c58a

Fix some issues with variable redefinition

f1f073d

Remove some not-used enumerates

e052138

Add some noqa

c270369

Add some list comps and replace dict with literal

9c03c74

Simplify check on fetch_source

dcaace8

Rename unused loop vars with _

d536ae7

Fix grid option not actually used

7f579c7

Raise error from None

0c3d593

Update pre-commit

9aea615

jeanconn requested a review from Copilot November 29, 2024 15:46

Copilot AI reviewed Nov 29, 2024

View reviewed changes

taldcroft requested changes Nov 29, 2024

View reviewed changes

jeanconn changed the title ~~Ruff~~ WIP: Ruff Nov 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Ruff #184

WIP: Ruff #184

jeanconn commented Nov 29, 2024 •

edited

Loading

taldcroft left a comment

taldcroft Nov 29, 2024

jeanconn Nov 29, 2024

taldcroft Nov 29, 2024

taldcroft Nov 29, 2024

jeanconn Nov 29, 2024

taldcroft Nov 29, 2024

taldcroft Nov 29, 2024

jeanconn Nov 29, 2024 •

edited

Loading

taldcroft Nov 29, 2024

jeanconn commented Nov 29, 2024

taldcroft commented Nov 29, 2024

WIP: Ruff #184

Are you sure you want to change the base?

WIP: Ruff #184

Conversation

jeanconn commented Nov 29, 2024 • edited Loading

Description

Interface impacts

Testing

Unit tests

Functional tests

Choose a reason for hiding this comment

taldcroft left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeanconn Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeanconn commented Nov 29, 2024

taldcroft commented Nov 29, 2024

jeanconn commented Nov 29, 2024 •

edited

Loading

jeanconn Nov 29, 2024 •

edited

Loading