Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/mkdocstrings/griffe
/ functions
Functions
1,229 in github.com/mkdocstrings/griffe
⨍
Functions
1,229
◇
Types & classes
163
↳
Endpoints
4
Function
test_multiline_docstring
Parse a multi-line docstring. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:46
Function
test_multiline_docstring
Parse a multi-line docstring. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:40
Function
test_multipart_imports
Assert that a multipart path like `a.b.c` imported as `x` points to the right target.
packages/griffelib/tests/test_nodes.py:128
Function
test_multiple_lines_in_sections_items
Parse multi-line item description. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:83
Function
test_multiple_nested_namespace_packages
Load a deeply nested namespace package appearing in several places.
packages/griffelib/tests/test_loader.py:304
Function
test_name_resolution
Name are correctly resolved in the scope of an object.
packages/griffelib/tests/test_models.py:462
Function
test_namespace_packages
Test support for namespace packages. Namespace packages are a bit special as they have no `__init__.py` file.
packages/griffelib/tests/test_encoders.py:49
Function
test_nested_class_inheritance
Test nested class inheritance. Parameters: agent: A parametrized agent to load a module.
packages/griffelib/tests/test_inheritance.py:89
Function
test_nested_namespace_packages
Load a deeply nested namespace package.
packages/griffelib/tests/test_loader.py:290
Function
test_never_warn_about_unknown_other_parameters
Never warn about unknown parameters in "Other parameters" sections. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:867
Function
test_never_warn_about_unknown_other_parameters
Never warn about unknown parameters in "Other parameters" sections. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:912
Function
test_no_empty_text_section
Don't create a single empty text section for an empty docstring. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:579
Function
test_no_module_docstrings_in_internal_api
No module docstrings should be written in our internal API. The reasoning is that docstrings are addressed to users of the public API, but in
packages/griffelib/tests/test_api.py:213
Function
test_non_init_fields
Test that non-init fields are not included in the `__init__` method.
packages/griffelib/tests/test_extensions/test_dataclasses.py:37
Function
test_non_total_typeddict
Test our `TypedDict` support with non-total `TypedDict`s.
packages/griffelib/tests/test_extensions/test_unpack_typeddict.py:104
Function
test_non_total_unpack
Test unpacking non-total `TypedDict`s.
packages/griffelib/tests/test_extensions/test_unpack_typeddict.py:141
Function
test_not_calling_package_hook_on_something_else_than_package
Always call the `on_package` hook on a package, not any other object.
packages/griffelib/tests/test_loader.py:491
Function
test_not_defined_at_runtime
Assert that objects not defined at runtime are not added to wildcards expansions.
packages/griffelib/tests/test_visitor.py:20
Function
test_not_detecting_imported_objects_as_public
Imported objects not listed in `__all__` must not be considered public.
packages/griffelib/tests/test_public_api.py:6
Function
test_not_finding_namespace_package_twice
Deduplicate paths when finding namespace packages.
packages/griffelib/tests/test_finder.py:358
Function
test_not_overriding_module_with_alias_from_wildcard_import
Do not override a submodule with an imported object with the same name.
packages/griffelib/tests/test_loader.py:500
Function
test_not_resolving_attribute_value_to_itself
Attribute values with same name don't resolve to themselves.
packages/griffelib/tests/test_models.py:542
Function
test_other_parameters_section
Parse other parameters section. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:407
Function
test_override_exports
Assert that exports are overridden too (like imports are merged).
packages/griffelib/tests/test_merger.py:52
Function
test_overwrite_module_with_attribute
Check we are able to overwrite a module with an attribute.
packages/griffelib/tests/test_loader.py:218
Function
test_parameter_line_without_colon
Warn when missing colon. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:807
Function
test_parameter_line_without_colon_keyword_only
Warn when missing colon. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:824
Function
test_parameters_annotated_as_initvar
Don't return InitVar annotated fields as class members. But if __init__ is defined, InitVar has no effect.
packages/griffelib/tests/test_models.py:298
Function
test_parameters_are_reorderd_to_match_their_kind
Keyword-only parameters in base class are pushed back to the end of the signature.
packages/griffelib/tests/test_models.py:275
Function
test_parameters_section
Parse parameters section. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:363
Function
test_parentheses_preserved
Parentheses used to enforce an order of operations should not be removed.
packages/griffelib/tests/test_expressions.py:207
Function
test_parse__all_attribute_names__param_section
Parse all attributes directives. Parameters: parse_sphinx: Fixture parser. attribute_directive_name: A parametrized directive nam
packages/griffelib/tests/test_docstrings/test_sphinx.py:840
Function
test_parse__all_exception_names__param_section
Parse all raise directives. Parameters: parse_sphinx: Fixture parser. raise_directive_name: A parametrized directive name.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1185
Function
test_parse__all_param_names__param_section
Parse all parameters directives. Parameters: parse_sphinx: Fixture parser. param_directive_name: A parametrized directive name.
packages/griffelib/tests/test_docstrings/test_sphinx.py:143
Function
test_parse__attribute_duplicate__error
Warn on duplicate attribute directive. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:938
Function
test_parse__attribute_field_multi_line__param_section
Parse multiline attributes. Parameters: parse_sphinx: Fixture parser. docstring: A parametrized docstring.
packages/griffelib/tests/test_docstrings/test_sphinx.py:815
Function
test_parse__attribute_invalid_directive___error
Warn on invalid attribute directive. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:906
Function
test_parse__attribute_no_name__error
Warn on invalid attribute directive. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:922
Function
test_parse__class_attributes__attributes_section
Parse class attributes. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:863
Function
test_parse__class_attributes_type_invalid__error
Warn on invalid attribute type directive. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:955
Function
test_parse__class_attributes_type_no_name__error
Warn on invalid attribute directive. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:972
Function
test_parse__class_attributes_with_type__annotation_in_attributes_section
Parse typed class attributes. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:884
Function
test_parse__description_only_docstring__single_markdown_section
Parse a single or multiline docstring. Parameters: parse_sphinx: Fixture parser. docstring: A parametrized docstring.
packages/griffelib/tests/test_docstrings/test_sphinx.py:51
Function
test_parse__invalid_param_field_only_initial_marker__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:500
Function
test_parse__invalid_param_field_wrong_part_count__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:516
Function
test_parse__invalid_param_field_wrong_part_count_spaces_4__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:532
Function
test_parse__module_attributes_section__expected_attributes_section
Parse attributes section in modules. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1239
Function
test_parse__multiple_blank_lines_before_description__single_markdown_section
Parse a docstring with initial blank lines. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:80
Function
test_parse__multiple_raises_directive__exception_section_with_two
Parse multiple raise directives. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1150
Function
test_parse__no_description__single_markdown_section
Parse an empty docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:66
Function
test_parse__only_param_field__empty_markdown
Parse only a parameter section. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:120
Function
test_parse__param_field__param_section
Parse a parameter section. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:99
Function
test_parse__param_field_annotate_type__param_section_with_type
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:413
Function
test_parse__param_field_docs_type__param_section_with_type
Parse parameters with types. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:219
Function
test_parse__param_field_for_function__param_section_with_kind
Parse parameters. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:198
Function
test_parse__param_field_multi_line__param_section
Parse multiline directives. Parameters: parse_sphinx: Fixture parser. docstring: A parametrized docstring.
packages/griffelib/tests/test_docstrings/test_sphinx.py:182
Function
test_parse__param_field_no_matching_param__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:484
Function
test_parse__param_field_no_matching_param__result_from_docstring
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:438
Function
test_parse__param_field_type_field__param_section_with_type
Parse parameters with separated types. Parameters: parse_sphinx: Fixture parser. type_: The type to use in the type directive.
packages/griffelib/tests/test_docstrings/test_sphinx.py:241
Function
test_parse__param_field_type_field__param_section_with_type_with_parent
Parse parameters with separated types. Parameters: parse_sphinx: Fixture parser. type_: The type to use in the type directive.
packages/griffelib/tests/test_docstrings/test_sphinx.py:265
Function
test_parse__param_field_type_field_first__param_section_with_type
Parse parameters with separated types first. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:296
Function
test_parse__param_field_type_field_first__param_section_with_type_with_parent
Parse parameters with separated types first. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:318
Function
test_parse__param_field_type_field_or_none__param_section_with_optional
Parse parameters with separated union types. Parameters: parse_sphinx: Fixture parser. union: A parametrized union type.
packages/griffelib/tests/test_docstrings/test_sphinx.py:346
Function
test_parse__param_field_type_field_or_none__param_section_with_optional_with_parent
Parse parameters with separated union types. Parameters: parse_sphinx: Fixture parser. union: A parametrized union type.
packages/griffelib/tests/test_docstrings/test_sphinx.py:381
Function
test_parse__param_field_with_default__result_from_docstring
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:459
Function
test_parse__param_multiline
Parse multiline parameter descriptions. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:750
Function
test_parse__param_twice__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:606
Function
test_parse__param_type_no_name__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:730
Function
test_parse__param_type_no_type__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:710
Function
test_parse__param_type_twice_annotated__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:666
Function
test_parse__param_type_twice_doc__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:626
Function
test_parse__param_type_twice_type_directive_first__error_message
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:646
Function
test_parse__properties_return_type
Parse attributes section in modules. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1284
Function
test_parse__raise_invalid__error
Warn on invalid raise directives. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1207
Function
test_parse__raise_no_name__error
Warn on invalid raise directives. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1223
Function
test_parse__raises_directive__exception_section
Parse raise directives. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1129
Function
test_parse__return_directive__return_section_no_type
Parse return directives. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:989
Function
test_parse__return_directive_annotation__prefer_return_directive
Prefer docstring type over return annotation. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1075
Function
test_parse__return_directive_annotation__return_section_with_type
Parse return directives with return annotation. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1054
Function
test_parse__return_directive_rtype__return_section_with_type
Parse typed return directives. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1010
Function
test_parse__return_directive_rtype_first__return_section_with_type
Parse typed-first return directives. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1032
Function
test_parse__return_invalid__error
Warn on invalid return directive. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1097
Function
test_parse__rtype_invalid__error
Warn on invalid typed return directive. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1113
Function
test_parse__valid_param_field_part_count_3
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:558
Function
test_parse__valid_param_field_part_count_3_with_parent
Parse a simple docstring. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:579
Function
test_parse_admonitions
Parse admonitions. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1322
Function
test_parse_annotations_in_all_sections
Assert annotations are parsed in all relevant sections. Parameters: parse_numpy: Fixture parser. docstring: Parametrized docstrin
packages/griffelib/tests/test_docstrings/test_numpy.py:309
Function
test_parse_args_and_kwargs
Parse args and kwargs. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:592
Function
test_parse_args_kwargs_keyword_only
Parse args and kwargs. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:614
Function
test_parse_attributes_in__all__
Parse attributes in `__all__`.
packages/griffelib/tests/test_visitor.py:378
Function
test_parse_attributes_section
Parse Attributes sections. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:326
Function
test_parse_classes_section
Parse Classes sections. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:374
Function
test_parse_classes_section
Parse Classes sections. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:694
Function
test_parse_complex__all__assignments
Check our ability to expand exports based on `__all__` [augmented] assignments. Parameters: statements: Parametrized text containing `__a
packages/griffelib/tests/test_visitor.py:205
Function
test_parse_complex_annotations
Check the type regex accepts all the necessary characters. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:268
Function
test_parse_deep_attributes_in__all__
Parse deep attributes in `__all__`.
packages/griffelib/tests/test_visitor.py:390
Function
test_parse_examples_sections
Parse a function docstring with examples. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:448
Function
test_parse_functions_section
Parse Functions/Methods sections. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:343
Function
test_parse_functions_section
Parse Functions/Methods sections. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:657
Function
test_parse_modules_section
Parse Modules sections. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:424
← previous
next →
1,001–1,100 of 1,229, ranked by callers