1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2025
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This tests whether our submodules have __all__ or not.
Additionally also tests if all public submodules are included in __all__ for __init__'s.
"""
import importlib
import os
from pathlib import Path
from tests.auxil.files import SOURCE_ROOT_PATH
def test_public_submodules_dunder_all():
modules_to_search = list(SOURCE_ROOT_PATH.rglob("*.py"))
if not modules_to_search:
raise AssertionError("No modules found to search through, please modify this test.")
for mod_path in modules_to_search:
path = str(mod_path)
folder = mod_path.parent
if mod_path.name == "__init__.py" and "_" not in path[:-11]: # init of public submodules
mod = load_module(mod_path)
assert hasattr(mod, "__all__"), f"{folder}'s __init__ does not have an __all__!"
pub_mods = get_public_submodules_in_folder(folder)
cond = all(pub_mod in mod.__all__ for pub_mod in pub_mods)
assert cond, f"{path}'s __all__ should contain all public submodules ({pub_mods})!"
continue
if "_" in path: # skip private modules
continue
mod = load_module(mod_path)
assert hasattr(mod, "__all__"), f"{mod_path.name} does not have an __all__!"
def load_module(path: Path):
path = path.relative_to(SOURCE_ROOT_PATH.parent)
if path.name == "__init__.py":
mod_name = str(path.parent).replace(os.sep, ".") # telegram(.ext) format
else:
mod_name = f"{path.parent}.{path.stem}".replace(os.sep, ".") # telegram(.ext).(...) format
return importlib.import_module(mod_name)
def get_public_submodules_in_folder(path: Path):
return [i.stem for i in path.glob("[!_]*.py")]
|
