def filters_text(
alias="", # If a filter alias is specified, more detailed help for that filter is printed.
example=False, # Whether to run examples
nocolor=False, # When source = True, whether to omit syntax highlighting
showall=False, # Whether to show all filters, including those which need missing software, implies versions=True
showmissing=False, # Whether to just show filters missing external software, implies versions=True
space=False, # Whether to add extra spacing to the output for extra readability
source=False, # Whether to include syntax-highlighted source code when displaying an indvidual filter
versions=False # Whether to check the installed version of external software required by filters, slower
):
SETTING_STRING = " %s: %s (default value: %s)"
if len(alias) > 0:
# We want help on a particular filter
instance = dexy.filter.Filter.create_instance(alias)
text = []
text.append("aliases: %s" % ", ".join(instance.aliases))
text.append("")
text.append(inspect.getdoc(instance.__class__))
text.append("")
text.append("dexy-level settings:")
for k in sorted(instance._instance_settings):
if not k in dexy.filter.Filter.nodoc_settings and k in dexy.filter.Filter._settings:
tup = instance._instance_settings[k]
text.append(SETTING_STRING % (k, tup[0], tup[1]))
text.append("")
text.append("filter-specific settings:")
for k in sorted(instance.filter_specific_settings()):
tup = instance._instance_settings[k]
text.append(SETTING_STRING % (k, tup[0], tup[1]))
examples = instance.setting('examples')
if len(examples) > 0:
text.append("")
text.append("Examples for this filter:")
for alias in examples:
template = dexy.template.Template.create_instance(alias)
text.append("")
text.append(" %s" % alias)
text.append(" %s" %
dexy.utils.getdoc(template.__class__))
if example:
for alias in examples:
template = dexy.template.Template.create_instance(alias)
text.append('')
text.append("Running example: %s" % s(template.__doc__))
text.append('')
text.append('')
text.append(template_text(alias=alias))
text.append('')
text.append("")
text.append("For online docs see http://dexy.it/docs/filters/%s" %
alias)
if source:
text.append("")
source_code = inspect.getsource(instance.__class__)
if nocolor:
text.append(source_code)
else:
formatter = TerminalFormatter()
lexer = PythonLexer()
text.append(highlight(source_code, lexer, formatter))
return "\n".join(text)
else:
text = []
text.append("Available filters:")
for filter_instance in dexy.filter.Filter:
if showall:
skip = False
else:
no_aliases = not filter_instance.setting('aliases')
no_doc = filter_instance.setting('nodoc')
not_dexy = not filter_instance.__class__.__module__.startswith(
"dexy.")
exclude = filter_instance.alias in ('-')
skip = no_aliases or no_doc or not_dexy or exclude
if (versions or showmissing or showall) and not skip:
if hasattr(filter_instance, 'version'):
version = filter_instance.version()
else:
version = None
no_version_info_available = (version is None)
if no_version_info_available:
version_message = ""
if showmissing:
skip = True
elif version:
version_message = "Installed version: %s" % version
if showmissing:
skip = True
else:
if not (showmissing or showall):
skip = True
version_message = "'%s' failed, filter may not be available." % filter_instance.version_command(
)
if not skip:
filter_help = " " + filter_instance.alias + " : " + filter_instance.setting(
'help').splitlines()[0]
if (versions or showmissing or (showall and not version)):
filter_help += " %s" % version_message
text.append(filter_help)
text.append(
"\nFor more information about a particular filter, use the -alias flag and specify the filter alias."
)
if space:
sep = "\n\n"
else:
sep = "\n"
return sep.join(text)
def help_for_filter(alias, run_example, show_source, nocolor):
instance = dexy.filter.Filter.create_instance(alias)
print('')
print(instance.setting('help'))
print('')
print("aliases: %s" % ", ".join(instance.setting('aliases')))
print("tags: %s" % ", ".join(instance.setting('tags')))
print('')
print("Converts from file formats:")
for ext in instance.setting('input-extensions'):
print(" %s" % ext)
print('')
print("Converts to file formats:")
for ext in instance.setting('output-extensions'):
print(" %s" % ext)
print('')
print('Settings:')
for k in sorted(instance._instance_settings):
if k in dexy.filter.Filter.nodoc_settings:
continue
if k in ('aliases', 'tags'):
continue
tup = instance._instance_settings[k]
print(" %s" % k)
for line in inspect.cleandoc(tup[0]).splitlines():
print(" %s" % line)
print(" default value: %s" % tup[1])
print('')
examples = instance.setting('examples')
example_templates = {}
for alias in examples:
try:
template_instance = dexy.template.Template.create_instance(alias)
example_templates[alias] = template_instance
except dexy.exceptions.InactivePlugin:
pass
if examples:
print('')
print("Examples for this filter:")
for alias, template in example_templates.items():
print('')
print(" %s" % alias)
print(" %s" % inspect.getdoc(template.__class__))
if run_example:
for alias, template in example_templates.items():
print('')
print('')
print("Running example: %s" % template.setting('help'))
print('')
print('')
print(template_text(template))
print('')
print("For online docs see http://dexy.it/filters/%s" % alias)
print('')
print("If you have suggestions or feedback about this filter,")
print("please contact [email protected]")
print('')
if show_source:
print('')
source_code = inspect.getsource(instance.__class__)
if nocolor:
print(source_code)
else:
formatter = pygments.formatters.TerminalFormatter()
lexer = PythonLexer()
print(highlight(source_code, lexer, formatter))
def template_command(alias=None):
print template_text(alias)
def help_for_filter(alias, run_example, show_source, nocolor):
instance = dexy.filter.Filter.create_instance(alias)
print ''
print instance.setting('help')
print ''
print "aliases: %s" % ", ".join(instance.setting('aliases'))
print "tags: %s" % ", ".join(instance.setting('tags'))
print ''
print "Converts from file formats:"
for ext in instance.setting('input-extensions'):
print " %s" % ext
print ''
print "Converts to file formats:"
for ext in instance.setting('output-extensions'):
print " %s" % ext
print ''
print('Settings:')
for k in sorted(instance._instance_settings):
if k in dexy.filter.Filter.nodoc_settings:
continue
if k in ('aliases', 'tags'):
continue
tup = instance._instance_settings[k]
print " %s" % k
for line in inspect.cleandoc(tup[0]).splitlines():
print " %s" % line
print " default value: %s" % tup[1]
print ''
examples = instance.setting('examples')
example_templates = {}
for alias in examples:
try:
template_instance = dexy.template.Template.create_instance(alias)
example_templates[alias] = template_instance
except dexy.exceptions.InactivePlugin:
pass
if examples:
print ''
print "Examples for this filter:"
for alias, template in example_templates.iteritems():
print ''
print " %s" % alias
print " %s" % inspect.getdoc(template.__class__)
if run_example:
for alias, template in example_templates.iteritems():
print ''
print ''
print "Running example: %s" % template.setting('help')
print ''
print ''
print template_text(template)
print ''
print "For online docs see http://dexy.it/ref/filters/%s" % alias
print ''
print "If you have suggestions or feedback about this filter,"
print "please contact [email protected]"
print ''
if show_source:
print ''
source_code = inspect.getsource(instance.__class__)
if nocolor:
print source_code
else:
formatter = pygments.formatters.TerminalFormatter()
lexer = PythonLexer()
print highlight(source_code, lexer, formatter)
def template_command(
alias=None
):
print template_text(alias)
def filters_text(
alias="", # If a filter alias is specified, more detailed help for that filter is printed.
example=False, # Whether to run examples
nocolor=False, # When source = True, whether to omit syntax highlighting
showall=False, # Whether to show all filters, including those which need missing software, implies versions=True
showmissing=False, # Whether to just show filters missing external software, implies versions=True
space=False, # Whether to add extra spacing to the output for extra readability
source=False, # Whether to include syntax-highlighted source code when displaying an indvidual filter
versions=False # Whether to check the installed version of external software required by filters, slower
):
SETTING_STRING = " %s: %s (default value: %s)"
if len(alias) > 0:
# We want help on a particular filter
instance = dexy.filter.Filter.create_instance(alias)
text = []
text.append("aliases: %s" % ", ".join(instance.aliases))
text.append("")
text.append(inspect.getdoc(instance.__class__))
text.append("")
text.append("dexy-level settings:")
for k in sorted(instance._instance_settings):
if not k in dexy.filter.Filter.nodoc_settings and k in dexy.filter.Filter._settings:
tup = instance._instance_settings[k]
text.append(SETTING_STRING % (k, tup[0], tup[1]))
text.append("")
text.append("filter-specific settings:")
for k in sorted(instance.filter_specific_settings()):
tup = instance._instance_settings[k]
text.append(SETTING_STRING % (k, tup[0], tup[1]))
examples = instance.setting('examples')
if len(examples) > 0:
text.append("")
text.append("Examples for this filter:")
for alias in examples:
template = dexy.template.Template.create_instance(alias)
text.append("")
text.append(" %s" % alias)
text.append(" %s" % dexy.utils.getdoc(template.__class__))
if example:
for alias in examples:
template = dexy.template.Template.create_instance(alias)
text.append('')
text.append("Running example: %s" % s(template.__doc__))
text.append('')
text.append('')
text.append(template_text(alias=alias))
text.append('')
text.append("")
text.append("For online docs see http://dexy.it/docs/filters/%s" % alias)
if source:
text.append("")
source_code = inspect.getsource(instance.__class__)
if nocolor:
text.append(source_code)
else:
formatter = TerminalFormatter()
lexer = PythonLexer()
text.append(highlight(source_code, lexer, formatter))
return "\n".join(text)
else:
text = []
text.append("Available filters:")
for filter_instance in dexy.filter.Filter:
if showall:
skip = False
else:
no_aliases = not filter_instance.setting('aliases')
no_doc = filter_instance.setting('nodoc')
not_dexy = not filter_instance.__class__.__module__.startswith("dexy.")
exclude = filter_instance.alias in ('-')
skip = no_aliases or no_doc or not_dexy or exclude
if (versions or showmissing or showall) and not skip:
if hasattr(filter_instance, 'version'):
version = filter_instance.version()
else:
version = None
no_version_info_available = (version is None)
if no_version_info_available:
version_message = ""
if showmissing:
skip = True
elif version:
version_message = "Installed version: %s" % version
if showmissing:
skip = True
else:
if not (showmissing or showall):
skip = True
version_message = "'%s' failed, filter may not be available." % filter_instance.version_command()
if not skip:
filter_help = " " + filter_instance.alias + " : " + filter_instance.setting('help').splitlines()[0]
if (versions or showmissing or (showall and not version)):
filter_help += " %s" % version_message
text.append(filter_help)
text.append("\nFor more information about a particular filter, use the -alias flag and specify the filter alias.")
if space:
sep = "\n\n"
else:
sep = "\n"
return sep.join(text)