python-nose/scripts/mkdocs.py at ast_discovery · purepython/python-nose

Repository navigation

History

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

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

#!/usr/bin/env python

import os

import re

import time

from docutils.core import publish_string, publish_parts

from docutils.readers.standalone import Reader

from docutils.writers.html4css1 import Writer, HTMLTranslator

from pudge.browser import Browser

import inspect

import nose

import textwrap

from optparse import OptionParser

from nose.util import resolve_name, odict

from pygments import highlight

from pygments.lexers import PythonLexer, PythonConsoleLexer

from pygments.formatters import HtmlFormatter

remove_at = re.compile(r' at 0x[0-9a-f]+')

root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))

doc = os.path.join(root, 'doc')

tpl = open(os.path.join(doc, 'doc.html.tpl'), 'r').read()

api_tpl = open(os.path.join(doc, 'plugin_api.html.tpl'), 'r').read()

plug_tpl = open(os.path.join(doc, 'plugin.html.tpl'), 'r').read()

std_info = {

'version': nose.__version__,

'date': time.ctime()

}

to_write = []

def defining_class(cls, attr):

from epydoc.objdoc import _lookup_class_field

val, container = _lookup_class_field(cls, attr)

return container.value()

def write(filename, tpl, ctx):

print filename

ctx.setdefault('submenu', '')

fp = open(filename, 'w')

try:

fp.write(tpl % ctx)

except UnicodeEncodeError:

print ctx

fp.close()

def doc_word(node):

# handle links like package.module and module.Class

# as wellas 'foo bar'

orig = name = node.astext()

if '.' in name:

parts = name.split('.')

# if the first letter of a part is capitalized, assume it's

# a class name, and put all parts from that part on into

# the anchor part of the link

link, anchor = [], []

addto = link

while parts:

part = parts.pop(0)

if addto == link:

if part[0].upper() == part[0]:

addto = anchor

elif part.endswith('()'):

addto = anchor

part = part[:-2]

addto.append(part)

if (name.startswith('nose.plugins')

and 'plugintest' not in name):

base = 'plugin_'

link = link[-1:]

else:

base = 'module_'

node['refuri'] = base + '.'.join(link) + '.html'

if anchor:

node['refuri'] += '#' + '.'.join(anchor)

else:

# pad out wiki-words

name = name[0].lower() + name[1:]

name = re.sub(r'([A-Z])', r' \1', name).lower()

node['refuri'] = '_'.join(name.split(' ')) + '.html'

print "Unknown ref %s -> %s" % (orig, node['refuri'])

del node['refname']

node.resolved = True

return True

doc_word.priority = 100

class DocReader(Reader):

unknown_reference_resolvers = (doc_word,)

class PygHTMLTranslator(HTMLTranslator):

"""HTML translator that uses pygments to highlight doctests.

"""

def visit_doctest_block(self, node):

self.body.append(

highlight(node.rawsource, PythonConsoleLexer(), HtmlFormatter()))

# hacky way of capturing children -- we've processed the whole node

self._body = self.body

self.body = []

def depart_doctest_block(self, node):

# restore the real body, doctest node is done

self.body = self._body

del self._body

class PygWriter(Writer):

def __init__(self):

Writer.__init__(self)

self.translator_class = PygHTMLTranslator

def formatargspec(func, exclude=()):

try:

args, varargs, varkw, defaults = inspect.getargspec(func)

except TypeError:

return "(...)"

if defaults:

defaults = map(clean_default, defaults)

for a in exclude:

if a in args:

ix = args.index(a)

args.remove(a)

try:

defaults.pop(ix)

except AttributeError:

pass

return inspect.formatargspec(

args, varargs, varkw, defaults).replace("'os.environ'", 'os.environ')

def clean_default(val):

if isinstance(val, os._Environ):

return 'os.environ'

return val

def to_html_parts(rst):

return publish_parts(rst, reader=DocReader(), writer=PygWriter())

def to_html(rst):

return to_html_parts(rst)['body']

def document_module(mod):

name = mod.qualified_name()

print name

body = to_html(mod.doc())

# for classes: prepend with note on what highlighted means

cls_note = "<p>Highlighted methods are defined in this class.</p>"

submenu = []

# classes

mod_classes = get_classes(mod)

classes = [document_class(cls) for cls in mod_classes]

if classes:

body += '<h2>Classes</h2>\n' + cls_note + '\n'.join(classes)

submenu.extend(make_submenu('Classes', mod_classes))

# functions

mod_funcs = list(mod.routines())

funcs = [document_function(func) for func in mod_funcs]

if funcs:

body += '<h2>Functions</h2>\n' + '\n'.join(funcs)

submenu.extend(make_submenu('Functions', mod_funcs))

# attributes

mod_attrs = list(mod.attributes())

attrs = [document_attribute(attr) for attr in mod_attrs]

if attrs:

body += '<h2>Attributes</h2>\n' + '\n'.join(attrs)

submenu.extend(make_submenu('Attributes', mod_attrs))

pg = {'body': body,

'title': name,

'submenu': ''.join(submenu)}

pg.update(std_info)

to_write.append((

'Modules',

'Module: %s' % name,

os.path.join(doc, 'module_%s.html' % name),

tpl, pg))

def make_submenu(name, objs):

sm = ['<h2>%s</h2>' % name, '<ul>']

sm.extend(['<li><a href="#%s">%s</a></li>' % (o.name, o.name)

for o in objs] + ['</ul>'])

return sm

def get_classes(mod):

# some "invisible" items I do want, but not others

# really only those classes defined in the module itself

# with some per-module alias list handling (eg,

# TestLoader and defaultTestLoader shouldn't both be fully doc'd)

all = list(mod.classes(visible_only=0))

# sort by place in __all__

names = odict() # list comprehension didn't work? possible bug in odict

for c in all:

if c is not None and not c.isalias():

names[c.name] = c

ordered = []

try:

for name in mod.obj.__all__:

if name in names:

cls = names[name]

del names[name]

if cls is not None:

ordered.append(cls)

except AttributeError:

pass

for name, cls in names.items():

ordered.append(cls)

wanted = []

classes = set([])

for cls in ordered:

if cls.obj in classes:

cls.alias_for = cls.obj

else:

classes.add(cls.obj)

wanted.append(cls)

return wanted

def document_class(cls):

print " %s" % cls.qualified_name()

alias = False

if hasattr(cls, 'alias_for'):

alias = True

doc = '(Alias for %s)' % link_to_class(cls.alias_for)

else:

doc = to_html(cls.doc())

bases = ', '.join(link_to_class(c) for c in cls.obj.__bases__)

html = ['<a name="%s"></a><div class="cls section">' % cls.name,

'<span class="cls name">%s</span> (%s)' % (cls.name, bases),

'<div class="cls doc">%s' % doc]

if not alias:

real_class = cls.obj

methods = list(cls.routines(visible_only=False))

if methods:

methods.sort(lambda a, b: cmp(a.name, b.name))

html.append('<h3>Methods</h3>')

for method in methods:

print " %s" % method.qualified_name()

defined_in = defining_class(real_class, method.name)

if defined_in == real_class:

inherited = ''

inh_cls = ''

else:

inherited = '<span class="method inherited">' \

'(inherited from %s)</span>' \

% defined_in.__name__

inh_cls = ' inherited'

html.extend([

'<div class="method section%s">' % inh_cls,

'<span class="method name">%s' % method.name,

'<span class="args">%s</span></span>'

% formatargspec(method.obj),

inherited,

'<div class="method doc">%s</div>' % to_html(method.doc()),

'</div>'])

attrs = list(cls.attributes(visible_only=False))

if attrs:

attrs.sort(lambda a, b: cmp(a.name, b.name))

html.append('<h3>Attributes</h3>')

for attr in attrs:

print " a %s" % attr.qualified_name()

defined_in = defining_class(real_class, attr.name)

if defined_in == real_class:

inherited = ''

inh_cls = ''

else:

inherited = '<span class="attr inherited">' \

'(inherited from %s)</span>' \

% defined_in.__name__

inh_cls = ' inherited'

val = format_attr(attr.parent.obj, attr.name)

html.extend([

'<div class="attr section%s">' % inh_cls,

'<span class="attr name">%s</span>' % attr.name,

'<pre class="attr value">Default value: %(a)s</pre>' %

{'a': val},

'<div class="attr doc">%s</div>' % to_html(attr.doc()),

'</div>'])

html.append('</div></div>')

return ''.join(html)

def document_function(func):

print " %s" % func.name

html = [

'<a name="%s"></a><div class="func section">' % func.name,

'<span class="func name">%s' % func.name,

'<span class="args">%s</span></span>'

% formatargspec(func.obj, exclude=['self']),

'<div class="func doc">%s</div>' % to_html(func.doc()),

'</div>']

return ''.join(html)

def document_attribute(attr):

print " %s" % attr.name

value = format_attr(attr.parent.obj, attr.name)

html = [

'<a name="%s"></a><div class="attr section">' % attr.name,

'<span class="attr name">%s</span>' % attr.name,

'<pre class="attr value">Default value: %(a)s</pre>' %

{'a': value},

'<div class="attr doc">%s</div>' % to_html(attr.doc()),

'</div>']

return ''.join(html)

def format_attr(obj, attr):

val = getattr(obj, attr)

if isinstance(val, property):

# value makes no sense when it's a property

return '(property)'

val = str(val).replace(

'&', '&').replace('<', '<').replace('>', '>').replace(

'"', '"').replace("'", ''')

val = remove_at.sub('', val)

return val

def link_to_class(cls):

mod = cls.__module__

name = cls.__name__

if mod.startswith('_'):

qname = name

else:

qname = "%s.%s" % (mod, name)

if not mod.startswith('nose'):

return qname

return '<a href="module_%s.html#%s">%s</a>' % (mod, name, name)

def plugin_example_tests():

dt_root = os.path.join(root, 'functional_tests', 'doc_tests')

for dirpath, dirnames, filenames in os.walk(dt_root):

for filename in filenames:

if filename.startswith('.'):

continue

base, ext = os.path.splitext(filename)

if ext == '.rst':

yield os.path.join(dirpath, filename)

if '.svn' in dirnames:

dirnames.remove('.svn')

def document_rst_test(filename, section):

base, ext = os.path.splitext(os.path.basename(filename))

rst = open(filename, 'r').read()

parts = to_html_parts(rst)

parts.update(std_info)

to_write.append((section,

parts['title'],

os.path.join(doc, base + '.html'),

tpl,

parts))

def main():

# plugins

from nose import plugins

from nose.plugins.base import IPluginInterface

from nose.plugins import errorclass

# writing plugins guide

writing_plugins = {'body': to_html(plugins.__doc__)}

writing_plugins.update(std_info)

writing_plugins['title'] = 'Writing Plugins'

to_write.append(

('Plugins',

'Writing Plugins',

os.path.join(doc, 'writing_plugins.html'), tpl, writing_plugins))

# error class plugins

ecp = {'body': to_html(errorclass.__doc__)}

ecp.update(std_info)

ecp['title'] = 'ErrorClass Plugins'

to_write.append(

('Plugins',

'ErrorClass Plugins',

os.path.join(doc, 'error_class_plugin.html'), tpl, ecp))

# interface

itf = {'body': to_html(textwrap.dedent(IPluginInterface.__doc__))}

# methods

attr = [(a, getattr(IPluginInterface, a)) for a in dir(IPluginInterface)]

methods = [m for m in attr if inspect.ismethod(m[1])]

methods.sort()

# print "Documenting methods", [a[0] for a in methods]

method_html = []

method_tpl = """

</div>

"""

menu_links = {}

m_attrs = ('_new', 'changed', 'deprecated', 'generative', 'chainable')

for m in methods:

name, meth = m

ec = []

for att in m_attrs:

if hasattr(meth, att):

ec.append(att.replace('_', ''))

menu_links.setdefault(att.replace('_', ''), []).append(name)

# padding evens the lines

print name

mdoc = {'body': to_html(textwrap.dedent(' ' + meth.__doc__))}

argspec = formatargspec(meth)

mdoc.update({'name': name,

'extra_class': ' '.join(ec),

'arg': argspec})

method_html.append(method_tpl % mdoc)

itf['methods'] = ''.join(method_html)

itf.update(std_info)

itf['title'] = 'Plugin Interface'

menu = []

for section in ('new', 'changed', 'deprecated'):

menu.append('<h2>%s methods</h2>' % section.title())

menu.append('<ul><li>')

menu.append('</li><li>'.join([

'<a href="#%(name)s">%(name)s</a>' % {'name': n}

for n in menu_links[section]]))

menu.append('</li></ul>')

itf['sub_menu'] = ''.join(menu)

to_write.append(

('Plugins',

'Plugin Interface',

os.path.join(doc, 'plugin_interface.html'), api_tpl, itf))

# individual plugin usage docs

from nose.plugins.builtin import builtins

pmeths = [m[0] for m in methods[:]

if not 'options' in m[0].lower()]

pmeths.append('options')

pmeths.sort()

for modulename, clsname in builtins:

_, _, modname = modulename.split('.')

mod = resolve_name(modulename)

cls = getattr(mod, clsname)

filename = os.path.join(doc, 'plugin_%s.html' % modname)

print modname, filename

if not mod.__doc__:

print "No docs"

continue

pdoc = {'body': to_html(mod.__doc__)}

pdoc.update(std_info)

pdoc['title'] = 'builtin plugin: %s' % modname

# options

parser = OptionParser(add_help_option=False)

plug = cls()

plug.addOptions(parser)

options = parser.format_option_help()

pdoc['options'] = options

# hooks used

hooks = []

for m in pmeths:

if getattr(cls, m, None):

hooks.append('<li><a href="plugin_interface.html#%(name)s">'

'%(name)s</a></li>' % {'name': m})

pdoc['hooks'] = ''.join(hooks)

source = inspect.getsource(mod)

pdoc['source'] = highlight(source, PythonLexer(), HtmlFormatter())

to_write.append(

('Plugins',

'Builtin Plugin: %s' % modname,

os.path.join(doc, filename), plug_tpl, pdoc))

# individual module docs

b = Browser(['nose','nose.plugins.manager', 'nose.plugins.plugintest'],

exclude_modules=['nose.plugins', 'nose.ext'])

for mod in b.modules(recursive=1):

if mod.name == 'nose':

# no need to regenerate, this is the source of the doc index page

continue

print mod.qualified_name()

document_module(mod)

# plugin examples doctests

for testfile in plugin_example_tests():

document_rst_test(testfile, "Plugin Examples")

# finally build the menu and write all pages

menu = []

sections = odict()

for page in to_write:

section, _, _, _, _ = page

sections.setdefault(section, []).append(page)

for section, pages in sections.items():

menu.append('<h2>%s</h2>' % section)

menu.append('<ul>')

pages.sort()

menu.extend([

'<li><a href="%s">%s</a></li>' % (os.path.basename(filename), title)

for _, title, filename, _, _ in pages ])

menu.append('</ul>')

menu = ''.join(menu)

for section, title, filename, template, ctx in to_write:

ctx['menu'] = menu

write(filename, template, ctx)

# doc section index page

idx_tpl = open(os.path.join(doc, 'index.html.tpl'), 'r').read()

idx = {

'title': 'API documentation',

'menu': menu}

idx.update(std_info)

write(os.path.join(doc, 'index.html'), idx_tpl, idx)

if __name__ == '__main__':

main()

FilesExpand file tree

mkdocs.py

Latest commit

History

mkdocs.py

File metadata and controls