Merge pull request #11 from European-XFEL/refactor/duplicate-find-proposal

refactor: remove duplicate find_proposal function

Author: tmichela

extra_proposal/mymdc.py

@@ -1,24 +1,15 @@
 import json
-import os
-from glob import iglob
-from pathlib import Path
 from urllib.parse import urljoin
 
 import yaml
 import requests
 from oauth2_xfel_client import Oauth2ClientBackend
 
+from .utils import find_proposal
+
 MYMDC_BASE_URL = "https://in.xfel.eu/metadata"
 ZWOP_BASE_URL  = "https://exfldadev01.desy.de/zwop"
 
-# Copied from extra-data
-def find_proposal(propno):
-    root_dir = Path(os.environ.get('EXTRA_DATA_DATA_ROOT', '/gpfs/exfel/exp'))
-    for d in iglob(str(root_dir / f'*/*/{propno}')):
-        return Path(d)
-
-    raise Exception(f"Couldn't find proposal dir for {propno!r}")
-
 
 class MyMdcAccess:
     _oauth_cache = {}  # Keyed by client ID

extra_proposal/proposal.py

@@ -1,41 +1,20 @@
 import fnmatch
 import glob
 import logging
-import os
 import re
 from datetime import datetime
 from functools import wraps
 from itertools import count, groupby
-from pathlib import Path
 from typing import Any, Optional
 
 import numpy as np
 
 from .mymdc import MyMdcAccess
+from .utils import data_root_dir, find_proposal
 
 logger = logging.getLogger(__name__)
 
 
-class ProposalNotFoundError(Exception):
-    """
-    Raised when the proposal is not found.
-    """
-
-    pass
-
-
-def data_root_dir():
-    return Path(os.environ.get('EXTRA_DATA_DATA_ROOT', '/gpfs/exfel/exp'))
-
-
-# Copied from extra-data
-def find_proposal(propno):
-    for d in data_root_dir().glob(f'*/*/{propno}'):
-        return d
-
-    raise ProposalNotFoundError(f"Proposal {propno!r} was not found")
-
-
 class RunReference:
     def __init__(self, proposal: 'Proposal', run_num: int):
         self.proposal = proposal

extra_proposal/utils.py

@@ -0,0 +1,20 @@
+import os
+from pathlib import Path
+
+class ProposalNotFoundError(Exception):
+    """
+    Raised when the proposal is not found.
+    """
+    pass
+
+
+def data_root_dir():
+    return Path(os.environ.get('EXTRA_DATA_DATA_ROOT', '/gpfs/exfel/exp'))
+
+
+# Copied from extra-data
+def find_proposal(propno):
+    for d in data_root_dir().glob(f'*/*/{propno}'):
+        return d
+
+    raise ProposalNotFoundError(f"Proposal {propno!r} was not found")

tests/test_mymdc_proposal.py

@@ -6,7 +6,7 @@
 import matplotlib.pyplot as plt
 
 from extra_proposal import Proposal
-from extra_proposal.proposal import ProposalNotFoundError
+from extra_proposal.utils import ProposalNotFoundError
 
 
 # Helper function to mock requests.get() for different endpoints