Ebony Louis
24 lines
1.3 KiB
Python
24 lines
1.3 KiB
Python
from goose.utils import load_plugins
|
|
|
|
|
|
def lint_toolkits() -> None:
|
|
for toolkit_name, toolkit in load_plugins("goose.toolkit").items():
|
|
assert toolkit.__doc__ is not None, f"`{toolkit_name}` toolkit must have a docstring"
|
|
first_line_of_docstring = toolkit.__doc__.split("\n")[0]
|
|
assert len(first_line_of_docstring.split(" ")) > 5, f"`{toolkit_name}` toolkit docstring is too short"
|
|
assert len(first_line_of_docstring.split(" ")) < 12, f"`{toolkit_name}` toolkit docstring is too long"
|
|
assert first_line_of_docstring[0].isupper(), (
|
|
f"`{toolkit_name}` toolkit docstring must start with a capital letter"
|
|
)
|
|
|
|
|
|
def lint_providers() -> None:
|
|
for provider_name, provider in load_plugins(group="exchange.provider").items():
|
|
assert provider.__doc__ is not None, f"`{provider_name}` provider must have a docstring"
|
|
first_line_of_docstring = provider.__doc__.split("\n")[0]
|
|
assert len(first_line_of_docstring.split(" ")) > 5, f"`{provider_name}` provider docstring is too short"
|
|
assert len(first_line_of_docstring.split(" ")) < 20, f"`{provider_name}` provider docstring is too long"
|
|
assert first_line_of_docstring[0].isupper(), (
|
|
f"`{provider_name}` provider docstring must start with a capital letter"
|
|
)
|