vim-python-docstring/python/pydocstring.py at master · bentilley/vim-python-docstring · GitHub

History

262 lines (205 loc) · 8.42 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

#!/usr/bin/env python3

from string import Template

import re

import os

import ast

import abc

import ibis

from utils import *

from vimenv import *

from asthelper import ClassVisitor, MethodVisitor, ClassInstanceNameExtractor

class InvalidSyntax(Exception):

""" Raise when the syntax of processed object is invalid. """

pass

class DocstringUnavailable(Exception):

""" Raise when trying to process object to which there is no docstring. """

pass

class Templater:

""" Class used to template the docstrings

Attributes:

indent: used indentation

location: path to styles folder

style: docstring style

template: resulting remplate

"""

def __init__(self, location, indent, style='google'):

self.style = style

self.indent = indent

self.location = location

def _docstring_helper(self, obj_indent, docstring):

lines = []

for line in docstring.split('\n'):

if re.match('.', line):

line = concat_(obj_indent, self.indent, line)

lines.append(line)

return '\n'.join(lines)

def get_method_docstring(self, method_indent, args, returns, yields, raises):

with open(os.path.join(self.location, '..', 'styles/{}-{}.txt'.format(self.style, 'method')), 'r') as f:

self.template = ibis.Template(f.read())

docstring = self.template.render(indent=self.indent, args=args,

raises=raises, returns=returns, yields=yields)

return self._docstring_helper(method_indent, docstring)

def get_class_docstring(self, class_indent, attr):

with open(os.path.join(self.location, '..', 'styles/{}-{}.txt'.format(self.style, 'class')), 'r') as f:

self.template = ibis.Template(f.read())

docstring = self.template.render(indent=self.indent, attr=attr)

return self._docstring_helper(class_indent, docstring)

class ObjectWithDocstring(abc.ABC):

""" Represents an object (class, method) with the enviroment in which it is opened

Attributes:

env: enviroment class

starting_line: beggining line of the object on which it works

templater: templater object

"""

def __init__(self, env, templater, style='google'):

self.starting_line = env.current_line_nr

self.env = env

self.templater = templater

@abc.abstractmethod

def write_docstring(self):

""" Method to create a docstring for appropriate object

Writes the docstring to correct lines in `self.env` object.

"""

pass

def _get_sig(self):

lines = []

lines_it = self.env.lines_following_cursor()

sig_line, first_line = next(lines_it)

indent = re.findall('^(\s*)', first_line)[0]

lines.append(first_line)

while not self._is_valid(''.join(lines)):

try:

sig_line, line = next(lines_it)

except StopIteration as e:

raise InvalidSyntax('Object does not have valid syntax')

lines.append(line)

return sig_line, indent

def _object_tree(self):

""" Get the source code of the object under cursor. """

lines = []

lines_it = self.env.lines_following_cursor()

sig_line, first_line = next(lines_it)

lines.append(first_line)

obj_indent = re.findall('^(\s*)', first_line)[0]

expected_indent = concat_(obj_indent, self.env.python_indent)

valid_sig, _ = self._is_valid(first_line)

while True:

try:

last_row, line = next(lines_it)

except Exception as e:

break

if valid_sig and not self._is_correct_indent(lines[-1], line, expected_indent):

break

lines.append(line)

if not valid_sig:

data = ''.join(lines)

valid_sig, _ = self._is_valid(data)

sig_line = last_row

# remove obj_indent from the beginning of all lines

data = '\n'.join([re.sub('^'+obj_indent, '', l) for l in lines])

try:

tree = ast.parse(data)

except Exception as e:

raise InvalidSyntax('Object has invalid syntax.')

return sig_line, obj_indent, tree

def _is_correct_indent(self, previous_line, line, expected_indent):

""" Check whether given line has either given indentation (or more)

or does contain only nothing or whitespaces.

"""

# Disclaimer: I know this does not check for multiline comments and strings

# strings ''' <newline> ...<newline>..''' are a problem !!!

if re.match('^'+expected_indent, line):

return True

elif re.match('^\s*#', line):

return True

elif re.match('^\s*["\']{3}', line):

return True

elif re.match('.*\\$', previous_line):

return True

elif re.match('^\s*$', line):

return True

return False

def _is_valid(self, lines):

func = concat_(lines.lstrip(), '\n pass')

try:

tree = ast.parse(func)

return True, tree

except SyntaxError as e:

return False, None

def write_simple_docstring(self):

""" Writes the generated docstring in the enviroment """

sig_line, indent = self._get_sig()

docstring = concat_(indent, self.templater.indent, '""" """')

self.env.append_after_line(sig_line, docstring)

class MethodController(ObjectWithDocstring):

def __init__(self, env, templater, style='google'):

super().__init__(env, templater, style)

def _process_tree(self, tree):

v = MethodVisitor()

v.visit(tree)

args = list(v.arguments)

raises = list(v.raises)

return args, v.returns, v.yields, raises

# TODO: set cursor on appropriate position to fill the docstring

def write_docstring(self):

sig_line, method_indent, tree = self._object_tree()

args, returns, yields, raises = self._process_tree(tree)

docstring = self.templater.get_method_docstring(

method_indent, args, returns, yields, raises)

self.env.append_after_line(sig_line, docstring)

def _arguments(self, tree):

try:

args = []

for arg in tree.body[0].args.args:

args.append(arg.arg)

if args[0] == 'self' or args[0] == 'cls':

args.pop(0)

return args

except SyntaxError as e:

raise InvalidSyntax('The method has invalid syntax.')

class ClassController(ObjectWithDocstring):

def __init__(self, env, templater, style='google'):

super().__init__(env, templater, style)

def _process_tree(self, tree):

x = ClassInstanceNameExtractor()

x.visit(tree)

v = ClassVisitor(x.instance_name)

v.visit(tree)

att = list(v.attributes)

return att

def write_docstring(self):

sig_line, class_indent, tree = self._object_tree()

attr = self._process_tree(tree)

docstring = self.templater.get_class_docstring(class_indent, attr)

self.env.append_after_line(sig_line, docstring)

class Docstring:

""" Class used by user to generate docstrings"""

def __init__(self):

env = VimEnviroment()

style = env.python_style

indent = env.python_indent

location = env.plugin_root_dir

templater = Templater(location, indent, style)

self.obj_controller = self._controller_factory(env, templater, style)

def _controller_factory(self, env, templater, style):

line = env.current_line

first_word = re.match('^\s*(\w+).*', line).groups()[0]

if first_word == 'def':

return MethodController(env, templater, style=style)

elif first_word == 'class':

return ClassController(env, templater, style=style)

else:

raise DocstringUnavailable(

'Docstring cannot be created for selected object')

def full_docstring(self):

""" Writes docstring containing arguments, returns, raises, ... """

try:

self.obj_controller.write_docstring()

except Exception as e:

print(concat_('Doctring ERROR: ', e))

def oneline_docstring(self):

""" Writes only a one-line empty docstring """

try:

self.obj_controller.write_simple_docstring()

except Exception as e:

print(concat_('Doctring ERROR: ', e))

vim-python-docstring/python/pydocstring.py at master · bentilley/vim-python-docstring · GitHub

Expand file tree

Breadcrumbs

pydocstring.py

Latest commit

History

Breadcrumbs

pydocstring.py

File metadata and controls