GEOPY-2739: Accept BaseUIJson in the start of driver by domfournier · Pull Request #860 · MiraGeoscience/geoh5py

domfournier · 2026-03-21T15:23:25Z

GEOPY-2739 - Accept BaseUIJson in the start of driver

Copilot

Pull request overview

This PR updates the UI JSON model naming by renaming the core BaseUIJson class to UIJson, and adjusts tests/imports accordingly to match the new API surface.

Changes:

Rename BaseUIJson to UIJson in geoh5py.ui_json.ui_json.
Update UI JSON tests to subclass/use UIJson instead of BaseUIJson.
Update the geoh5py.ui_json package export to re-export UIJson.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
geoh5py/ui_json/ui_json.py	Renames the core model class and updates `read()` logic/type hints to reference `UIJson`.
geoh5py/ui_json/init.py	Switches the package-level export from `BaseUIJson` to `UIJson`.
tests/ui_json/uijson_test.py	Updates tests to use `UIJson` for subclassing/reading.
tests/ui_json/forms_test.py	Updates helper test model to subclass `UIJson`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-21T15:25:49Z

geoh5py/ui_json/ui_json.py

    @classmethod
-    def read(cls, path: str | Path) -> BaseUIJson:
+    def read(cls, path: str | Path) -> UIJson:


read can return an instance of a subclass when called as MyUIJson.read(...), but the return type is annotated as UIJson. This makes the public API typing inaccurate and can cause mypy/IDE issues. Consider typing it as Self (e.g., cls: type[Self] -> Self) or using overloads to express the UIJson vs subclass behavior.

Copilot · 2026-03-21T15:25:49Z

geoh5py/ui_json/ui_json.py

        """
        Create a UIJson object from ui.json file.



The read method docstring still mentions BaseUIJson (a name that no longer exists after this rename). Please update the wording to UIJson (or remove the class-name reference) so the documentation matches the current API.

Copilot · 2026-03-21T15:25:50Z

geoh5py/ui_json/ui_json.py


-class BaseUIJson(BaseModel):
+class UIJson(BaseModel):
    """
    Base class for storing ui.json data on disk.



Renaming BaseUIJson to UIJson and removing the old symbol is a breaking public API change (it was previously importable from geoh5py.ui_json). If backward compatibility is expected, consider keeping BaseUIJson as a deprecated alias of UIJson (and optionally emitting a DeprecationWarning) to avoid breaking downstream imports.

Copilot · 2026-03-21T15:25:50Z

geoh5py/ui_json/__init__.py

 from .validation import InputValidation
 from .forms import BaseForm
-from .ui_json import BaseUIJson
+from .ui_json import UIJson


This change drops the BaseUIJson re-export from geoh5py.ui_json, which is a breaking import for external callers (from geoh5py.ui_json import BaseUIJson). If the rename is intended, consider re-exporting a deprecated BaseUIJson alias alongside UIJson, or ensure the project versioning/release notes explicitly cover the breaking change.

Suggested change

from .ui_json import UIJson

from .ui_json import UIJson

# Backwards-compatible alias: BaseUIJson was renamed to UIJson.

# External callers may still import BaseUIJson from geoh5py.ui_json.

BaseUIJson = UIJson

codecov · 2026-03-21T15:56:00Z

Codecov Report

❌ Patch coverage is 95.67568% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.28%. Comparing base (8a2adcc) to head (772781b).
⚠️ Report is 9 commits behind head on develop.

Files with missing lines	Patch %	Lines
geoh5py/objects/grid_object.py	76.92%	1 Missing and 2 partials ⚠️
geoh5py/ui_json/ui_json.py	94.73%	1 Missing and 2 partials ⚠️
geoh5py/data/__init__.py	85.71%	0 Missing and 1 partial ⚠️
geoh5py/data/data_association_enum.py	85.71%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #860      +/-   ##
===========================================
+ Coverage    91.18%   91.28%   +0.10%     
===========================================
  Files          115      112       -3     
  Lines        10298    10317      +19     
  Branches      1901     1900       -1     
===========================================
+ Hits          9390     9418      +28     
+ Misses         485      474      -11     
- Partials       423      425       +2

Files with missing lines	Coverage Δ
geoh5py/objects/block_model.py	`98.50% <100.00%> (+0.09%)`	⬆️
geoh5py/objects/grid2d.py	`89.65% <100.00%> (+0.29%)`	⬆️
geoh5py/shared/utils.py	`91.03% <100.00%> (-0.27%)`	⬇️
geoh5py/shared/validators.py	`92.85% <ø> (-0.17%)`	⬇️
geoh5py/ui_json/__init__.py	`100.00% <100.00%> (ø)`
geoh5py/ui_json/annotations.py	`100.00% <100.00%> (ø)`
geoh5py/ui_json/forms.py	`95.17% <100.00%> (-0.02%)`	⬇️
geoh5py/ui_json/utils.py	`84.56% <100.00%> (+0.19%)`	⬆️
geoh5py/ui_json/validation.py	`88.32% <100.00%> (+4.07%)`	⬆️
geoh5py/data/__init__.py	`98.36% <85.71%> (-1.64%)`	⬇️
... and 3 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.

for more information, see https://pre-commit.ci

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

for more information, see https://pre-commit.ci

# Conflicts: # geoh5py/ui_json/annotations.py # geoh5py/ui_json/forms.py # geoh5py/ui_json/validations/form.py

…tion # Conflicts: # geoh5py/shared/utils.py # geoh5py/ui_json/annotations.py # geoh5py/ui_json/forms.py # geoh5py/ui_json/ui_json.py

…into GEOPY-2657

# Conflicts: # geoh5py/ui_json/ui_json.py # geoh5py/ui_json/validations/form.py

…into GEOPY-2739 # Conflicts: # geoh5py/ui_json/ui_json.py # geoh5py/ui_json/validations/__init__.py # geoh5py/ui_json/validations/uijson.py

# Conflicts: # geoh5py/ui_json/ui_json.py # geoh5py/ui_json/validations/__init__.py # geoh5py/ui_json/validations/uijson.py # tests/ui_json/uijson_test.py

Rename class BaseUIJson -> UIJson

1d84b82

Copilot AI review requested due to automatic review settings March 21, 2026 15:23

github-actions bot changed the title ~~GEOPY-2739~~ GEOPY-2739: Accept BaseUIJson in the start of driver Mar 21, 2026

Copilot started reviewing on behalf of domfournier March 21, 2026 15:23 View session

Copilot AI reviewed Mar 21, 2026

View reviewed changes

domfournier and others added 24 commits March 21, 2026 09:12

MOve validation. Rename method

b62fc6b

[pre-commit.ci] auto fixes from pre-commit.com hooks

6572a04

for more information, see https://pre-commit.ci

Rename tests for input file

b38218b

remove unused class

b581773

Clean ups and rename

8754ffc

Move annotations to common module

d129c2e

Add entity_to_uuid as BeforeValidators

cbbfedc

Augment tests

e82db86

Add set_value to forms. Update test

9967ed4

Change set value for the is_value case

edd7df2

Clean ups and augment test

4a5914c

Update tests/ui_json/forms_test.py

dfe9abb

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

2cd3d0f

for more information, see https://pre-commit.ci

MOve things around. Remove duplicated functions for stringify

0c8ff25

# Conflicts: # geoh5py/ui_json/annotations.py # geoh5py/ui_json/forms.py # geoh5py/ui_json/validations/form.py

Use annotated DataTypeEnum instead of new Enum. Remove duplicate func…

973a036

…tion # Conflicts: # geoh5py/shared/utils.py # geoh5py/ui_json/annotations.py # geoh5py/ui_json/forms.py # geoh5py/ui_json/ui_json.py

Update tests

7ddb8e6

Merge branch 'develop' into GEOPY-2657

087e1b7

Remove unused Enums

493d067

Merge branch 'GEOPY-2657' of https://github.com/MiraGeoscience/geoh5py …

2bd1726

…into GEOPY-2657

Add docstrings

e962783

Merge branch 'GEOPY-2657' into GEOPY-2762

6f2a403

# Conflicts: # geoh5py/ui_json/ui_json.py # geoh5py/ui_json/validations/form.py

Fix imports

c73b884

Replace duplicated methods

7efd632

Merge branch 'GEOPY-2739' of https://github.com/MiraGeoscience/geoh5py …

fff1fa6

…into GEOPY-2739 # Conflicts: # geoh5py/ui_json/ui_json.py # geoh5py/ui_json/validations/__init__.py # geoh5py/ui_json/validations/uijson.py

Merge branch 'GEOPY-2762' into GEOPY-2739

772781b

# Conflicts: # geoh5py/ui_json/ui_json.py # geoh5py/ui_json/validations/__init__.py # geoh5py/ui_json/validations/uijson.py # tests/ui_json/uijson_test.py

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GEOPY-2739: Accept BaseUIJson in the start of driver#860

GEOPY-2739: Accept BaseUIJson in the start of driver#860
domfournier wants to merge 26 commits intodevelopfrom
GEOPY-2739

domfournier commented Mar 21, 2026 •

edited by github-actions bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 21, 2026

Uh oh!

Copilot AI Mar 21, 2026

Uh oh!

Copilot AI Mar 21, 2026

Uh oh!

Copilot AI Mar 21, 2026

Uh oh!

codecov bot commented Mar 21, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-from .ui_json import UIJson
+from .ui_json import UIJson
+# Backwards-compatible alias: BaseUIJson was renamed to UIJson.
+# External callers may still import BaseUIJson from geoh5py.ui_json.
+BaseUIJson = UIJson

Conversation

domfournier commented Mar 21, 2026 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

domfournier commented Mar 21, 2026 •

edited by github-actions bot

Loading

codecov bot commented Mar 21, 2026 •

edited

Loading