Rename Platform.list_models to .models/.scenarios

To be more consistent with existing Platform methods like
.regions() and .units():
- rename Platform.list_models to Platform.models
- rename Platform.list_scenarios to Platform.scenarios

RELEASE_NOTES.rst

@@ -8,8 +8,8 @@ All changes
 
   - :meth:`Platform.add_model` using :meth:`.Backend.add_model`
   - :meth:`Platform.add_scenario` using :meth:`.Backend.add_scenario`
-  - :meth:`Platform.list_models` using :meth:`.Backend.list_models`
-  - :meth:`Platform.list_scenarios` using :meth:`.Backend.list_scenarios`
+  - :meth:`Platform.models` using :meth:`.Backend.models`
+  - :meth:`Platform.scenarios` using :meth:`.Backend.scenarios`
   - :meth:`Platform.get_meta` using :meth:`.Backend.get_meta`
   - :meth:`Platform.set_meta` using :meth:`.Backend.set_meta`
   - :meth:`Platform.remove_meta` using :meth:`.Backend.remove_meta`

doc/README.rst

@@ -28,7 +28,8 @@ There are a number of guides out there, e.g. on docutils_.
 Building the docs locally
 -------------------------
 
-Install the dependencies, above.
+Install the dependencies, above. Repeat the installation steps on code changes
+of ixmp to be able to refer to the adapted code.
 
 From the command line, run::
 

doc/source/api-backend.rst

@@ -103,11 +103,11 @@ Backend API
       get_nodes
       get_scenarios
       get_units
-      list_models
-      list_scenarios
+      models
       open_db
       read_file
       remove_meta
+      scenarios
       set_doc
       set_log_level
       set_meta

doc/source/api.rst

@@ -37,10 +37,10 @@ Platform
       backend.base.Backend.close_db
       backend.base.Backend.get_doc
       backend.base.Backend.get_meta
-      backend.base.Backend.list_models
-      backend.base.Backend.list_scenarios
+      backend.base.Backend.models
       backend.base.Backend.open_db
       backend.base.Backend.remove_meta
+      backend.base.Backend.scenarios
       backend.base.Backend.set_doc
       backend.base.Backend.set_meta
 

ixmp/backend/base.py

@@ -73,7 +73,7 @@ def add_scenario(self, name: str):
         """
 
     @abstractmethod
-    def list_models(self) -> Generator[str, None, None]:
+    def models(self) -> Generator[str, None, None]:
         """ List existing model names
 
         Returns
@@ -82,7 +82,7 @@ def list_models(self) -> Generator[str, None, None]:
         """
 
     @abstractmethod
-    def list_scenarios(self) -> Generator[str, None, None]:
+    def scenarios(self) -> Generator[str, None, None]:
         """ List existing scenario names
 
         Returns

ixmp/backend/jdbc.py

@@ -361,11 +361,11 @@ def add_model(self, name):
     def add_scenario(self, name):
         self.jobj.addScenario(str(name))
 
-    def list_models(self) -> Generator[str, None, None]:
+    def models(self) -> Generator[str, None, None]:
         for model in self.jobj.listModels():
             yield str(model)
 
-    def list_scenarios(self) -> Generator[str, None, None]:
+    def scenarios(self) -> Generator[str, None, None]:
         for scenario in self.jobj.listScenarios():
             yield str(scenario)
 

ixmp/core.py

@@ -66,8 +66,8 @@ class Platform:
         'remove_meta',
         'add_model',
         'add_scenario',
-        'list_models',
-        'list_scenarios',
+        'models',
+        'scenarios',
     ]
 
     def __init__(self, name=None, backend=None, **backend_args):

ixmp/tests/backend/test_base.py

@@ -55,8 +55,8 @@ class BE2(Backend):
         item_set_elements = noop
         last_update = noop
         list_items = noop
-        list_models = noop
-        list_scenarios = noop
+        models = noop
+        scenarios = noop
         run_id = noop
         set_as_default = noop
         set_data = noop

ixmp/tests/core/test_platform.py

@@ -181,10 +181,10 @@ def test_weakref():
 
 def test_add_model(mp):
     mp.add_model('new_model_name')
-    assert 'new_model_name' in mp.list_models()
+    assert 'new_model_name' in mp.models()
 
 
 def test_add_scenario(mp):
     mp.add_scenario('new_scenario_name')
-    print(list(mp.list_scenarios()))
-    assert 'new_scenario_name' in mp.list_scenarios()
+    print(list(mp.scenarios()))
+    assert 'new_scenario_name' in mp.scenarios()