"sage -coverage" should not care about functions which are local to other functions/methods

[sagetrac-cwitty]

Currently, if you have something like:

def foo():
    def bar():
        pass
    pass

then "sage -coverage" will complain that bar() has no docstring or doctests. However, such functions cannot be (directly) doctested, so that warning is invalid. In my opinion, bar() should not be required to have a docstring either.

Component: documentation

Author: John Palmieri

Reviewer: William Stein, Harald Schilly

Merged: Sage 4.1.1.alpha1

Issue created by migration from https://trac.sagemath.org/ticket/877

[mwhansen]

comment:1

To get around this, I took my local function/method and made it a regular one. I then used functools.partial to use it. This allowed my function to be tested like every other one. In the few cases where I had to do this, I ended up liking the functools version better.

[zimmermann6]

comment:2

#4323 is a duplicate of that ticket.

[jhpalmieri]

Author: John Palmieri

[jhpalmieri]

comment:3

Here is a patch for this. With sage-4.1.1.alpha0, it increases overall coverage from 77.9% to 78.5%.

To test: I know that the files steenrod_algebra_element.py and structure/factorization.py have such nested functions, so try 'sage -coverage' on these files, before and after patching.

[jhpalmieri]

Attachment: trac_877-scripts-coverage.patch.gz

apply to scripts repository

[jhpalmieri]

comment:4

(Maybe it only goes from 78.0% to 78.5%.)

[williamstein]

comment:5

Looks good to me:

BEFORE:

< Overall weighted coverage score:  77.8%
< Total number of functions:  22395

AFTER

> Overall weighted coverage score:  78.3%
> Total number of functions:  22207

The code looks fine and it works fine, so far as I can tell.