Skip to content

Commit 4fe97c0

Browse files
chores: improve consitency of logging messages regardless the backend or downloader selected.
1 parent 4260a86 commit 4fe97c0

4 files changed

Lines changed: 26 additions & 31 deletions

File tree

ontograph/client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ def load(
376376
>>> client = ClientOntology()
377377
>>> client.load(source="./tests/resources/dummy_ontology.obo")
378378
"""
379-
logger.info(f'Loading ontology from source: {source} ...')
379+
logger.info('Loading ontology: %s', source)
380380
resolved_downloader = (
381381
_resolve_downloader(self._cache_dir, downloader)
382382
if downloader is not None
@@ -397,15 +397,15 @@ def load(
397397

398398
# 1. Case 1: Local file exists
399399
if path.exists():
400-
logger.debug('Resolved source type: file')
400+
logger.debug('Resolved source: %s -> file', source)
401401
logger.info(
402402
f'Found local file at {path}, loading with ProntoLoaderAdapter...'
403403
)
404404
ontology = loader.load_from_file(file_path_ontology=path)
405405

406406
# 2. Case 2: Provided source is a URL
407407
elif re.match(r'^https?://', source):
408-
logger.debug('Resolved source type: url')
408+
logger.debug('Resolved source: %s -> url', source)
409409
logger.info(
410410
f'Detected URL source, downloading ontology from {source}'
411411
)
@@ -416,7 +416,7 @@ def load(
416416

417417
# 3. Case 3: Try OBO catalog (if file missing or simple ID)
418418
else:
419-
logger.debug('Resolved source type: catalog')
419+
logger.debug('Resolved source: %s -> catalog', source)
420420
catalog_client = ClientCatalog(
421421
cache_dir=self._cache_dir,
422422
downloader=resolved_downloader,

ontograph/downloader.py

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -91,17 +91,23 @@ def get_default_downloader(
9191
from ontograph.config.settings import DEFAULT_DOWNLOADER
9292

9393
selection = (backend or DEFAULT_DOWNLOADER).strip().lower()
94-
logger.info('Selected default downloader backend: %s', selection)
94+
logger.info(
95+
'Downloader selected: %s (%s)',
96+
selection,
97+
'PoochDownloaderAdapter'
98+
if selection == 'pooch'
99+
else 'DownloadManagerAdapter',
100+
)
95101
if selection == 'pooch':
96102
logger.debug(
97-
'Instantiating downloader: %s (cache_dir=%s)',
103+
'Downloader init: %s (cache_dir=%s)',
98104
PoochDownloaderAdapter.__name__,
99105
cache_dir,
100106
)
101107
return PoochDownloaderAdapter(cache_dir=cache_dir)
102108
if selection == 'download_manager':
103109
logger.debug(
104-
'Instantiating downloader: %s (cache_dir=%s)',
110+
'Downloader init: %s (cache_dir=%s)',
105111
DownloadManagerAdapter.__name__,
106112
cache_dir,
107113
)
@@ -156,17 +162,17 @@ def fetch_from_url(self, url_ontology: str, filename: str | None) -> Path:
156162
"""
157163
self._validate_download_parameters(url_ontology, filename)
158164

159-
logger.info('Pooch download started: %s -> %s', url_ontology, filename)
165+
logger.info('Download start: %s -> %s', url_ontology, filename)
160166
try:
161167
result_path = self._perform_download(url_ontology, filename)
162168
self._resources_paths[filename.split('.')[0]] = result_path
163-
logger.debug('Pooch download completed: %s', result_path)
169+
logger.debug('Download success: %s', result_path)
164170
return result_path
165171
except requests.RequestException as e:
166-
logger.error('Failed to download ontology: %s', e)
172+
logger.error('Download failed: %s', e)
167173
raise
168174
except OSError as e:
169-
logger.error('Failed to save downloaded ontology: %s', e)
175+
logger.error('Download failed: %s', e)
170176
raise
171177

172178
def _validate_download_parameters(
@@ -187,7 +193,7 @@ def _perform_download(self, url_ontology: str, filename: str) -> Path:
187193
progressbar=True,
188194
)
189195
result_path = Path(resource_path)
190-
logger.debug('Successfully downloaded ontology to %s', result_path)
196+
logger.debug('Download success: %s', result_path)
191197
return result_path
192198

193199
def fetch_from_catalog(
@@ -211,7 +217,7 @@ def fetch_from_catalog(
211217
if not resources:
212218
raise ValueError('Resources list for batch download is empty.')
213219

214-
logger.debug('Fetching %s resources from catalog', len(resources))
220+
logger.debug('Catalog batch download: %s items', len(resources))
215221
results = {}
216222
for resource in resources:
217223
name_id, format_type = self._extract_resource_info(resource)
@@ -316,16 +322,14 @@ def fetch_from_url(self, url_ontology: str, filename: str | None) -> Path:
316322
self._validate_download_parameters(url_ontology, filename)
317323

318324
dest = self._cache_dir / filename
319-
logger.info(
320-
'DownloadManager download started: %s -> %s', url_ontology, dest
321-
)
325+
logger.info('Download start: %s -> %s', url_ontology, dest)
322326
result_path = self._manager.download(url_ontology, dest=str(dest))
323327
if not result_path:
324328
raise OSError('Download manager did not return a file path.')
325329

326330
result = Path(result_path)
327331
self._resources_paths[dest.stem] = result
328-
logger.debug('DownloadManager download completed: %s', result)
332+
logger.debug('Download success: %s', result)
329333
return result
330334

331335
def fetch_from_catalog(
@@ -349,7 +353,7 @@ def fetch_from_catalog(
349353
if not resources:
350354
raise ValueError('Resources list for batch download is empty.')
351355

352-
logger.debug('Fetching %s resources from catalog', len(resources))
356+
logger.debug('Catalog batch download: %s items', len(resources))
353357
results = {}
354358
for resource in resources:
355359
name_id, format_type = self._extract_resource_info(resource)

ontograph/loader.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -413,10 +413,9 @@ def _download_ontology(
413413
logger.debug(f'Created default downloader: {type(downloader).__name__}')
414414

415415
logger.info(
416-
'Downloading ontology %s.%s using %s (catalog)',
416+
'Ontology download start: %s.%s (catalog)',
417417
name_id,
418418
format,
419-
type(downloader).__name__,
420419
)
421420
resources = [{'name_id': name_id, 'format': format}]
422421
try:
@@ -520,11 +519,7 @@ def load_from_url(
520519
downloader = get_default_downloader(cache_dir=self.cache_dir)
521520
logger.debug(f'Created default downloader: {type(downloader).__name__}')
522521

523-
logger.info(
524-
'Downloading ontology from URL using %s: %s',
525-
type(downloader).__name__,
526-
url_ontology,
527-
)
522+
logger.info('Ontology download start: %s (url)', url_ontology)
528523
file_path: Path = downloader.fetch_from_url(
529524
url_ontology=url_ontology,
530525
filename=filename,

ontograph/models.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,8 @@ def _download_registry(
7070
if downloader is None:
7171
downloader = get_default_downloader(cache_dir=self.cache_dir)
7272

73-
logger.info(
74-
'Downloading OBO Foundry registry using %s: %s',
75-
type(downloader).__name__,
76-
OBO_FOUNDRY_REGISTRY_URL,
77-
)
78-
logger.debug('Catalog file path: %s', catalog_path)
73+
logger.info('Catalog download start: %s', OBO_FOUNDRY_REGISTRY_URL)
74+
logger.debug('Catalog download target: %s', catalog_path)
7975
downloader.fetch_from_url(
8076
url_ontology=OBO_FOUNDRY_REGISTRY_URL,
8177
filename=NAME_OBO_FOUNDRY_CATALOG,

0 commit comments

Comments
 (0)