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_disabled_warnings
Assert warnings are disabled. Parameters: parse_sphinx: Fixture parser.
packages/griffelib/tests/test_docstrings/test_sphinx.py:1303
Function
test_disabled_warnings
Assert warnings are disabled. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1918
Function
test_disabled_warnings
Assert warnings are disabled. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:1358
Function
test_dont_crash_on_nested_functions_in_init
Assert we don't crash when visiting a nested function in `__init__` methods.
packages/griffelib/tests/test_visitor.py:234
Function
test_dont_crash_on_text_annotations
Don't crash while parsing annotations containing unhandled nodes. Parameters: parse_numpy: Fixture parser. caplog: Pytest fixture
packages/griffelib/tests/test_docstrings/test_numpy.py:323
Function
test_dont_insert_admonition_before_current_section
Check that admonitions are inserted at the right place. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:1389
Function
test_dont_overwrite_lower_member_when_expanding_wildcard
Check that we don't overwrite a member defined after the import when expanding a wildcard.
packages/griffelib/tests/test_loader.py:87
Function
test_dont_shortcut_alias_chain_after_expanding_wildcards
Assert public aliases paths are not resolved to canonical paths when expanding wildcards.
packages/griffelib/tests/test_loader.py:65
Function
test_dont_trigger_alias_resolution_when_merging_stubs
Assert that we don't trigger alias resolution when merging stubs.
packages/griffelib/tests/test_merger.py:8
Function
test_doubly_indented_lines_in_section_items
In sections with items, don't remove all spaces on the left of indented lines. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:110
Function
test_dynamic_base_classes
Test dynamic base classes.
packages/griffelib/tests/test_inheritance.py:169
Function
test_editables_file_handling
Assert editable modules by `editables` are handled. Parameters: tmp_path: Pytest fixture.
packages/griffelib/tests/test_finder.py:138
Function
test_empty_indented_lines_in_section_with_items
In sections with items, don't treat lines with just indentation as items. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:183
Function
test_empty_indented_lines_in_section_with_items
In sections with items, don't treat lines with just indentation as items. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:98
Function
test_encoding_pep695_generics
Test serialization and de-serialization of PEP 695 generics with defaults. Defaults are only possible from Python 3.13 onwards.
packages/griffelib/tests/test_encoders.py:127
Function
test_encoding_pep695_generics_without_defaults
Test serialization and de-serialization of PEP 695 generics without defaults. Defaults are only possible from Python 3.13 onwards.
packages/griffelib/tests/test_encoders.py:99
Function
test_examples_section
Parse examples section. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:750
Function
test_examples_section_as_last
Parse examples section being last in the docstring. Parameters: parse_numpy: Parse function (fixture).
packages/griffelib/tests/test_docstrings/test_numpy.py:811
Function
test_examples_section_when_followed_by_named_section
Parse examples section followed by another section. Parameters: parse_numpy: Parse function (fixture).
packages/griffelib/tests/test_docstrings/test_numpy.py:789
Function
test_explicit_requiredness
Test our `TypedDict` support with explicit requiredness.
packages/griffelib/tests/test_extensions/test_unpack_typeddict.py:181
Function
test_explode_return_annotations
Check that we correctly split items from return annotations. Parameters: annotation: The return annotation. items: The number of
packages/griffelib/tests/test_expressions.py:23
Function
test_exposed_objects
All public objects in the internal API are exposed under `griffe`.
packages/griffelib/tests/test_api.py:124
Function
test_expressions
Test building annotations from AST nodes. Parameters: code: An expression (parametrized).
packages/griffelib/tests/test_expressions.py:80
Function
test_extract_received_type_with_single_return_item
Extract main type annotation from Iterator or Generator. Parameters: parse_google: Fixture parser. return_annotation: Parametrize
packages/griffelib/tests/test_docstrings/test_google.py:1264
Function
test_extract_received_type_with_single_return_item
Extract main type annotation from Iterator or Generator. Parameters: parse_numpy: Fixture parser. return_annotation: Parametrized
packages/griffelib/tests/test_docstrings/test_numpy.py:1166
Function
test_extract_yielded_type_with_single_return_item
Extract main type annotation from Iterator or Generator. Parameters: parse_google: Fixture parser. return_annotation: Parametrize
packages/griffelib/tests/test_docstrings/test_google.py:1178
Function
test_extract_yielded_type_with_single_return_item
Extract main type annotation from Iterator or Generator. Parameters: parse_numpy: Fixture parser. return_annotation: Parametrized
packages/griffelib/tests/test_docstrings/test_numpy.py:1073
Function
test_fields_with_init_false
Fields marked with `init=False` are not added to the `__init__` method.
packages/griffelib/tests/test_models.py:242
Function
test_find_module_with_path
Check that the finder can find modules using strings and Paths. Parameters: pypackage: A temporary package (metadata) on the file system
packages/griffelib/tests/test_finder.py:30
Function
test_find_pkg_style_namespace_packages
Check that the finder can find pkg-style namespace packages. Parameters: statement: The statement in the `__init__` module allowing to ma
packages/griffelib/tests/test_finder.py:65
Function
test_finding_stubs_packages
Find stubs-only packages. Parameters: tmp_path: Pytest fixture.
packages/griffelib/tests/test_finder.py:252
Function
test_forcing_inspection
Load a package with forced dynamic analysis.
packages/griffelib/tests/test_loader.py:467
Function
test_forward_docstrings
Assert docstrings of class attributes are forwarded to instance assignments. This is a regression test for https://github.com/mkdocstrings/griffe
packages/griffelib/tests/test_visitor.py:290
Function
test_forward_references
Check that we support forward references (type names as strings). Parameters: code: Parametrized code. has_name: Whether the anno
packages/griffelib/tests/test_nodes.py:197
Function
test_full_expressions
Assert we can transform expressions to their full form without errors.
packages/griffelib/tests/test_expressions.py:57
Function
test_fuzzing_on_stdlib
Run Griffe on the standard library.
packages/griffelib/tests/test_stdlib.py:47
Function
test_get_correct_docstring_starting_line_number
Assert we get the correct line numbers for docstring.
packages/griffelib/tests/test_visitor.py:247
Function
test_git_failures
Test failures to use Git.
packages/griffelib/tests/test_git.py:102
Function
test_handle_aliases_chain_in_has_docstrings
Assert the `.has_docstrings` method can handle aliases chains in members.
packages/griffelib/tests/test_models.py:63
Function
test_handle_false_admonitions_correctly
Correctly handle lines that look like admonitions. Parameters: parse_google: Fixture parser. docstring: The docstring to parse (p
packages/griffelib/tests/test_docstrings/test_google.py:1375
Function
test_handle_property_setter_and_deleter
Assert property setters and deleters are supported.
packages/griffelib/tests/test_visitor.py:121
Function
test_handle_typing_overaload
Assert `typing.overload` is supported. Parameters: decorator: A parametrized overload decorator.
packages/griffelib/tests/test_visitor.py:149
Function
test_handling_modernization_without_crashing
Modernizing expressions never crashes. Parameters: annotation: Original annotation (parametrized).
packages/griffelib/tests/test_expressions.py:136
Function
test_has_docstrings
Assert the `.has_docstrings` method is recursive.
packages/griffelib/tests/test_models.py:50
Function
test_has_docstrings_does_not_trigger_alias_resolution
Assert the `.has_docstrings` method does not trigger alias resolution.
packages/griffelib/tests/test_models.py:78
Function
test_has_docstrings_does_not_try_to_resolve_alias
Assert that checkins presence of docstrings does not trigger alias resolution.
packages/griffelib/tests/test_loader.py:26
Function
test_has_docstrings_submodules
Assert the `.has_docstrings` method descends into submodules.
packages/griffelib/tests/test_models.py:56
Function
test_ignore_init_summary
Correctly ignore summary in `__init__` methods' docstrings. Parameters: parse_google: Fixture parser. docstring: The docstring to
packages/griffelib/tests/test_docstrings/test_google.py:1422
Function
test_ignore_init_summary
Correctly ignore summary in `__init__` methods' docstrings. Parameters: parse_numpy: Fixture parser. docstring: The docstring to
packages/griffelib/tests/test_docstrings/test_numpy.py:1242
Function
test_indented_code_block
Parse indented code blocks. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:129
Function
test_indented_code_block
Parse indented code blocks. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:76
Function
test_inheriting_self_from_parent_class
Inspect self only once when inheriting it from parent class.
packages/griffelib/tests/test_inspector.py:224
Function
test_inspect_properties_as_attributes
Assert properties are created as attributes and not functions.
packages/griffelib/tests/test_inspector.py:113
Function
test_inspected_class_source
Check the source property of a class.
packages/griffelib/tests/test_models.py:371
Function
test_inspected_module_source
Check the source property of a module.
packages/griffelib/tests/test_models.py:364
Function
test_inspected_object_source_with_missing_line_number
Check the source property of an object with missing line number.
packages/griffelib/tests/test_models.py:382
Function
test_inspecting_class_instance
Assert class instances are correctly inspected.
packages/griffelib/tests/test_inspector.py:211
Function
test_inspecting_module_importing_other_module
Assert aliases to modules are correctly inspected and aliased.
packages/griffelib/tests/test_inspector.py:137
Function
test_inspecting_module_with_imported_submodules
When inspecting a package on the disk, direct submodules should be skipped entirely.
packages/griffelib/tests/test_inspector.py:165
Function
test_inspecting_module_with_submodules
Inspecting a module shouldn't register any of its submodules if they're not imported.
packages/griffelib/tests/test_inspector.py:157
Function
test_inspecting_objects_from_private_builtin_stdlib_moduless
Inspect objects from private built-in modules in the standard library.
packages/griffelib/tests/test_inspector.py:183
Function
test_inspecting_package_and_module_with_same_names
Package and module having same name shouldn't cause issues.
packages/griffelib/tests/test_inspector.py:151
Function
test_inspecting_parameters_with_functions_as_default_values
Assert functions as default parameter values are serialized with their name.
packages/griffelib/tests/test_inspector.py:144
Function
test_inspecting_partials_as_functions
Assert partials are correctly inspected as functions.
packages/griffelib/tests/test_inspector.py:194
Function
test_inspecting_pep695_generics
Assert PEP 695 generics are correctly inspected.
packages/griffelib/tests/test_inspector.py:300
Function
test_inspecting_pep695_generics_without_defaults
Assert PEP 695 generics are correctly inspected.
packages/griffelib/tests/test_inspector.py:251
Function
test_invalid_sections
Warn on invalid sections. Parameters: parse_google: Fixture parser.
packages/griffelib/tests/test_docstrings/test_google.py:557
Function
test_inventory_matches_api
The inventory doesn't contain any additional Python object.
packages/griffelib/tests/test_api.py:188
Function
test_isolated_dash_lines_do_not_create_sections
An isolated dash-line (`---`) should not be parsed as a section. Parameters: parse_numpy: Fixture parser.
packages/griffelib/tests/test_docstrings/test_numpy.py:168
Function
test_json_schema
Assert that our serialized data matches our JSON schema.
packages/griffelib/tests/test_encoders.py:170
Function
test_json_schema_for_pep695_generics
Assert that serialized PEP 695 generics with defaults match our JSON schema. Defaults are only possible from Python 3.13 onwards.
packages/griffelib/tests/test_encoders.py:215
Function
test_json_schema_for_pep695_generics_without_defaults
Assert that serialized PEP 695 generics without defaults match our JSON schema. Defaults are only possible from Python 3.13 onwards.
packages/griffelib/tests/test_encoders.py:191
Function
test_kw_only_fields
Test that `kw_only` fields are included as keyword-only parameters in the `__init__` method.
packages/griffelib/tests/test_extensions/test_dataclasses.py:90
Function
test_kw_only_sentinel
Test that the `KW_ONLY` sentinel works.
packages/griffelib/tests/test_extensions/test_dataclasses.py:117
Function
test_length_one_tuple_as_string
Length-1 tuples must have a trailing comma.
packages/griffelib/tests/test_expressions.py:91
Function
test_load_builtin_modules
Assert builtin/compiled modules can be loaded.
packages/griffelib/tests/test_loader.py:358
Function
test_load_data_from_stubs
Check that the loader is able to load data from stubs / `*.pyi` files.
packages/griffelib/tests/test_loader.py:103
Function
test_load_events
Test load events triggering.
packages/griffelib/tests/test_extensions/test_base.py:297
Function
test_load_events_without_type_aliases
Test load events triggering.
packages/griffelib/tests/test_extensions/test_base.py:262
Function
test_load_from_both_py_and_pyi_files
Check that the loader is able to merge data loaded from `*.py` and `*.pyi` files.
packages/griffelib/tests/test_loader.py:146
Function
test_load_git
Test that we can load modules from different commits from a git repo. Parameters: git_repo: temporary git repo
packages/griffelib/tests/test_git.py:72
Function
test_load_git_errors
Test that we get informative errors for various invalid inputs. Parameters: git_repo: temporary git repo
packages/griffelib/tests/test_git.py:86
Function
test_load_package_from_both_py_and_pyi_files
Check that the loader is able to merge a package loaded from `*.py` and `*.pyi` files. This is a special case of the previous test: where the pac
packages/griffelib/tests/test_loader.py:228
Function
test_load_single_module_from_both_py_and_pyi_files
Check that the loader is able to merge a single-module package loaded from `*.py` and `*.pyi` files. This is a special case of the previous test:
packages/griffelib/tests/test_loader.py:243
Function
test_loading_extensions
Test the extensions loading mechanisms. Parameters: extension: Extension specification (parametrized).
packages/griffelib/tests/test_extensions/test_base.py:133
Function
test_loading_inherited_members
Test basic class inheritance. Parameters: agent1: A parametrized agent to load a module. agent2: A parametrized agent to load a m
packages/griffelib/tests/test_inheritance.py:23
Function
test_loading_stubs_only_packages
Test loading and merging of stubs-only packages. Parameters: tmp_path: Pytest fixture. namespace: Whether the package and stubs a
packages/griffelib/tests/test_loader.py:380
Function
test_loading_utf8_with_bom_files
Check that the loader can handle UTF-8 files with BOM.
packages/griffelib/tests/test_loader.py:519
Function
test_main
Basic CLI test.
packages/griffecli/tests/test_cli.py:13
Function
test_merge_attribute_values
Assert that attribute values are merged correctly.
packages/griffelib/tests/test_merger.py:65
Function
test_merge_imports
Assert that imports are merged correctly.
packages/griffelib/tests/test_merger.py:40
Function
test_merge_overload_annotations
Assert that overload annotations are merged correctly.
packages/griffelib/tests/test_merger.py:78
Function
test_merge_stubs_on_wildcard_imported_objects
Assert that stubs can be merged on wildcard imported objects.
packages/griffelib/tests/test_merger.py:20
Function
test_meson_python_file_handling
Assert editable modules by `meson-python` are handled. Parameters: tmp_path: Pytest fixture.
packages/griffelib/tests/test_finder.py:215
Function
test_minimal_data_is_enough
Test serialization and de-serialization. This is an end-to-end test that asserts we can load back a serialized tree and infer as much dat
packages/griffelib/tests/test_encoders.py:25
Function
test_minimal_light_data_is_enough
Test serialization and de-serialization.
packages/griffelib/tests/test_encoders.py:74
Function
test_missing_dependency
Assert missing dependencies are handled during dynamic imports.
packages/griffelib/tests/test_inspector.py:104
Function
test_modernizing_idempotence
Modernize expressions that can't be modernized. Parameters: code: An expression (parametrized).
packages/griffelib/tests/test_expressions.py:153
Function
test_modernizing_specific_expressions
Modernize expressions correctly. Parameters: annotation: Original annotation (parametrized). modernized: Expected modernized anno
packages/griffelib/tests/test_expressions.py:111
Function
test_moving_members_in_parent_classes
Test that moving an object from a base class to a parent class doesn't trigger a breakage.
packages/griffelib/tests/test_diff.py:194
← previous
next →
901–1,000 of 1,229, ranked by callers