pydoctor.test.test_astbuilder

Return the textual representation and line number of an object's type annotation.

Undocumented

Code inside of if __name__ == '__main__' should be skipped.

Undocumented

Undocumented

If no value in __all__ could be parsed, the result is an empty list.

Values other than lists and tuples assigned to __all__ have no effect and a warning is logged.

Currently, it does not mark instance members as constants, never.

A class variable named __all__ is just an ordinary variable and does not affect Module.all.

If there are multiple assignments to __all__, a warning is logged and the last assignment takes effect.

Non-literals in __all__ are ignored.

Non-string literals in __all__ are ignored.

The value assigned to __all__ is parsed to Module.all.

Undocumented

An assignment to a method in a class body does not change the type of the documentable.

If the name we assign to exists and it does not belong to an Attribute (it's a Function instead, in this test case), the assignment will be ignored.

An assignment to a method inside __init__() does not change the type of the documentable.

If the name we assign to exists and it does not belong to an Attribute (it's a Function instead, in this test case), the assignment will be ignored.

Invalid string annotations must be reported as syntax errors.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Class variables with all-uppercase names are recognized as constants.

Module variables with all-uppercase names are recognized as constants.

Module variables annotated with typing.Final are recognized as constants.

It can recognize constants defined with typing.Final. It will infer the type of the constant if Final do not use subscripts.

It can recognize constants defined with typing.Final[something]

It can recognize constants defined with typing.Final[something]. And it automatically remove the Final part from the annotation.

It warns if there is an invalid Final annotation.

It warns if there is an invalid Final annotation.

Module variables annotated with typing_extensions.Final are recognized as constants.

Constant can be documented as variables at docstring level without any warnings.

Undocumented

It warns when a constant is beeing re defined in instance. But it ignores it's value.

It warns when a constant is beeing re defined in instance. But it ignores it's value. Even if the actual constant definition is detected after the instance variable of the same name.

Undocumented

Undocumented

The value assigned to __docformat__ is parsed to Module.docformat.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

We currently don't trace values for detupling assignments, so when assigning to __doc__ we get a warning about the unknown value.

A variable that is documented should not be considered an alias.

Exceptions are marked with the special kind "EXCEPTION".

Undocumented

Undocumented

Undocumented

When a function has an invalid signature, an error is logged and the empty signature is returned.

Note that most bad signatures lead to a SyntaxError, which we cannot recover from. This test checks what happens if the AST can be produced but inspect.Signature() rejects the parsed parameters.

A round trip from source to inspect.Signature and back produces the original text.

Undocumented

Undocumented

Undocumented

Importing a function from a package should look in the __init__ module.

In this test the following hierarchy is constructed:

    package a
      module __init__
        defines function 'f'
      module c
        imports function 'f'
    module b
      imports function 'f'

We verify that when module b and c import the name f from package a, they import the function f from the module a.__init__.

Importing a module from a package should not look in __init__ module.

In this test the following hierarchy is constructed:

    package a
      module __init__
      module b
        defines function 'f'
    module c
      imports module 'a.b'

We verify that when module c imports the name b from package a, it imports the module a.b which contains f.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Strings inside Literal annotations must not be recursively parsed.

Undocumented

Undocumented

Undocumented

Undocumented

The node2fullname() function finds the full (global) name for a name expression in the AST.

Undocumented

Option --prepend-package option relies simply on the ISystemBuilder interface, so we can test it by using addModuleString, but it's not exactly what happens when we actually run pydoctor. See the other test test_prepend_package_real_path.

In this test, we closer mimics what happens in the driver when --prepend-package option is passed.

Warn when a method is decorated as both property and class/staticmethod. These decoration combinations do not create class/static properties.

Any custom decorator with a name ending in 'property' makes a method into a property getter.

A function decorated with '@property' is documented as an attribute.

Property setter and deleter methods are renamed, so they don't replace the property itself.

If a target module, explicitly re-export via __all__ a set of names that were initially imported from a sub-module via a wildcard, those names are documented as part of the target module.

Relative imports in a package must be resolved by going up one level less, since we don't count "__init__.py" as a level.

Hierarchy:

  top: def f
   - pkg: imports f and g
      - mod: def g

A warning is logged when a relative import goes beyond the top-level package.

Undocumented

Undocumented

Undocumented

Type aliases and type variables are recognized as such.

Undocumented

Annotations or parts thereof that are strings are parsed and line number information is preserved.

Test for issue #474.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented