MNT #14 rename

apsbss/apsbss.py

@@ -158,7 +158,7 @@ def epicsUpdate(prefix):
 
     if len(esaf_id) > 0:
         bss.status_msg.put(f"get ESAF {esaf_id} from APS ...")
-        esaf = server.get_esaf(esaf_id)
+        esaf = server.esaf(esaf_id)
 
         bss.status_msg.put("set ESAF PVs ...")
         bss.esaf.description.put(esaf["description"])
@@ -184,7 +184,7 @@ def epicsUpdate(prefix):
 
     if len(proposal_id) > 0:
         bss.status_msg.put(f"get Proposal {proposal_id} from APS ...")
-        proposal = server.get_proposal(proposal_id, beamline, run)
+        proposal = server.proposal(proposal_id, beamline, run)
 
         bss.status_msg.put("set Proposal PVs ...")
         bss.proposal.end_date.put(proposal["endTime"])
@@ -509,7 +509,7 @@ def cmd_esaf(args):
         Object returned by ``argparse``
     """
     try:
-        esaf = server.get_esaf(args.esafId)
+        esaf = server.esaf(args.esafId)
         print(yaml.dump(esaf))
     except Exception as reason:
         print(f"DM reported: {reason}")
@@ -577,7 +577,7 @@ def cmd_proposal(args):
         Object returned by ``argparse``
     """
     try:
-        proposal = server.get_proposal(args.proposalId, args.beamlineName, args.run)
+        proposal = server.proposal(args.proposalId, args.beamlineName, args.run)
         print(yaml.dump(proposal))
     except Exception as reason:
         print(f"DM reported: {reason}")

apsbss/servers.py

@@ -46,8 +46,9 @@ class Server:
         ~current_esafs_and_proposals
         ~current_proposals
         ~current_run
+        ~esaf
         ~esafs
-        ~get_proposal
+        ~proposal
         ~proposals
         ~recent_runs
         ~_runs
@@ -174,8 +175,7 @@ def esafs(self, sector, run):
 
         return results
 
-    # TODO: rename to esaf
-    def get_esaf(self, esaf_id):
+    def esaf(self, esaf_id):
         """
         Return ESAF as a dictionary.
 
@@ -191,8 +191,7 @@ def get_esaf(self, esaf_id):
             raise EsafNotFound(f"{esaf_id=!r}")
         return dict(record.data)
 
-    # TODO: rename to proposal
-    def get_proposal(self, proposal_id, beamline, run):
+    def proposal(self, proposal_id, beamline, run):
         """
         Return proposal as a dictionary.
 

apsbss/tests/test_servers.py

@@ -41,9 +41,9 @@ def test_Server_raises():
     assert "Could not find run='1915-1'" in str(reason)
 
     with pytest.raises(EsafNotFound) as reason:
-        server.get_esaf("1")
+        server.esaf("1")
     assert "esaf_id='1'" in str(reason)
 
     with pytest.raises(ProposalNotFound) as reason:
-        server.get_proposal(1, "8-ID-I", "2024-3")
+        server.proposal(1, "8-ID-I", "2024-3")
     assert "proposal_id='1' beamline='8-ID-I' run='2024-3'" in str(reason)