MCPcopy Create free account

hub / github.com/mkdocstrings/griffe / functions

Functions1,229 in github.com/mkdocstrings/griffe

Functiontest_parse_modules_section
Parse Modules sections. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:723
Functiontest_parse_optional_type_in_docstring
Parse optional types in docstring. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:699
Functiontest_parse_parameters_and_type_without_space
Parse parameter name and type without space. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:928
Functiontest_parse_partially_indented_lines
Properly handle partially indented lines. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:63
Functiontest_parse_pep695_generics
Assert PEP 695 generics are correctly parsed.
packages/griffelib/tests/test_visitor.py:455
Functiontest_parse_pep695_generics_without_defaults
Assert PEP 695 generics are correctly inspected.
packages/griffelib/tests/test_visitor.py:406
Functiontest_parse_receives_multiple_items
Parse Returns section with and without multiple items. Parameters: parse_google: Fixture parser. receives_multiple_items: Whether
packages/griffelib/tests/test_docstrings/test_google.py:1700
Functiontest_parse_receives_tuple_in_generator
Parse Receives annotations in Generator type. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1228
Functiontest_parse_receives_tuple_in_generator
Parse Receives annotations in Generator type. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:1127
Functiontest_parse_returns_multiple_items
Parse Returns section with and without multiple items. Parameters: parse_google: Fixture parser. returns_multiple_items: Whether
packages/griffelib/tests/test_docstrings/test_google.py:1558
Functiontest_parse_returns_tuple_in_generator
Parse Returns annotations in Generator type. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1290
Functiontest_parse_returns_tuple_in_generator
Parse Returns annotations in Generator type. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:1194
Functiontest_parse_starred_parameters
Parse parameters names with stars in them. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:388
Functiontest_parse_type_aliases_section
Parse Type Aliases sections. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:400
Functiontest_parse_type_var_tuples_and_param_specs
Parse type variable tuples and parameter specifications. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:964
Functiontest_parse_types_in_docstring
Parse types in docstring. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:644
Functiontest_parse_with_annotations
Parse a function docstring with signature annotations. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:292
Functiontest_parse_without_annotations
Parse a function docstring without signature annotations. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:258
Functiontest_parse_without_parent
Parse a docstring without a parent function. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:226
Functiontest_parse_yields_multiple_items
Parse Returns section with and without multiple items. Parameters: parse_google: Fixture parser. returns_multiple_items: Whether
packages/griffelib/tests/test_docstrings/test_google.py:1629
Functiontest_parse_yields_section
Parse Yields section. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:526
Functiontest_parse_yields_section_with_return_annotation
Parse Yields section with a return annotation in the parent function. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1116
Functiontest_parse_yields_tuple_in_iterator_or_generator
Parse Yields annotations in Iterator or Generator types. Parameters: parse_google: Fixture parser. return_annotation: Parametrize
packages/griffelib/tests/test_docstrings/test_google.py:1143
Functiontest_parse_yields_tuple_in_iterator_or_generator
Parse Yields annotations in Iterator or Generator types. Parameters: parse_numpy: Fixture parser. return_annotation: Parametrized
packages/griffelib/tests/test_docstrings/test_numpy.py:1035
Functiontest_parsing_choices
Correctly parse choices. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:1339
Functiontest_parsing_complex_string_annotations
Test parsing of complex, stringified annotations.
packages/griffelib/tests/test_nodes.py:240
Functiontest_parsing_dynamic_base_classes
Assert parsing dynamic base classes does not trigger errors. Parameters: caplog: Pytest fixture to capture logs.
packages/griffelib/tests/test_nodes.py:264
Functiontest_prefer_docstring_bounds_over_annotations
Prefer the docstring bound over the annotation. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:991
Functiontest_prefer_docstring_type_over_annotation
Prefer the type written in the docstring over the annotation in the parent. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:245
Functiontest_prefer_docstring_types_over_annotations
Prefer the docstring type over the annotation. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:753
Functiontest_pth_file_handling
Assert .pth files are correctly handled. Parameters: tmp_path: Pytest fixture.
packages/griffelib/tests/test_finder.py:90
Functiontest_pth_file_handling_with_semi_colon
Assert .pth files are correctly handled. Parameters: tmp_path: Pytest fixture.
packages/griffelib/tests/test_finder.py:114
Functiontest_raises_section
Parse raises section. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:583
Functiontest_reading_property_type_in_summary
Assert we can parse the return type of properties in their summary. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1897
Functiontest_readonly_fields
Test our `TypedDict` support with `ReadOnly` fields.
packages/griffelib/tests/test_extensions/test_unpack_typeddict.py:217
Functiontest_receives_section
Parse receives section. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:555
Functiontest_recursive_wildcard_expansion
Assert that wildcards are expanded recursively.
packages/griffelib/tests/test_loader.py:36
Functiontest_regular_class_inheriting_dataclass_dont_get_its_own_params
A regular class inheriting from a dataclass don't have its attributes added to `__init__`.
packages/griffelib/tests/test_models.py:201
Functiontest_regular_class_inheriting_dataclass_is_labelled_dataclass
A regular class inheriting from a dataclass is labelled as a dataclass too.
packages/griffelib/tests/test_models.py:225
Functiontest_relative_to_absolute_imports
Check if relative imports are correctly converted to absolute ones. Parameters: code: The parametrized module code. path: The par
packages/griffelib/tests/test_nodes.py:113
Functiontest_relying_on_modules_path_attribute
Load a package that relies on the `__path__` attribute of a module.
packages/griffelib/tests/test_loader.py:480
Functiontest_render_dict_comprehension
Assert dict comprehensions are rendered correctly.
packages/griffelib/tests/test_expressions.py:236
Functiontest_resolve_aliases_of_builtin_modules
Assert builtin/compiled modules can be loaded.
packages/griffelib/tests/test_loader.py:369
Functiontest_resolving_full_names
Assert expressions are correctly transformed to their fully-resolved form.
packages/griffelib/tests/test_expressions.py:64
Functiontest_resolving_init_parameter
Instance attribute values should resolve to matching parameters. They must not resolve to the member of the same name in the same class, or t
packages/griffelib/tests/test_expressions.py:166
Functiontest_resolving_never_raises_alias_errors
Resolving never raises alias errors.
packages/griffelib/tests/test_models.py:555
Functiontest_resolving_type_parameters
Assert type parameters are correctly transformed to their fully-resolved form.
packages/griffelib/tests/test_expressions.py:216
Functiontest_retrieve_annotation_from_parent
Retrieve parameter annotation from the parent object. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:432
Functiontest_retrieve_attributes_annotation_from_parent
Retrieve the annotations of attributes from the parent object. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1090
Functiontest_retrieve_attributes_annotation_from_parent
Retrieve the annotations of attributes from the parent object. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:854
Functiontest_returns_section
Parse returns section. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:475
Functiontest_scanning_package_and_module_with_same_names
The finder correctly scans package and module having same the name. Parameters: namespace_package: Whether the temporary package is a nam
packages/griffelib/tests/test_finder.py:325
Functiontest_scikit_build_core_file_handling
Assert editable modules by `scikit-build-core` are handled. Parameters: tmp_path: Pytest fixture.
packages/griffelib/tests/test_finder.py:192
Functiontest_seed
(seed: int, revisit: bool = False)
duties.py:505
Functiontest_set_class_labels_using_decorators
Assert decorators are used to set labels on classes. Parameters: decorator: A parametrized decorator. labels: The parametrized tu
packages/griffelib/tests/test_visitor.py:103
Functiontest_set_function_labels_using_decorators
Assert decorators are used to set labels on functions. Parameters: decorator: A parametrized decorator. labels: The parametrized
packages/griffelib/tests/test_visitor.py:72
Functiontest_set_parameters
We can set parameters.
packages/griffelib/tests/test_models.py:511
Functiontest_set_type_parameters
We can set type parameters.
packages/griffelib/tests/test_models.py:606
Functiontest_setuptools_file_handling
Assert editable modules by `setuptools` are handled. Parameters: tmp_path: Pytest fixture. annotation: The type annotation of the
packages/griffelib/tests/test_finder.py:154
Functiontest_setuptools_file_handling_multiple_paths
Assert editable modules by `setuptools` are handled when multiple packages are installed in the same editable. Parameters: tmp_path: Pyte
packages/griffelib/tests/test_finder.py:171
Functiontest_show_debug_info
Show debug information. Parameters: capsys: Pytest fixture to capture output.
packages/griffecli/tests/test_cli.py:45
Functiontest_show_help
Show help. Parameters: capsys: Pytest fixture to capture output.
packages/griffecli/tests/test_cli.py:21
Functiontest_show_version
Show version. Parameters: capsys: Pytest fixture to capture output.
packages/griffecli/tests/test_cli.py:33
Functiontest_side_loading_sibling_private_module
Automatically load `_a` when `a` (wildcard) imports from it. Parameters: wildcard: Whether the import is a wildcard import. exter
packages/griffelib/tests/test_loader.py:441
Functiontest_simple_docstring
Parse a simple docstring. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:35
Functiontest_simple_docstring
Parse a simple docstring. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:29
Functiontest_single_line_with_trailing_whitespace
Don't crash on single line docstrings with trailing whitespace. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1514
Functiontest_single_locations
All objects have a single public location.
packages/griffelib/tests/test_api.py:147
Functiontest_skip_modules_with_dots_in_filename
Check that modules with dots in their filenames are skipped. Parameters: caplog: Pytest fixture to capture logs.
packages/griffelib/tests/test_loader.py:277
Functiontest_starting_item_description_on_new_line
In sections with items, allow starting item descriptions on a new (indented) line. Parameters: parse_google: Fixture parser. sect
packages/griffelib/tests/test_docstrings/test_google.py:210
Functiontest_stop_at_first_package_inside_namespace_package
Stop loading similar paths once we found a non-namespace package.
packages/griffelib/tests/test_loader.py:335
Functiontest_submodule_exports
Check that a module is exported depending on whether it was also imported.
packages/griffelib/tests/test_models.py:33
Functiontest_submodule_shadowing_member
Warn when a submodule shadows a member of the same name. Parameters: init: Contents of the top-level init module.
packages/griffelib/tests/test_loader.py:424
Functiontest_trim_doctest_flags_basic_example
Correctly parse simple example docstrings when `trim_doctest_flags` option is turned on. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1461
Functiontest_trim_doctest_flags_basic_example
Correctly parse simple example docstrings when `trim_doctest_flags` option is turned on. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:1284
Functiontest_trim_doctest_flags_multi_example
Correctly parse multiline example docstrings when `trim_doctest_flags` option is turned on. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1479
Functiontest_trim_doctest_flags_multi_example
Correctly parse multiline example docstrings when `trim_doctest_flags` option is turned on. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:1302
Functiontest_type_in_receives_without_parentheses
Assert we can parse the return type without parentheses. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1860
Functiontest_type_in_returns_without_parentheses
Assert we can parse the return type without parentheses. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1786
Functiontest_type_in_yields_without_parentheses
Assert we can parse the return type without parentheses. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1823
Functiontest_type_parameter_line_without_colon
Warn when missing colon. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1029
Functiontest_typeddict_support
Test our `TypedDict` support.
packages/griffelib/tests/test_extensions/test_unpack_typeddict.py:6
Functiontest_uncomputable_mro
Test uncomputable MRO. Parameters: classes: A list of classes inheriting from each other. cls: The class to compute the MRO of.
packages/griffelib/tests/test_inheritance.py:157
Functiontest_unique_names
All internal objects have unique names.
packages/griffelib/tests/test_api.py:136
Functiontest_unknown_params_scan_doesnt_crash_without_parameters
Assert we don't crash when parsing parameters sections and parent object does not have parameters. Parameters: parse_google: Fixture pars
packages/griffelib/tests/test_docstrings/test_google.py:892
Functiontest_unknown_params_scan_doesnt_crash_without_parameters
Assert we don't crash when parsing parameters sections and parent object does not have parameters. Parameters: parse_numpy: Fixture parse
packages/griffelib/tests/test_docstrings/test_numpy.py:940
Functiontest_unknown_type_params_scan_doesnt_crash_without_type_parameters
Assert we don't crash when parsing type parameters sections and parent object does not have type parameters. Parameters: parse_google: Fi
packages/griffelib/tests/test_docstrings/test_google.py:1072
Functiontest_unpack_support
Test our `Unpack` support.
packages/griffelib/tests/test_extensions/test_unpack_typeddict.py:53
Functiontest_unsupported_item_in_all
Check that unsupported items in `__all__` log a warning. Parameters: caplog: Pytest fixture to capture logs.
packages/griffelib/tests/test_loader.py:259
Functiontest_visit_function_keyword_only_param
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:70
Functiontest_visit_function_keyword_only_param_with_default
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:82
Functiontest_visit_function_params_annotations
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:117
Functiontest_visit_function_positional_only_param
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:22
Functiontest_visit_function_positional_only_param_with_default
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:34
Functiontest_visit_function_positional_or_keyword_param
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:46
Functiontest_visit_function_positional_or_keyword_param_with_default
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:58
Functiontest_visit_function_syntax_error
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:94
Functiontest_visit_function_variadic_params
Test functions variadic parameters visit.
packages/griffelib/tests/test_functions.py:100
Functiontest_visit_properties_as_attributes
Assert properties are created as attributes and not functions.
packages/griffelib/tests/test_visitor.py:269
Functiontest_visit_simple_function
Test functions parameters loading.
packages/griffelib/tests/test_functions.py:10
← previousnext →1,101–1,200 of 1,229, ranked by callers