Deprecation warning and function cleanup before 25.1 (#4748)

* Remove an old deprecation warning

* Fix outdated syntax

* Get rid of unused function

Author: kratman

docs/source/api/util.rst

@@ -1,8 +1,6 @@
 Utility functions
 =================
 
-.. autofunction:: pybamm.get_git_commit_info
-
 .. autofunction:: pybamm.root_dir
 
 .. autoclass:: pybamm.Timer

examples/scripts/minimal_example_of_lookup_tables.py

@@ -19,7 +19,7 @@ def process_2D(name, data):
     return formatted_data
 
 
-parameter_values = pybamm.ParameterValues(pybamm.parameter_sets.Chen2020)
+parameter_values = pybamm.ParameterValues("Chen2020")
 
 # overwrite the diffusion coefficient with a 2D lookup table
 D_s_n = parameter_values["Negative particle diffusivity [m2.s-1]"]

src/pybamm/__init__.py

@@ -16,7 +16,6 @@
     has_jax,
     import_optional_dependency,
     is_jax_compatible,
-    get_git_commit_info,
 )
 from .logger import logger, set_logging_level, get_new_logger
 from .settings import settings

src/pybamm/models/base_model.py

@@ -1151,7 +1151,7 @@ def info(self, symbol_name):
 
         Parameters
         ----------
-        parameter_name : str
+        symbol_name : str
         """
         # Should we deprecate this? Not really sure how it's used?
 

src/pybamm/parameters/parameter_sets.py

@@ -1,5 +1,4 @@
 import sys
-import warnings
 import importlib.metadata
 import textwrap
 from collections.abc import Mapping
@@ -79,22 +78,6 @@ def get_docstring(self, key):
         """Return the docstring for the ``key`` parameter set"""
         return textwrap.dedent(self.__load_entry_point__(key).__doc__)
 
-    def __getattribute__(self, name):
-        try:
-            return super().__getattribute__(name)
-        except AttributeError as error:
-            # For backwards compatibility, parameter sets that used to be defined in
-            # this file now return the name as a string, which will load the same
-            # parameter set as before when passed to `ParameterValues`
-            if name in self:
-                msg = (
-                    f"Parameter sets should be called directly by their name ({name}), "
-                    f"instead of via pybamm.parameter_sets (pybamm.parameter_sets.{name})."
-                )
-                warnings.warn(msg, DeprecationWarning, stacklevel=2)
-                return name
-            raise error
-
 
 #: Singleton Instance of :class:ParameterSets """
 parameter_sets = ParameterSets()

src/pybamm/util.py

@@ -5,7 +5,6 @@
 import os
 import pathlib
 import pickle
-import subprocess
 import timeit
 import difflib
 from warnings import warn
@@ -23,23 +22,6 @@ def root_dir():
     return str(pathlib.Path(pybamm.__path__[0]).parent.parent)
 
 
-def get_git_commit_info():
-    """
-    Get the git commit info for the current PyBaMM version, e.g. v22.8-39-gb25ce8c41
-    (version 22.8, commit b25ce8c41)
-    """
-    try:
-        # Get the latest git commit hash
-        return str(
-            subprocess.check_output(["git", "describe", "--tags"], cwd=root_dir())
-            .strip()
-            .decode()
-        )
-    except subprocess.CalledProcessError:  # pragma: no cover
-        # Not a git repository so just return the version number
-        return f"v{pybamm.__version__}"
-
-
 class FuzzyDict(dict):
     def get_best_matches(self, key):
         """Get best matches from keys"""
@@ -370,7 +352,6 @@ def is_constant_and_can_evaluate(symbol):
         return False
 
 
-# https://docs.pybamm.org/en/latest/source/user_guide/contributing.html#managing-optional-dependencies-and-their-imports
 def import_optional_dependency(module_name, attribute=None):
     err_msg = f"Optional dependency {module_name} is not available. See https://docs.pybamm.org/en/latest/source/user_guide/installation/index.html#optional-dependencies for more details."
     try:

tests/unit/test_parameters/test_parameter_sets_class.py

@@ -11,10 +11,6 @@ def test_name_interface(self):
         """Test that pybamm.parameters_sets.<ParameterSetName> returns
         the name of the parameter set and a depreciation warning
         """
-        with pytest.warns(DeprecationWarning):
-            out = pybamm.parameter_sets.Marquis2019
-            assert out == "Marquis2019"
-
         # Expect an error for parameter sets that aren't real
         with pytest.raises(AttributeError):
             pybamm.parameter_sets.not_a_real_parameter_set

tests/unit/test_util.py

@@ -96,11 +96,6 @@ def test_get_parameters_filepath(self):
     def test_is_jax_compatible(self):
         assert pybamm.is_jax_compatible()
 
-    def test_git_commit_info(self):
-        git_commit_info = pybamm.get_git_commit_info()
-        assert isinstance(git_commit_info, str)
-        assert git_commit_info[:2] == "v2"
-
     def test_import_optional_dependency(self):
         optional_distribution_deps = get_optional_distribution_deps("pybamm")
         present_optional_import_deps = get_present_optional_import_deps(