Ruff proposal

[jhkennedy]

This updates ruff config in-line with the updates to the ruff action proposed in ASFHyP3/actions#95 and applies the lining auto fixes.

In particular, adopting the additional checks would result in needing to make quite a few changes to satisfy the linter:

$ ruff check --statistics .
56      ANN001  [ ] Missing type annotation for function argument `array`
56      ANN201  [ ] Missing return type annotation for public function `check_correctness_of_resample`
55      D103    [ ] Missing docstring in public function
32      D415    [*] First line should end with a period, question mark, or exclamation point
20      D100    [ ] Missing docstring in public module
13      PTH123  [ ] `open()` should be replaced by `Path.open()`
10      ANN101  [ ] Missing type annotation for `self` in method
 8      D205    [ ] 1 blank line required between summary line and description
 6      ANN204  [ ] Missing return type annotation for special method `__enter__`
 3      PTH107  [ ] `os.remove()` should be replaced by `Path.unlink()`
 3      D107    [ ] Missing docstring in `__init__`
 2      PTH113  [ ] `os.path.isfile()` should be replaced by `Path.is_file()`
 2      D105    [ ] Missing docstring in magic method
 2      D200    [*] One-line docstring should fit on one line
 2      D417    [ ] Missing argument description in the docstring for `create_water_mask`: `input_image`
 1      ANN003  [ ] Missing type annotation for `**options`
 1      ANN202  [ ] Missing return type annotation for private function `_download_platform`
 1      PTH109  [ ] `os.getcwd()` should be replaced by `Path.cwd()`
 1      PTH120  [ ] `os.path.dirname()` should be replaced by `Path.parent`
 1      PTH207  [ ] Replace `glob` with `Path.glob` or `Path.rglob`
 1      D104    [ ] Missing docstring in public package

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
/home/runner/micromamba/envs/hyp3-isce2/lib/python3.11/site-packages/hyp3_isce2
__main__.py	26	2	92%	32, 43
burst.py	170	51	70%	78–81, 94–99, 113–128, 144–153, 167–177, 235, 282–290, 310–324
dem.py	53	3	94%	103–112
insar_stripmap.py	69	42	39%	38–91, 95–97, 113–132
insar_tops.py	50	28	44%	42–75, 96–116
insar_tops_burst.py	201	159	21%	72–146, 158–184, 212–290, 301–383, 423–503
logging.py	4	1	75%	9
s1_auxcal.py	21	2	90%	51, 59
slc.py	34	10	71%	22–25, 29–34
stripmapapp_alos.py	50	7	86%	103, 139, 142–147
topsapp.py	69	8	88%	76, 106, 128–134
utils.py	77	30	61%	103–105, 118–126, 138–143, 187–200, 210–214, 226–227
/home/runner/micromamba/envs/hyp3-isce2/lib/python3.11/site-packages/hyp3_isce2/metadata
util.py	14	9	36%	6–14, 18–21, 25–27
TOTAL	901	352	61%

Tests	Skipped	Failures	Errors	Time
42	0 💤	0 ❌	0 🔥	29.781s ⏱️

[jhkennedy]

Ruff does not like Path('.') and would prefer you use either Path() or Path.cwd(). There were some gotcha's here around when '.' was resolved to an actual path, so we'll want to make sure that Path.cwd() doesn't hit those again....

[jhkennedy]

IOError is just a legacy/backwards compatible alias for OSError so OSError is preferred.