Skip to content

Rename camelCase methods to snake_case with deprecation warnings (Phase 3+4) #61

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

Merged
SBFRF merged 7 commits into from
Jul 17, 2026
Merged

Rename camelCase methods to snake_case with deprecation warnings (Phase 3+4) #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0c51abc
Rename camelCase methods to snake_case with deprecation warnings (Iss…
SBFRF Jul 17, 2026
2678a18
Address PR review comments
SBFRF Jul 17, 2026
1efee67
Address additional PR review comments
SBFRF Jul 17, 2026
cefc117
Add test artifacts to .gitignore (*.tif, *_diagnostic.png, *_test.png)
SBFRF Jul 17, 2026
80320f9
Fix internal calls and docstrings to use snake_case names
SBFRF Jul 17, 2026
d77b3f4
Make getWaveSpec alias consistent with other deprecated methods
SBFRF Jul 17, 2026
696f926
Use explicit wrapper methods instead of __getattr__ for deprecated al…
SBFRF Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ Thumbs.db
*.nc
*.pickle
*.pkl
*.tif
Argus_*.tif
*_diagnostic.png
*_test.png

# Local development configs
.claude/
Expand Down
21 changes: 17 additions & 4 deletions murgtools/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
"""murgtools - Tools for USACE FRF Coastal Model Test Bed data access."""

from .getdata import getObs, getDataTestBed, gettime, getnc, removeDuplicatesFromDictionary
from .getdata import getObs, getDataTestBed, gettime, getnc
# New snake_case function names (preferred)
from .getdata import remove_duplicates_from_dictionary
from .getdata import get_argus_imagery, thread_get_argus_imagery, find_argus_imagery
# Deprecated camelCase aliases (backward compatibility)
from .getdata import removeDuplicatesFromDictionary
from .getdata import getArgusImagery, threadGetArgusImagery, findArgusImagery
from .getdata import forecastData, getSatelliteImagery, alt_PlotData
Comment thread
Copilot marked this conversation as resolved.
Comment thread
Copilot marked this conversation as resolved.
from .getdata import getArgusImagery, threadGetArgusImagery
from .plotting import conditions_plot, bin_data
from .cache import DataCache, get_cache, enable_cache, disable_cache, clear_cache

Expand All @@ -11,11 +16,19 @@
"getDataTestBed",
"gettime",
"getnc",
# New snake_case names (preferred)
"remove_duplicates_from_dictionary",
"get_argus_imagery",
"thread_get_argus_imagery",
"find_argus_imagery",
# Deprecated camelCase aliases (backward compatibility)
Comment on lines +19 to +24
"removeDuplicatesFromDictionary",
"forecastData",
"getSatelliteImagery",
"getArgusImagery",
"threadGetArgusImagery",
"findArgusImagery",
# Other exports
Comment on lines +19 to +29
"forecastData",
"getSatelliteImagery",
"alt_PlotData",
"conditions_plot",
"bin_data",
Expand Down
24 changes: 18 additions & 6 deletions murgtools/getdata/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,14 @@
the USACE Field Research Facility (FRF) Coastal Model Test Bed (CMTB).
"""

from .getDataFRF import (getObs, getDataTestBed, gettime, getnc, removeDuplicatesFromDictionary,
get_geotiff_extent, getArgusImagery, threadGetArgusImagery, findArgusImagery,
getArgusPixelIntensity)
# New snake_case function names (preferred)
from .getDataFRF import (getObs, getDataTestBed, gettime, getnc,
remove_duplicates_from_dictionary,
get_geotiff_extent, get_argus_imagery, thread_get_argus_imagery,
find_argus_imagery, getArgusPixelIntensity)
# Deprecated camelCase aliases (for backward compatibility)
from .getDataFRF import (removeDuplicatesFromDictionary,
getArgusImagery, threadGetArgusImagery, findArgusImagery)
from .getOutsideData import forecastData, getSatelliteImagery
from .getPlotData import alt_PlotData

Expand All @@ -20,13 +25,20 @@
"getDataTestBed",
"gettime",
"getnc",
# New snake_case names (preferred)
"remove_duplicates_from_dictionary",
"get_argus_imagery",
"thread_get_argus_imagery",
"find_argus_imagery",
# Deprecated camelCase aliases (backward compatibility)
"removeDuplicatesFromDictionary",
"forecastData",
"getSatelliteImagery",
"get_geotiff_extent",
"getArgusImagery",
"threadGetArgusImagery",
"findArgusImagery",
# Other exports
"forecastData",
"getSatelliteImagery",
"get_geotiff_extent",
"getArgusPixelIntensity",
"alt_PlotData",
]
Loading
Loading