ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

ansible doc now finds modules recursively

Browse source 
more intelligent about ignoring files that are clearly not modules
This commit is contained in:
Brian Coca 2014-11-01 01:17:42 -04:00
parent f6d9aa7a8f
commit 7a5e7db2df
1 changed files with 28 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
bin/ansible-doc
View file

@ -34,6 +34,7 @@ import traceback
MODULEDIR = C.DEFAULT_MODULE_PATH MODULEDIR = C.DEFAULT_MODULE_PATH
BLACKLIST_EXTS = ('.pyc', '.swp', '.bak', '~', '.rpm') BLACKLIST_EXTS = ('.pyc', '.swp', '.bak', '~', '.rpm')
IGNORE_FILES = [ "COPYING", "CONTRIBUTING", "LICENSE", "README" ]
_ITALIC = re.compile(r"I\(([^)]+)\)") _ITALIC = re.compile(r"I\(([^)]+)\)")
_BOLD = re.compile(r"B\(([^)]+)\)") _BOLD = re.compile(r"B\(([^)]+)\)")
@ -202,6 +203,28 @@ def get_module_list_text(module_list):
text.extend(deprecated) text.extend(deprecated)
return "\n".join(text) return "\n".join(text)
def find_modules(path, module_list):
if os.path.isdir(path):
for module in os.listdir(path):
if module.startswith('.'):
continue
elif os.path.isdir(module):
find_modules(module, module_list)
elif any(module.endswith(x) for x in BLACKLIST_EXTS):
continue
elif module.startswith('__'):
continue
elif module in IGNORE_FILES:
continue
elif module.startswith('_'):
fullpath = '/'.join([path,module])
if os.path.islink(fullpath): # avoids aliases
continue
module = os.path.splitext(module)[0] # removes the extension
module_list.append(module)
def main(): def main():
p = optparse.OptionParser( p = optparse.OptionParser(
@ -238,19 +261,7 @@ def main():
paths = utils.plugins.module_finder._get_paths() paths = utils.plugins.module_finder._get_paths()
module_list = [] module_list = []
for path in paths: for path in paths:
if os.path.isdir(path): find_modules(path, module_list)
for module in os.listdir(path):
if any(module.endswith(x) for x in BLACKLIST_EXTS):
continue
elif module.startswith('__'):
continue
elif module.startswith('_'):
fullpath = '/'.join([path,module])
if os.path.islink(fullpath): # avoids aliases
continue
module = os.path.splitext(module)[0] # removes the extension
module_list.append(module)
pager(get_module_list_text(module_list)) pager(get_module_list_text(module_list))
sys.exit() sys.exit()
@ -273,8 +284,7 @@ def main():
filename = utils.plugins.module_finder.find_plugin(module) filename = utils.plugins.module_finder.find_plugin(module)
if filename is None: if filename is None:
sys.stderr.write("module %s not found in %s\n" % (module, sys.stderr.write("module %s not found in %s\n" % (module, print_paths(utils.plugins.module_finder)))
print_paths(utils.plugins.module_finder)))
continue continue
if any(filename.endswith(x) for x in BLACKLIST_EXTS): if any(filename.endswith(x) for x in BLACKLIST_EXTS):