def run(source, files=[], input_style='auto', output_style='reST', first_line=True, quotes='"""', init2class=False, convert=False, config_file=None, ignore_private=False):
if input_style == 'auto':
input_style = None
config = get_config(config_file)
if 'init2class' in config:
init2class = config.pop('init2class')
if 'convert_only' in config:
convert = config.pop('convert_only')
if 'quotes' in config:
quotes = config.pop('quotes')
if 'input_style' in config:
input_style = config.pop('input_style')
if 'output_style' in config:
output_style = config.pop('output_style')
if 'first_line' in config:
first_line = config.pop('first_line')
for f in files:
if os.path.isdir(source):
path = source + os.sep + os.path.relpath(os.path.abspath(f), os.path.abspath(source))
path = path[:-len(os.path.basename(f))]
else:
path = ''
c = PyComment(f, quotes=quotes,
input_style=input_style,
output_style=output_style,
first_line=first_line,
ignore_private=ignore_private,
convert_only=convert,
**config)
c.proceed()
if init2class:
c.docs_init_to_class()
c.diff_to_file(os.path.basename(f) + ".patch", path, path)
def generar_docstring_rst(self):
"""Esta función permite estructurar una lista de archivos obtimos para utilizar los comandos de Pyment"""
for f in self.get_files('py'):
fpatch = f+".patch"
c = PyComment(f)
c.proceed()
c.diff_to_file(fpatch)
cmd("patch {0} {1}",f,fpatch)
cmd("rm {0}",fpatch)
def run(source,
files=[],
input_style='auto',
output_style='reST',
first_line=True,
quotes='"""',
init2class=False,
convert=False,
config_file=None,
ignore_private=False,
overwrite=False):
if input_style == 'auto':
input_style = None
config = get_config(config_file)
if 'init2class' in config:
init2class = config.pop('init2class')
if 'convert_only' in config:
convert = config.pop('convert_only')
if 'quotes' in config:
quotes = config.pop('quotes')
if 'input_style' in config:
input_style = config.pop('input_style')
if 'output_style' in config:
output_style = config.pop('output_style')
if 'first_line' in config:
first_line = config.pop('first_line')
for f in files:
if os.path.isdir(source):
path = source + os.sep + os.path.relpath(os.path.abspath(f),
os.path.abspath(source))
path = path[:-len(os.path.basename(f))]
else:
path = ''
c = PyComment(f,
quotes=quotes,
input_style=input_style,
output_style=output_style,
first_line=first_line,
ignore_private=ignore_private,
convert_only=convert,
**config)
c.proceed()
if init2class:
c.docs_init_to_class()
if overwrite:
c.write_to_file()
else:
c.diff_to_file(os.path.basename(f) + ".patch", path, path)
param2 - descr of param2
Returns:
some value
Raises:
keyError: raises key exception
TypeError: raises type exception
'''
pass
class A:
def method(self, param1, param2=None):
pass
if __name__ == "__main__":
import os
from pyment import PyComment
filename = __file__
print filename
c = PyComment(filename)
c.proceed()
c.diff_to_file(os.path.basename(filename) + ".patch")
for s in c.get_output_docs():
print(s)
param1 - descr of param1 that has True for default value.
param2 - descr of param2
Returns:
some value
Raises:
keyError: raises key exception
TypeError: raises type exception
'''
pass
class A:
def method(self, param1, param2=None):
pass
if __name__ == "__main__":
import os
from pyment import PyComment
filename = __file__
print filename
c = PyComment(filename)
c.proceed()
c.diff_to_file(os.path.basename(filename) + ".patch")
for s in c.get_output_docs():
print(s)