analyst package

Submodules

analyst.Examples module

analyst.jupyformatter module

analyst.ml module

class analyst.ml.ExampleClass(param1, param2, param3)[source]

Bases: object

The summary line for a class docstring should fit on one line.

If the class has public attributes, they may be documented here in an Attributes section and follow the same formatting as a function’s Args section. Alternatively, attributes may be documented inline with the attribute’s declaration (see __init__ method below).

Properties created with the @property decorator should be documented in the property’s getter method.

attr1

str – Description of attr1.

attr2

int, optional – Description of attr2.

attr3 = None

Doc comment inline with attribute

attr4 = None

list(str) – Doc comment before attribute, with type specified

attr5 = None

str – Docstring after attribute, with type specified.

example_method(param1, param2)[source]

Class methods are similar to regular functions.

Note

Do not include the self parameter in the Args section.

Parameters:
  • param1 – The first parameter.
  • param2 – The second parameter.
Returns:

True if successful, False otherwise.

readonly_property

str – Properties should be documented in their getter method.

readwrite_property

list(str) – Properties with both a getter and setter should only be documented in their getter method.

If the setter method contains notable behavior, it should be mentioned here.

exception analyst.ml.ExampleError(msg, code)[source]

Bases: Exception

Exceptions are documented in the same way as classes.

The __init__ method may be documented in either the class level docstring, or as a docstring on the __init__ method itself.

Either form is acceptable, but the two should not be mixed. Choose one convention to document the __init__ method and be consistent with it.

Note

Do not include the self parameter in the Args section.

Parameters:
  • msg (str) – Human readable string describing the exception.
  • code (int, optional) – Error code.
msg

str – Human readable string describing the exception.

code

int – Exception error code.

analyst.ml.example_generator(n)[source]

Generators have a Yields section instead of a Returns section.

Parameters:n (int) – The upper limit of the range to generate, from 0 to n - 1.
Yields:int – The next number in the range of 0 to n - 1.

Examples

Examples should be written in doctest format, and should illustrate how to use the function.

>>> print([i for i in example_generator(4)])
[0, 1, 2, 3]
analyst.ml.function_with_pep484_type_annotations(param1: int, param2: str) → bool[source]

Example function with PEP 484 type annotations.

Parameters:
  • param1 – The first parameter.
  • param2 – The second parameter.
Returns:

The return value. True for success, False otherwise.

analyst.ml.function_with_types_in_docstring(param1, param2)[source]

Example function with types documented in the docstring.

PEP 484 type annotations are supported. If attribute, parameter, and return types are annotated according to PEP 484, they do not need to be included in the docstring:

Parameters:
  • param1 (int, =1) – The first parameter. Line-break-ed.
  • param2, param3 (str) – The second and 3rd parameter.
Returns:

The return value. True for success, False otherwise. # Used Return instead of Returns. bool:

Indented line break

rv (float):

Returned float value with line break above.

Return type:

bool

analyst.ml.module_level_function(param1, param2=None, *args, **kwargs)[source]

This is an example of a module level function.

Function parameters should be documented in the Args section. The name of each parameter is required. The type and description of each parameter is optional, but should be included if not obvious.

If *args or **kwargs are accepted, they should be listed as *args and **kwargs.

The format for a parameter is:

name (type): description
    The description may span multiple lines. Following
    lines should be indented. The "(type)" is optional.

    Multiple paragraphs are supported in parameter
    descriptions.
Parameters:
  • param1 (int) – The first parameter.
  • param2 (str, optional) – The second parameter. Defaults to None. Second line of description should be indented.
  • *args – Variable length argument list.
  • **kwargs – Arbitrary keyword arguments.
Returns:

True if successful, False otherwise.

The return type is optional and may be specified at the beginning of the Returns section followed by a colon.

The Returns section may span multiple lines and paragraphs. Following lines should be indented to match the first line.

The Returns section supports any reStructuredText formatting, including literal blocks:

{
    'param1': param1,
    'param2': param2
}

Return type:

bool

Raises:
  • AttributeError – The Raises section is a list of all exceptions that are relevant to the interface.
  • ValueError – If param2 is equal to param1.
analyst.ml.module_level_variable2 = 98765

int – Module level variable documented inline.

The docstring may span multiple lines. The type may optionally be specified on the first line, separated by a colon.

analyst.ml.test(text='Hello world')[source]

analyst.nd module

analyst.nd.test(text='Hello world')[source]

Module contents