49 typing on cached module (#50)

Version 0.8.6

* Updating to solvis 0.11.1, solvis-store 2.0.3, nzshm-model 0.4.0.
* Adding Python 3.10 + 3.11, removing 3.7 + 3.8
* Improving typing information on composite_solution/cached.py (#49)
* parent_fault_names passes through sorting parameter
---------

Co-authored-by: Chris Chamberlain <[email protected]>

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.5
+current_version = 0.8.6
 commit = True
 tag = True
 

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.8.6] - 2024-06-12
+### Added
+ - More type hinting for composite_solution/cached.py
+ - Testing against Python 3.10, 3.11
+### Changed
+ - Update to use solvis 0.11.1
+ - Update to use solvis-store 2.0.3
+ - Update to use nzshm-model 0.4.0
+### Removed
+ - Testing against Python 3.7, 3.8
+### Fixed
+ - parent_fault_names passes through sorting parameter
+
 ## [0.8.5] - 2023-08-02
 ### Changed
  - solvis-store == v2.0.2
@@ -9,7 +22,7 @@
 ## [0.8.4] - 2023-07-19
 ### Added
  - version config for package.json
- 
+
 ## [0.8.3] - 2023-07-19
 ### Added
  - new filter_set_options argument
@@ -18,7 +31,7 @@
 ### Changed
  - updated upstream solvis libs
  - removed monkeypatching for solvis/solvis-store
- 
+
 ## [0.8.2] - 2023-07-04
 ### Changed
  - added list support for corupture queries
@@ -93,7 +106,7 @@
 
 ## [0.2.0] - 2022-??-??
 ### Added
- - InversionSolutoin 
+ - InversionSolutoin
 
 ## [0.0.1] - 2022-??-??
 Initial release of the NZ NSHM 2022 revision

package.json

@@ -1,6 +1,6 @@
 {
   "name": "solvis-graphql-api",
-  "version": "0.8.5",
+  "version": "0.8.6",
   "description": "A graphql API for analysis and geojson visualisation from NZSHM Inversion Solutions.",
   "dependencies": {
     "serverless": "^3.30.1",

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "solvis-graphql-api"
-version = "0.8.5"
+version = "0.8.6"
 description = "Graphql API for analysis of opensha modular Inversion Solutions"
 authors = ["Chris Chamberlain <[email protected]>"]
 license = "AGPL3"
@@ -14,6 +14,7 @@ classifiers=[
     'Programming Language :: Python :: 3',
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
 ]
 packages = [{include = "solvis_graphql_api"}]
 
@@ -25,17 +26,16 @@ Flask-GraphQL = "^2.0.1"
 graphene = "<3"
 pyyaml = "^6.0"
 
-nzshm-model = "^0.3.0"
+nzshm-model = "^0.4.0"
 nzshm-common = "^0.6.0"
-# solvis = "^0.7.0"
-solvis = "^0.8.1"
-solvis-store = {git = "https://github.com/GNS-Science/solvis-store", rev = "v2.0.2"}
+solvis = "^0.11.1"
+solvis-store = {git = "https://github.com/GNS-Science/solvis-store", rev = "v2.0.3"}
 
 matplotlib = "^3.7.1"
 werkzeug = "^2.3.3"
 
 # see https://github.com/orgs/python-poetry/discussions/7937
-urllib3 = "<2" 
+urllib3 = "<2"
 numpy = "<1.25"
 
 [tool.poetry.group.dev.dependencies]
@@ -44,7 +44,7 @@ black  = { version = "^22.3"}
 isort  = { version = "^5.8.0"}
 flake8  = { version = "^3.9.2"}
 flake8-docstrings = { version = "^1.6.0", optional = true }
-mypy = {version = "^0.900"}
+mypy = {version = "^1.10"}
 pytest = { version = "^6.2.4"}
 pytest-cov  = { version = "^2.12.0"}
 
@@ -98,7 +98,7 @@ doc = [
 [tool.black]
 line-length = 120
 skip-string-normalization = true
-target-version = ['py37', 'py38', 'py39']
+target-version = ['py39', 'py310', 'py311']
 include = '\.pyi?$'
 exclude = '''
 /(

setup.cfg

@@ -44,10 +44,11 @@ exclude_lines =
 
 [tox:tox]
 isolated_build = true
-envlist = py39, py310, format, lint, build
+envlist = py39, py310, py311, format, lint, build
 
 [gh-actions]
 python =
+    3.11: py311
     3.10: py310
     3.9: py39, format, lint, build
 

solvis_graphql_api/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """GNS Science"""
 __email__ = '[email protected]'
-__version__ = '0.8.5'
+__version__ = '0.8.6'

solvis_graphql_api/composite_solution/cached.py

@@ -5,7 +5,7 @@
 import time
 from functools import lru_cache
 from pathlib import Path
-from typing import Any, Callable, Iterable, Iterator, List, Set, Tuple, Union
+from typing import Any, Callable, Iterable, Iterator, List, Set, Tuple, Union, TYPE_CHECKING
 
 import geopandas as gpd
 import nzshm_model
@@ -16,6 +16,10 @@
 
 from .filter_set_logic_options import SetOperationEnum
 
+if TYPE_CHECKING:
+    import shapely.geometry.polygon.Polygon
+    from nzshm_model.source_logic_tree.logic_tree import SourceLogicTree
+
 log = logging.getLogger(__name__)
 
 FAULT_SECTION_LIMIT = 1e4
@@ -25,15 +29,16 @@
 
 
 @lru_cache
-def get_location_polygon(radius_km, lon, lat):
+def get_location_polygon(radius_km: float, lon: float, lat: float) -> "shapely.geometry.polygon.Polygon":
     return solvis.geometry.circle_polygon(radius_m=radius_km * 1000, lon=lon, lat=lat)
 
 
 @lru_cache
 def parent_fault_names(
-    sol: InversionSolutionProtocol, sort: Union[None, Callable[[Iterable], List]] = sorted
+    sol: InversionSolutionProtocol, sort: Union[None, Callable[[Iterable[str]], Iterable[str]]] = sorted
 ) -> List[str]:
-    return solvis.parent_fault_names(sol)
+    fault_names: List[str] = solvis.parent_fault_names(sol, sort)
+    return fault_names
 
 
 @lru_cache
@@ -58,23 +63,29 @@ def get_composite_solution(model_id: str) -> solvis.CompositeSolution:
 
 
 def get_rupture_ids_for_fault_names_stored(
-    model_id: str, fault_system: str, fault_names: Iterable[str], filter_set_options
-) -> Iterator[int]:
+    model_id: str, fault_system: str, fault_names: Iterable[str], filter_set_options: Tuple[Any]
+) -> Set[int]:
     log.info('get_rupture_ids_for_fault_names_stored: %s %s %s' % (model_id, fault_system, fault_names))
     filter_set_options_dict = dict(filter_set_options)
     fss = get_fault_system_solution_for_model(model_id, fault_system)
     ruptset_ids = list(set([branch.rupture_set_id for branch in fss.branches]))
     assert len(ruptset_ids) == 1
     rupture_set_id = ruptset_ids[0]
     union = False if filter_set_options_dict["multiple_faults"] == SetOperationEnum.INTERSECTION else True
-    return get_fault_name_rupture_ids(rupture_set_id, fault_names, union)
+
+    rupture_id_set: Set[int] = get_fault_name_rupture_ids(rupture_set_id, fault_names, union)
+    return rupture_id_set
 
 
-def get_fault_system_solution_for_model(model_id, fault_system):
+def get_fault_system_solution_for_model(
+    model_id: str, fault_system: str
+) -> "nzshm_model.source_logic_tree.logic_tree.FaultSystemLogicTree":
     current_model = nzshm_model.get_model_version(model_id)
     slt = current_model.source_logic_tree()
 
-    def get_fss(slt, fault_system):
+    def get_fss(
+        slt: "SourceLogicTree", fault_system: str
+    ) -> "nzshm_model.source_logic_tree.logic_tree.FaultSystemLogicTree":
         for fss in slt.fault_system_lts:
             if fss.short_name == fault_system:
                 return fss
@@ -86,7 +97,10 @@ def get_fss(slt, fault_system):
 
 
 def get_rupture_ids_for_location_radius(
-    fault_system_solution, location_ids, radius_km, filter_set_options: Tuple[Any]
+    fault_system_solution: InversionSolutionProtocol,
+    location_ids: Iterable[str],
+    radius_km: float,
+    filter_set_options: Tuple[Any],
 ) -> Set[int]:
     log.info('get_rupture_ids_for_location_radius: %s %s %s' % (fault_system_solution, radius_km, location_ids))
     filter_set_options_dict = dict(filter_set_options)
@@ -130,9 +144,10 @@ def get_rupture_ids_for_location_radius_stored(
     union = False if filter_set_options_dict["multiple_locations"] == SetOperationEnum.INTERSECTION else True
     # print("filter_dataframe_by_radius_stored", radius_km)
     # print("get_rupture_ids_for_location_radius_stored", radius_km)
-    return get_location_radius_rupture_ids(
+    rupture_ids: Iterator[int] = get_location_radius_rupture_ids(
         rupture_set_id=rupture_set_id, locations=location_ids, radius=radius_km, union=union
     )
+    return rupture_ids
 
 
 @lru_cache
@@ -141,7 +156,9 @@ def get_rupture_ids_for_parent_fault(fault_system_solution: InversionSolutionPro
 
 
 def get_rupture_ids_for_fault_names(
-    fault_system_solution, corupture_fault_names, filter_set_options: Tuple[Any]
+    fault_system_solution: InversionSolutionProtocol,
+    corupture_fault_names: Iterable[str],
+    filter_set_options: Tuple[Any],
 ) -> Set[int]:
     filter_set_options_dict = dict(filter_set_options)
     fss = fault_system_solution
@@ -198,7 +215,7 @@ def matched_rupture_sections_gdf(
     tic1 = time.perf_counter()
     log.debug('matched_rupture_sections_gdf(): time to load fault system solution: %2.3f seconds' % (tic1 - tic0))
 
-    df0 = fss.ruptures_with_rates
+    df0 = fss.ruptures_with_rupture_rates
 
     # attribute filters
     df0 = df0 if not max_mag else df0[df0.Magnitude <= max_mag]
@@ -282,7 +299,7 @@ def fault_section_aggregates_gdf(
     tic2 = time.perf_counter()
     log.debug('fault_section_aggregates_gdf(): time to filter rupture sections: %2.3f seconds' % (tic2 - tic1))
 
-    fsr = fss.fault_sections_with_rates
+    fsr = fss.fault_sections_with_rupture_rates
     fsr = fsr[fsr['Rupture Index'].isin(df0['Rupture Index'].unique())]
 
     tic3 = time.perf_counter()

solvis_graphql_api/composite_solution/composite_rupture_detail.py

@@ -23,7 +23,7 @@
 
 @lru_cache
 def rupture_detail(model_id: str, fault_system: str, rupture_index: int):
-    sr = get_composite_solution(model_id)._solutions[fault_system].ruptures_with_rates
+    sr = get_composite_solution(model_id)._solutions[fault_system].ruptures_with_rupture_rates
     return sr[sr['Rupture Index'] == rupture_index]
 
 

solvis_graphql_api/composite_solution/composite_rupture_sections.py

@@ -224,13 +224,14 @@ def resolve_fault_surfaces(root, info, *args, **kwargs):
             fault_sections_gdf['stroke-width'] = stroke_width
             fault_sections_gdf['stroke-opacity'] = stroke_opacity
 
+        log.debug(f"columns: {fault_sections_gdf.columns}")
         fault_sections_gdf = fault_sections_gdf.drop(
             columns=[
                 'rate_weighted_mean.max',
                 'rate_weighted_mean.min',
                 'rate_weighted_mean.mean',
-                "SlipRate",
-                "SlipRateStdDev",
+                'Target Slip Rate',
+                'Target Slip Rate StdDev',
             ]
         )
         # import solvis
@@ -275,8 +276,8 @@ def resolve_fault_traces(root, info, *args, **kwargs):
                 'rate_weighted_mean.max',
                 'rate_weighted_mean.min',
                 'rate_weighted_mean.mean',
-                "SlipRate",
-                "SlipRateStdDev",
+                'Target Slip Rate',
+                'Target Slip Rate StdDev',
             ]
         )
         # import solvis