def to_string(self):
"""Add a each parameter in section ARGUMENTS.
Keyword arguments:
name -- parameter name (string - required)
descriptiion -- description for the parameter (string - required)
type_arg -- type of the parameter (string - required)
opt -- possible options for parameter (string - default:None)
default -- dafault value for parameter (string - default:None)
mandatory -- if parameter is required (boolean - default: None)
"""
if not (self.name and self.syntax and self.description):
print("[ERROR] Seções obrigatórias não foram preenchidas!")
else:
print(
to_encode(self.name) + to_encode(self.syntax) +
to_encode(self.description) + to_encode(self.arguments) +
to_encode(self.others))
def to_string(self):
"""Add a each parameter in section ARGUMENTS.
Keyword arguments:
name -- parameter name (string - required)
descriptiion -- description for the parameter (string - required)
type_arg -- type of the parameter (string - required)
opt -- possible options for parameter (string - default:None)
default -- dafault value for parameter (string - default:None)
mandatory -- if parameter is required (boolean - default: None)
"""
if not (self.name and self.syntax and self.description):
print("[ERROR] Seções obrigatórias não foram preenchidas!")
else:
print(
to_encode(self.name) + to_encode(self.syntax) +
to_encode(self.description) +
to_encode(self.arguments) +
to_encode(self.others)
)
def add_section(self, name, text):
"""Add a new section based on the parameter given.
Keyword arguments:
name -- section title (string - required)
text -- section description that will be shown (string - required)
"""
name = to_encode(name.upper())
text = to_encode(text)
if name == "NOME":
self.name = (self.color(name, "BOLD") + '\n\t' + text + '\n\n')
elif name == "SINTAXE":
self.syntax = (self.color(name, "BOLD") + '\n\t' + text + '\n\n')
elif name == "DESCRIÇÃO":
self.description = (self.color(name, "BOLD") + '\n\t' + text +
'\n\n')
else:
name = to_encode(name)
text = to_encode(text)
self.others = self.others + (self.color(name, "BOLD") + '\n\t' +
text + '\n\n')
def add_arguments(self,
name,
description,
type_arg,
opt=None,
default=None,
mandatory=False):
"""Add a each parameter in section ARGUMENTS.
Keyword arguments:
name -- parameter name (string - required)
descriptiion -- description for the parameter (string - required)
type_arg -- type of the parameter (string - required)
opt -- possible options for parameter (string - default:None)
default -- dafault value for parameter (string - default:None)
mandatory -- if parameter is required (boolean - default: None)
"""
name = to_encode(name)
description = to_encode(description)
type_arg = to_encode(type_arg)
mandatory = to_encode(u'OBRIGATÓRIO') if mandatory else 'none'
opt = to_encode(opt) if opt else 'none'
default = to_encode(default) if default else 'none'
if not self.arguments:
self.arguments = self.color("PARÂMETROS", "BOLD") + '\n\t'
self.arguments += (self.color(
"nome_do_parametro [tipo][opções][valor_padrão]" +
"[obrigatório]\n\n", "UNDERLINE"))
self.arguments += ('\t' + self.color(name, 'BOLD') + ' [' + type_arg +
']' + '[' + opt + '][' + default + '][' +
mandatory + ']\n' + '\t\t' + description + '\n\n')
def add_section(self, name, text):
"""Add a new section based on the parameter given.
Keyword arguments:
name -- section title (string - required)
text -- section description that will be shown (string - required)
"""
name = to_encode(name.upper())
text = to_encode(text)
if name == "NOME":
self.name = (
self.color(name, "BOLD") + '\n\t' + text + '\n\n')
elif name == "SINTAXE":
self.syntax = (
self.color(name, "BOLD") + '\n\t' + text + '\n\n')
elif name == "DESCRIÇÃO":
self.description = (
self.color(name, "BOLD") + '\n\t' + text + '\n\n')
else:
name = to_encode(name)
text = to_encode(text)
self.others = self.others + (
self.color(name, "BOLD") + '\n\t' + text + '\n\n')
def add_arguments(
self, name, description, type_arg, opt=None, default=None,
mandatory=False
):
"""Add a each parameter in section ARGUMENTS.
Keyword arguments:
name -- parameter name (string - required)
descriptiion -- description for the parameter (string - required)
type_arg -- type of the parameter (string - required)
opt -- possible options for parameter (string - default:None)
default -- dafault value for parameter (string - default:None)
mandatory -- if parameter is required (boolean - default: None)
"""
name = to_encode(name)
description = to_encode(description)
type_arg = to_encode(type_arg)
mandatory = to_encode(u'OBRIGATÓRIO') if mandatory else 'none'
opt = to_encode(opt) if opt else 'none'
default = to_encode(default) if default else 'none'
if not self.arguments:
self.arguments = self.color("PARÂMETROS", "BOLD") + '\n\t'
self.arguments += (
self.color(
"nome_do_parametro [tipo][opções][valor_padrão]" +
"[obrigatório]\n\n",
"UNDERLINE"
)
)
self.arguments += (
'\t' + self.color(name, 'BOLD') + ' [' + type_arg + ']' +
'[' + opt + '][' + default + '][' + mandatory + ']\n' +
'\t\t' + description + '\n\n'
)
