def getHelpAsString(docstring = False, show_ver = True):
"""
return useful help from a file in the script directory called
__taskname__.help
"""
install_dir = os.path.dirname(__file__)
taskname = util.base_taskname(__taskname__, '')
htmlfile = os.path.join(install_dir, 'htmlhelp', taskname + '.html')
helpfile = os.path.join(install_dir, taskname + '.help')
if docstring or (not docstring and not os.path.exists(htmlfile)):
if show_ver:
helpString = os.linesep + \
' '.join([__taskname__, 'Version', __version__,
' updated on ', __vdate__]) + 2*os.linesep
else:
helpString = ''
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(taskname, __file__)
else:
if __doc__ is not None:
helpString += __doc__ + os.linesep
else:
helpString = 'file://' + htmlfile
return helpString
def getHelpAsString(docstring = False, show_ver = True):
"""
return useful help from a file in the script directory called
__taskname__.help
"""
install_dir = os.path.dirname(__file__)
taskname = util.base_taskname(__taskname__, __package__)
htmlfile = os.path.join(install_dir, 'htmlhelp', taskname + '.html')
helpfile = os.path.join(install_dir, taskname + '.help')
if docstring or (not docstring and not os.path.exists(htmlfile)):
if show_ver:
helpString = os.linesep + \
' '.join([__taskname__, 'Version', __version__,
' updated on ', __vdate__]) + 2*os.linesep
else:
helpString = ''
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(taskname, __file__)
else:
if __doc__ is not None:
helpString += __doc__ + os.linesep
else:
helpString = 'file://' + htmlfile
return helpString
def getHelpAsString(docstring=False, show_ver=True):
"""
Return useful help from a file in the script directory called
``__taskname__.help``
"""
install_dir = os.path.dirname(__file__)
taskname = util.base_taskname(__taskname__, __package__)
htmlfile = os.path.join(install_dir, 'htmlhelp', taskname + '.html')
helpfile = os.path.join(install_dir, taskname + '.help')
if docstring or (not docstring and not os.path.exists(htmlfile)):
if show_ver:
helpString = f"\n{__taskname__} Version {__version__}\n"
else:
helpString = ''
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(taskname, __file__)
elif __doc__ is not None:
helpString += __doc__ + os.linesep
else:
helpString = 'file://' + htmlfile
return helpString
def getHelpAsString(fulldoc=True):
"""Return help info from <module>.help in the script directory"""
if fulldoc:
basedoc = __doc__
else:
basedoc = ""
helpString = basedoc + "\n"
helpString += "Version " + __version__ + "\n"
helpString += teal.getHelpFileAsString(__taskname__, __file__)
return helpString
def getHelpAsString(fulldoc=True):
"""Return help info from <module>.help in the script directory"""
if fulldoc:
basedoc = __doc__
else:
basedoc = ""
helpString = basedoc + "\n"
helpString += "Version " + __version__ + "\n"
helpString += teal.getHelpFileAsString(__taskname__, __file__)
return helpString
def getHelpAsString(docstring=False):
"""Return documentation on the 'wf3ir' function. Required by TEAL."""
install_dir = os.path.dirname(__file__)
htmlfile = os.path.join(install_dir, 'htmlhelp', __taskname__ + '.html')
helpfile = os.path.join(install_dir, __taskname__ + '.help')
if docstring or (not docstring and not os.path.exists(htmlfile)):
helpString = ' '.join([__taskname__, 'Version', __version__,
' updated on ', __vdate__]) + '\n\n'
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(__taskname__, __file__)
else:
helpString = 'file://' + htmlfile
return helpString
def getHelpAsString(docstring=False):
"""Return documentation on the 'wf3ir' function. Required by TEAL."""
install_dir = os.path.dirname(__file__)
htmlfile = os.path.join(install_dir, 'htmlhelp', __taskname__ + '.html')
helpfile = os.path.join(install_dir, __taskname__ + '.help')
if docstring or (not docstring and not os.path.exists(htmlfile)):
helpString = ' '.join([__taskname__, 'Version', __version__,
' updated on ', __version_date__]) + '\n\n'
if os.path.exists(helpfile) and has_teal:
helpString += teal.getHelpFileAsString(__taskname__, __file__)
else:
helpString = 'file://' + htmlfile
return helpString
def getHelpAsString(docstring=False):
"""
return useful help from a file in the script directory called __taskname__.help
"""
install_dir = os.path.dirname(__file__)
htmlfile = os.path.join(install_dir, 'htmlhelp', __taskname__ + '.html')
helpfile = os.path.join(install_dir, __taskname__ + '.help')
if docstring or (not docstring and not os.path.exists(htmlfile)):
helpString = __taskname__ + ' Version ' + __version__ + '\n\n'
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(__taskname__, __file__)
else:
helpString = 'file://' + htmlfile
return helpString
def getHelpAsString(docstring=False):
"""
return useful help from a file in the script directory called __taskname__.help
"""
install_dir = os.path.dirname(__file__)
htmlfile = os.path.join(install_dir,'htmlhelp',__taskname__+'.html')
helpfile = os.path.join(install_dir,__taskname__+'.help')
if docstring or (not docstring and not os.path.exists(htmlfile)):
helpString = __taskname__+' Version '+__version__+'\n\n'
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(__taskname__,__file__)
else:
helpString = 'file://'+htmlfile
return helpString
def _get_help_as_string(docstring, show_ver, module_file, task_name,
module_doc):
install_dir = os.path.dirname(module_file)
taskname = base_taskname(task_name)
htmlfile = os.path.join(install_dir, 'htmlhelp', taskname + '.html')
helpfile = os.path.join(install_dir, taskname + '.help')
if docstring or not os.path.exists(htmlfile):
helpString = f"Task: '{task_name}'. '{__package__}' version: {__version__}\n\n" if show_ver else '\n'
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(taskname,
module_file).rstrip() + '\n'
elif module_doc is not None:
helpString += module_doc + '\n'
else:
helpString = 'file://' + htmlfile
return helpString
def getHelpAsString(docstring=False):
"""
Returns documentation on the 'sub2full' function.
return useful help from a file in the script directory called
__taskname__.help
"""
install_dir = os.path.dirname(__file__)
helpfile = os.path.join(install_dir, __taskname__ + '.help')
if docstring or (not docstring):
helpString = ' '.join([__taskname__, 'Version', __version__,
' updated on ', __vdate__]) + '\n\n'
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(__taskname__, __file__)
return helpString
def getHelpAsString(docstring=False):
"""
Returns documentation on the 'sub2full' function.
return useful help from a file in the script directory called
__taskname__.help
"""
install_dir = os.path.dirname(__file__)
helpfile = os.path.join(install_dir, __taskname__ + '.help')
if docstring or (not docstring):
helpString = ' '.join([__taskname__, 'Version', __version__,
' updated on ', __version_date__]) + '\n\n'
if os.path.exists(helpfile):
helpString += teal.getHelpFileAsString(__taskname__, __file__)
return helpString
def getHelpAsString(fulldoc=True):
"""Return help info from <module>.help in the script directory"""
try:
from stsci.tools import teal
except ImportError:
teal = None
if fulldoc:
basedoc = __doc__
else:
basedoc = ""
helpString = basedoc + "\n"
helpString += "Version " + __version__ + "\n"
if teal is not None:
helpString += teal.getHelpFileAsString(__taskname__, __file__)
helpString += __usage__
return helpString