Skip to content

Commit 406c12c

Browse files
committed
CLN: factor out get_module_item function
1 parent d9f2009 commit 406c12c

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

doc/source/check_api_doc.py

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -262,17 +262,22 @@ def make_diff(left_api, right_api, include_deprecated=False):
262262
return diff_api
263263

264264

265+
def get_module_item(module_name):
266+
try:
267+
module = importlib.import_module(module_name)
268+
return ModuleItem(module)
269+
except ImportError as err:
270+
print(f'module {module_name} could not be imported: {err}')
271+
return err
272+
273+
265274
def get_public_api():
266275
public_api = {}
267276
for module_name in _modules:
268-
try:
269-
module = importlib.import_module(module_name)
270-
module_item = ModuleItem(module)
277+
module_item = get_module_item(module_name)
278+
if isinstance(module_item, ModuleItem):
271279
module_item.auto_discovery()
272-
public_api[module_name] = module_item
273-
except ImportError as err:
274-
print(f'module {module_name} could not be imported: {err}')
275-
public_api[module_name] = err
280+
public_api[module_name] = module_item
276281
return public_api
277282

278283

@@ -290,13 +295,9 @@ def get_autosummary_api():
290295

291296
autosummary_api = {}
292297
for module_name in _modules:
293-
try:
294-
module = importlib.import_module(module_name)
295-
module_item = ModuleItem(module)
298+
module_item = get_module_item(module_name)
299+
if isinstance(module_item, ModuleItem):
296300
autosummary_api[module_name] = module_item
297-
except ImportError as err:
298-
print(f'module {module_name} could not be imported: {err}')
299-
autosummary_api[module_name] = err
300301

301302
for generated_rst_file in os.listdir(output_dir):
302303
qualname, ext = os.path.splitext(generated_rst_file)

0 commit comments

Comments
 (0)