how to write a python doctest

Add Answer

The Rambling Lank answered on February 26, 2020 Popularity 10/10 Helpfulness 1/10

answer how to write a python doctest

related running doctests python

related doctest example in python

related doctest python

related The simplest way to start using doctest in python

how to write a python doctest

Comment

def a_function(*args):
  '''
  >>>an input
  expected output
  '''
  if this:
    return that
# A doctest may also include a docstring

Popularity 10/10 Helpfulness 1/10 Language python

Source: docs.python.org

Tags: doctest python

Link to this answer
Share Copy Link

Contributed on Feb 26 2020

The Rambling Lank

0 Answers Avg Quality 2/10

Closely Related Answers

running doctests python

Comment

python -m doctest -v filename.py

Popularity 10/10 Helpfulness 4/10 Language python

Source: codeinplace2021.github.io

Tags: python py

Link to this answer
Share Copy Link

Contributed on May 12 2021

OuttaSpace

0 Answers Avg Quality 2/10

doctest example in python

Comment

"""
This is the "example" module.

The example module supplies one function, factorial().  For example,

>>> factorial(5)
120
"""

def factorial(n):
    """Return the factorial of n, an exact integer >= 0.

    >>> [factorial(n) for n in range(6)]
    [1, 1, 2, 6, 24, 120]
    >>> factorial(30)
    265252859812191058636308480000000
    >>> factorial(-1)
    Traceback (most recent call last):
        ...
    ValueError: n must be >= 0

    Factorials of floats are OK, but the float must be an exact integer:
    >>> factorial(30.1)
    Traceback (most recent call last):
        ...
    ValueError: n must be exact integer
    >>> factorial(30.0)
    265252859812191058636308480000000

    It must also not be ridiculously large:
    >>> factorial(1e100)
    Traceback (most recent call last):
        ...
    OverflowError: n too large
    """

    import math
    if not n >= 0:
        raise ValueError("n must be >= 0")
    if math.floor(n) != n:
        raise ValueError("n must be exact integer")
    if n+1 == n:  # catch a value like 1e300
        raise OverflowError("n too large")
    result = 1
    factor = 2
    while factor <= n:
        result *= factor
        factor += 1
    return result


if __name__ == "__main__":
    import doctest
    doctest.testmod()

Popularity 9/10 Helpfulness 3/10 Language python

Source: docs.python.org

Tags: doctest

Link to this answer
Share Copy Link

Contributed on Jun 27 2022

Rubber Duck

0 Answers Avg Quality 2/10

doctest python

Comment

"""
This is the "example" module.

The example module supplies one function, factorial().  For example,

>>> factorial(5)
120
"""

def factorial(n):
    """Return the factorial of n, an exact integer >= 0.

    >>> [factorial(n) for n in range(6)]
    [1, 1, 2, 6, 24, 120]
    >>> factorial(30)
    265252859812191058636308480000000
    >>> factorial(-1)
    Traceback (most recent call last):
        ...
    ValueError: n must be >= 0

    Factorials of floats are OK, but the float must be an exact integer:
    >>> factorial(30.1)
    Traceback (most recent call last):
        ...
    ValueError: n must be exact integer
    >>> factorial(30.0)
    265252859812191058636308480000000

    It must also not be ridiculously large:
    >>> factorial(1e100)
    Traceback (most recent call last):
        ...
    OverflowError: n too large
    """

    import math
    if not n >= 0:
        raise ValueError("n must be >= 0")
    if math.floor(n) != n:
        raise ValueError("n must be exact integer")
    if n+1 == n:  # catch a value like 1e300
        raise OverflowError("n too large")
    result = 1
    factor = 2
    while factor <= n:
        result *= factor
        factor += 1
    return result


if __name__ == "__main__":
    import doctest
    doctest.testmod()

Popularity 9/10 Helpfulness 2/10 Language python

Source: docs.python.org

Tags: doctest

Link to this answer
Share Copy Link

Contributed on May 22 2021

Talented Thrush

0 Answers Avg Quality 2/10

The simplest way to start using doctest in python

Comment

if __name__ == "__main__":
    import doctest
    doctest.testmod()

Popularity 8/10 Helpfulness 2/10 Language python

Source: docs.python.org

Tags: doctest python pyth

Link to this answer
Share Copy Link

Contributed on Jun 27 2022

Rubber Duck

0 Answers Avg Quality 2/10

how to write a python doctest

Contents

More Related Answers

how to write a python doctest

Closely Related Answers

running doctests python

doctest example in python

doctest python

The simplest way to start using doctest in python

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.