Add Fuzzydict docstring #4846

Akhil-Sharma30 · 2025-02-13T19:07:14Z

Description

In this PR fixed the following bugs in pybamm.util.py:

pybamm.FuzzyDict.copy. needs docstring
pybamm.FuzzyDict. get_best_matches. document key arg
pybamm.FuzzyDict. search. document args. format code properly

Fixes #4845

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #)

Important checks:

Please confirm the following before marking the PR as ready for review:

No style issues: nox -s pre-commit
All tests pass: nox -s tests
The documentation builds: nox -s doctests
Code is commented for hard-to-understand areas
Tests added that prove fix is effective or that feature works

kratman · 2025-02-13T19:20:53Z

src/pybamm/util.py

+        Retrieves the value associated with a key, handling renamed terms and
+        suggesting closest matches if the key is not found.
+
+    _find_matches(search_key, known_keys)


Private methods should not be documented

Okay I have removed the private methods.

kratman · 2025-02-13T19:22:45Z

src/pybamm/util.py

+    __getitem__(key)
+        Retrieves the value associated with a key, handling renamed terms and
+        suggesting closest matches if the key is not found.


This is probably better documented as an example rather then the method itself

src/pybamm/util.py

codecov · 2025-02-13T19:33:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (9ec472d) to head (f262534).
Report is 7 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4846   +/-   ##
========================================
  Coverage    98.70%   98.70%           
========================================
  Files          303      303           
  Lines        23335    23335           
========================================
  Hits         23032    23032           
  Misses         303      303

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Saransh-cpp · 2025-02-13T21:14:12Z

src/pybamm/util.py

+        This method returns a new FuzzyDict object containing the same key-value pairs
+        as the original dictionary. It ensures that the copied dictionary retains
+        the fuzzy matching behavior.


This looks like an AI generated text 🙁

Anyways, it is redundant. The first sentence makes everything clear.

Suggested change

This method returns a new FuzzyDict object containing the same key-value pairs

as the original dictionary. It ensures that the copied dictionary retains

the fuzzy matching behavior.

Extremely sorry, I have re-written the doc-string and added an example case.

Saransh-cpp · 2025-02-13T21:16:02Z

src/pybamm/util.py

+    Features:
+    - Fuzzy matching using `difflib.get_close_matches` to suggest the closest keys.
+    - Custom error handling for specific key renamings with informative messages.
+    - Search functionality to find keys containing specific terms.
+    - Custom warnings for deprecated key names.


Does not add anything. I am not against AI, but it is always important to check the results before adding them in.

Suggested change

Features:

- Fuzzy matching using `difflib.get_close_matches` to suggest the closest keys.

- Custom error handling for specific key renamings with informative messages.

- Search functionality to find keys containing specific terms.

- Custom warnings for deprecated key names.

Saransh-cpp · 2025-02-13T21:16:45Z

src/pybamm/util.py

+    Methods:
+    get_best_matches(key)
+        Returns a list of the best-matching keys for a given input key.
+
+    search(keys, print_values=False)
+        Searches the dictionary for keys containing all specified terms. Prints
+        the results and, optionally, the corresponding values.
+
+    copy()
+        Returns a copy of the FuzzyDict instance.


Methods and their respective docstrings are automatically rendered in the docs

Suggested change

Methods:

get_best_matches(key)

Returns a list of the best-matching keys for a given input key.

search(keys, print_values=False)

Searches the dictionary for keys containing all specified terms. Prints

the results and, optionally, the corresponding values.

copy()

Returns a copy of the FuzzyDict instance.

Saransh-cpp · 2025-02-13T21:19:47Z

src/pybamm/util.py

+    This class extends the built-in `dict` to provide intelligent key lookup,
+    including approximate string matching and handling of renamed terms. It is
+    useful when working with parameter dictionaries where keys might have slight
+    variations, renamings, or formatting differences.


The first sentence captures the gist here too, so these lines look redundant to me.

Saransh-cpp · 2025-02-13T21:22:00Z

src/pybamm/util.py

+        as the original dictionary. It ensures that the copied dictionary retains
+        the fuzzy matching behavior.
+
+        Returns:


Suggested change

Returns:

Returns

-------

Saransh-cpp · 2025-02-14T10:31:06Z

src/pybamm/util.py

@@ -96,7 +130,7 @@ def _find_matches(self, search_key: str, known_keys: list[str]):
        Helper method to find exact and partial matches for a given search key.

        Parameters
-        ----------
+        -------


Suggested change

-------

----------

Saransh-cpp · 2025-02-14T10:31:17Z

src/pybamm/util.py

@@ -115,7 +149,7 @@ def search(self, keys: str | list[str], print_values: bool = False):
        the best matches are printed.

        Parameters
-        ----------
+        -------


Suggested change

-------

----------

Saransh-cpp · 2025-02-14T10:31:38Z

src/pybamm/util.py

+    Methods
+    -------
+    get_best_matches(key)
+        Returns a list of the best-matching keys for a given input key.
+
+    search(keys, print_values=False)
+        Searches the dictionary for keys containing all specified terms. Prints
+        the results and, optionally, the corresponding values.
+
+    copy()
+        Returns a copy of the FuzzyDict instance.
+


Suggested change

Methods

-------

get_best_matches(key)

Returns a list of the best-matching keys for a given input key.

search(keys, print_values=False)

Searches the dictionary for keys containing all specified terms. Prints

the results and, optionally, the corresponding values.

copy()

Returns a copy of the FuzzyDict instance.

Should I remove this section?

Saransh-cpp · 2025-02-14T10:33:46Z

src/pybamm/util.py

+    Example usage
+    -------
+    ```python
+        >>> params = FuzzyDict({
+        >>> "electrode diffusivity": 1.2,
+        >>> "particle diffusivity": 0.8,
+        >>> "Negative electrode SOC": 0.5,
+        >>> "Open-circuit voltage at 100% SOC [V]": 4.2,
+        >>> })
+
+        >>> print(params["electrode diffusivity"])  # 1.2 (direct access)
+        >>> print(params["particle diffusivity"])   # 0.8 (handles renaming)
+
+        >>> params.search("open circuit voltage")
+
+        >>> params_copy = params.copy()  # Creates a new FuzzyDict instance
+    ```
+    """


You will need to fix this examples as the doctests will fail

Suggested change

Example usage

-------

```python

>>> params = FuzzyDict({

>>> "electrode diffusivity": 1.2,

>>> "particle diffusivity": 0.8,

>>> "Negative electrode SOC": 0.5,

>>> "Open-circuit voltage at 100% SOC [V]": 4.2,

>>> })

>>> print(params["electrode diffusivity"]) # 1.2 (direct access)

>>> print(params["particle diffusivity"]) # 0.8 (handles renaming)

>>> params.search("open circuit voltage")

>>> params_copy = params.copy() # Creates a new FuzzyDict instance

```

"""

Examples

--------

>>> params = FuzzyDict({

>>> "electrode diffusivity": 1.2,

>>> "particle diffusivity": 0.8,

>>> "Negative electrode SOC": 0.5,

>>> "Open-circuit voltage at 100% SOC [V]": 4.2,

>>> })

>>> print(params["electrode diffusivity"])

1.2

>>> print(params["particle diffusivity"])

0.8

>>> params.search("open circuit voltage")

>>> params_copy = params.copy() # Creates a new FuzzyDict instance

"""

Modified the example.

Akhil-Sharma30 added 3 commits February 13, 2025 23:12

Add Doc-String for FuzzyDict class

bfa847c

Add doc-string for fuzzyDict.copy func

5c896d6

Fix the indentation

58e937e

Akhil-Sharma30 requested a review from a team as a code owner February 13, 2025 19:07

style: pre-commit fixes

2194231

kratman requested changes Feb 13, 2025

View reviewed changes

Remove the private func

577260a

Saransh-cpp requested changes Feb 13, 2025

View reviewed changes

Saransh-cpp reviewed Feb 13, 2025

View reviewed changes

Akhil-Sharma30 added 2 commits February 14, 2025 10:09

Docs: Re-worked on the FuzzyDict class doc-string

b8abf29

Docs: Improve formatting

f262534

Saransh-cpp requested changes Feb 14, 2025

View reviewed changes

agriyakhetarpal marked this pull request as draft February 17, 2025 02:32

Akhil-Sharma30 and others added 2 commits February 17, 2025 14:35

Add example in the doc-string

b3d8262

style: pre-commit fixes

a352e8f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Fuzzydict docstring #4846

Add Fuzzydict docstring #4846

Akhil-Sharma30 commented Feb 13, 2025

kratman Feb 13, 2025

Akhil-Sharma30 Feb 13, 2025

kratman Feb 13, 2025

codecov bot commented Feb 13, 2025 •

edited

Loading

Saransh-cpp Feb 13, 2025

Akhil-Sharma30 Feb 14, 2025

Saransh-cpp Feb 13, 2025

Saransh-cpp Feb 13, 2025

Saransh-cpp Feb 13, 2025

Saransh-cpp Feb 13, 2025

Saransh-cpp Feb 14, 2025

Saransh-cpp Feb 14, 2025

Saransh-cpp Feb 14, 2025

Akhil-Sharma30 Feb 17, 2025

Saransh-cpp Feb 14, 2025

Akhil-Sharma30 Feb 17, 2025

	This method returns a new FuzzyDict object containing the same key-value pairs
	as the original dictionary. It ensures that the copied dictionary retains
	the fuzzy matching behavior.

Add Fuzzydict docstring #4846

Are you sure you want to change the base?

Add Fuzzydict docstring #4846

Conversation

Akhil-Sharma30 commented Feb 13, 2025

Description

Type of change

Important checks:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Feb 13, 2025 • edited Loading

Codecov Report

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

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

codecov bot commented Feb 13, 2025 •

edited

Loading