Clean up warnings when running mkdocs #11482

Closed
opened 2025-12-29 21:45:52 +01:00 by adam · 2 comments
Owner

Originally created by @jeremystretch on GitHub (Aug 14, 2025).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

When building the documentation with mkdocs, two types of warnings are currently generated:

Deprecation warnings
INFO    -  DeprecationWarning: Importing from `mkdocstrings.handlers.base` is deprecated. Import from `mkdocstrings` directly.
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/handler.py", line 25, in <module>
               from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem, HandlerOptions
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/handlers/base.py", line 12, in __getattr__
               warnings.warn(
INFO    -  DeprecationWarning: Importing from `mkdocstrings.inventory` is deprecated. Import from `mkdocstrings` directly.
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/handler.py", line 26, in <module>
               from mkdocstrings.inventory import Inventory
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/inventory.py", line 12, in __getattr__
               warnings.warn(
INFO    -  DeprecationWarning: Importing from `mkdocstrings.loggers` is deprecated. Import from `mkdocstrings` directly.
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/handler.py", line 27, in <module>
               from mkdocstrings.loggers import get_logger
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/loggers.py", line 12, in __getattr__
               warnings.warn(
INFO    -  DeprecationWarning: Importing from `mkdocstrings.loggers` is deprecated. Import from `mkdocstrings` directly.
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/rendering.py", line 32, in <module>
               from mkdocstrings.loggers import get_logger
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/loggers.py", line 12, in __getattr__
               warnings.warn(
INFO    -  DeprecationWarning: Importing from `mkdocstrings.loggers` is deprecated. Import from `mkdocstrings` directly.
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/config.py", line 10, in <module>
               from mkdocstrings.loggers import get_logger
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/loggers.py", line 12, in __getattr__
               warnings.warn(
griffe warnings
WARNING -  griffe: netbox/netbox/jobs.py:51: No type or annotation for parameter 'job'
WARNING -  griffe: netbox/netbox/jobs.py:150: No type or annotation for parameter 'instance'
WARNING -  griffe: netbox/netbox/jobs.py:151: No type or annotation for parameter 'schedule_at'
WARNING -  griffe: netbox/netbox/jobs.py:152: No type or annotation for parameter 'interval'
WARNING -  griffe: netbox/extras/dashboard/widgets.py:145: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/utilities/forms/fields/fields.py:43: No type or annotation for parameter 'slug_source'
WARNING -  griffe: netbox/utilities/forms/rendering.py:24: No type or annotation for parameter 'items'
WARNING -  griffe: netbox/utilities/forms/rendering.py:25: No type or annotation for parameter 'name'
WARNING -  griffe: netbox/utilities/forms/rendering.py:37: No type or annotation for parameter 'fields'
WARNING -  griffe: netbox/utilities/forms/rendering.py:38: No type or annotation for parameter 'label'
WARNING -  griffe: netbox/utilities/forms/rendering.py:50: No type or annotation for parameter 'fieldsets'
WARNING -  griffe: netbox/utilities/forms/rendering.py:82: No type or annotation for parameter 'name'
WARNING -  griffe: netbox/netbox/models/features.py:74: No type or annotation for parameter 'exclude'
WARNING -  griffe: netbox/netbox/models/features.py:379: No type or annotation for parameter 'inherited'
WARNING -  griffe: netbox/netbox/models/features.py:215: No type or annotation for parameter 'omit_hidden'
WARNING -  griffe: netbox/netbox/search/__init__.py:97: No type or annotation for parameter 'instance'
WARNING -  griffe: netbox/netbox/search/__init__.py:98: No type or annotation for parameter 'custom_fields'
WARNING -  griffe: netbox/netbox/tables/columns.py:139: No type or annotation for parameter 'export_raw'
WARNING -  griffe: netbox/utilities/tables.py:67: No type or annotation for parameter 'column'
WARNING -  griffe: netbox/utilities/tables.py:68: No type or annotation for parameter 'name'
WARNING -  griffe: netbox/utilities/tables.py:69: No type or annotation for parameter 'tables'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:60: No type or annotation for parameter 'value'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:61: No type or annotation for parameter 'bg_color'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:62: No type or annotation for parameter 'show_empty'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:77: No type or annotation for parameter 'value'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:78: No type or annotation for parameter 'show_false'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:79: No type or annotation for parameter 'true'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:80: No type or annotation for parameter 'false'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:40: No type or annotation for parameter 'customfield'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:41: No type or annotation for parameter 'value'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:25: No type or annotation for parameter 'value'
WARNING -  griffe: netbox/utilities/templatetags/builtins/tags.py:26: No type or annotation for parameter 'viewname'
WARNING -  griffe: netbox/utilities/templatetags/builtins/filters.py:97: No type or annotation for parameter 'model'
WARNING -  griffe: netbox/utilities/templatetags/builtins/filters.py:98: No type or annotation for parameter 'attr'
WARNING -  griffe: netbox/utilities/templatetags/builtins/filters.py:120: No type or annotation for parameter 'value'
WARNING -  griffe: netbox/utilities/templatetags/builtins/filters.py:121: No type or annotation for parameter 'separator'
WARNING -  griffe: netbox/utilities/views.py:297: No type or annotation for parameter 'model'
WARNING -  griffe: netbox/utilities/views.py:298: No type or annotation for parameter 'name'
WARNING -  griffe: netbox/utilities/views.py:300: No type or annotation for parameter 'path'
WARNING -  griffe: netbox/utilities/views.py:301: No type or annotation for parameter 'detail'
WARNING -  griffe: netbox/utilities/views.py:302: No type or annotation for parameter 'kwargs'
WARNING -  griffe: netbox/utilities/urls.py:16: No type or annotation for parameter 'app_label'
WARNING -  griffe: netbox/utilities/urls.py:17: No type or annotation for parameter 'model_name'
WARNING -  griffe: netbox/utilities/urls.py:18: No type or annotation for parameter 'detail'
WARNING -  griffe: netbox/netbox/views/generic/base.py:32: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/base.py:55: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/base.py:56: No type or annotation for parameter 'instance'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:206: No type or annotation for parameter 'obj'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:207: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:208: No type or annotation for parameter 'url_args'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:209: No type or annotation for parameter 'url_kwargs'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:106: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:107: No type or annotation for parameter 'parent'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:118: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:119: No type or annotation for parameter 'queryset'
WARNING -  griffe: netbox/netbox/views/generic/object_views.py:120: No type or annotation for parameter 'parent'
WARNING -  griffe: netbox/netbox/views/generic/base.py:83: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/base.py:97: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/bulk_views.py:83: No type or annotation for parameter 'table'
WARNING -  griffe: netbox/netbox/views/generic/bulk_views.py:84: No type or annotation for parameter 'columns'
WARNING -  griffe: netbox/netbox/views/generic/bulk_views.py:85: No type or annotation for parameter 'filename'
WARNING -  griffe: netbox/netbox/views/generic/bulk_views.py:108: No type or annotation for parameter 'template'
WARNING -  griffe: netbox/netbox/views/generic/bulk_views.py:109: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/netbox/views/generic/bulk_views.py:400: No type or annotation for parameter 'object_form'
WARNING -  griffe: netbox/netbox/views/generic/bulk_views.py:401: No type or annotation for parameter 'request'
WARNING -  griffe: netbox/utilities/views.py:209: No type or annotation for parameter 'label'
WARNING -  griffe: netbox/utilities/views.py:210: No type or annotation for parameter 'visible'
WARNING -  griffe: netbox/utilities/views.py:213: No type or annotation for parameter 'badge'
WARNING -  griffe: netbox/utilities/views.py:215: No type or annotation for parameter 'weight'
WARNING -  griffe: netbox/utilities/views.py:216: No type or annotation for parameter 'permission'
WARNING -  griffe: netbox/utilities/views.py:217: No type or annotation for parameter 'hide_if_empty'

These warnings need to be investigated and either resolved or suppressed.

Justification

The deprecation warnings indicate that something may break in a future update. The griffe warnings are noisy and may cause confusion.

Originally created by @jeremystretch on GitHub (Aug 14, 2025). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes When building the documentation with `mkdocs`, two types of warnings are currently generated: <details> <summary>Deprecation warnings</summary> ``` INFO - DeprecationWarning: Importing from `mkdocstrings.handlers.base` is deprecated. Import from `mkdocstrings` directly. File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/handler.py", line 25, in <module> from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem, HandlerOptions File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/handlers/base.py", line 12, in __getattr__ warnings.warn( INFO - DeprecationWarning: Importing from `mkdocstrings.inventory` is deprecated. Import from `mkdocstrings` directly. File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/handler.py", line 26, in <module> from mkdocstrings.inventory import Inventory File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/inventory.py", line 12, in __getattr__ warnings.warn( INFO - DeprecationWarning: Importing from `mkdocstrings.loggers` is deprecated. Import from `mkdocstrings` directly. File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/handler.py", line 27, in <module> from mkdocstrings.loggers import get_logger File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/loggers.py", line 12, in __getattr__ warnings.warn( INFO - DeprecationWarning: Importing from `mkdocstrings.loggers` is deprecated. Import from `mkdocstrings` directly. File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/rendering.py", line 32, in <module> from mkdocstrings.loggers import get_logger File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/loggers.py", line 12, in __getattr__ warnings.warn( INFO - DeprecationWarning: Importing from `mkdocstrings.loggers` is deprecated. Import from `mkdocstrings` directly. File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings_handlers/python/config.py", line 10, in <module> from mkdocstrings.loggers import get_logger File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/mkdocstrings/loggers.py", line 12, in __getattr__ warnings.warn( ``` </details> <details> <summary>griffe warnings</summary> ``` WARNING - griffe: netbox/netbox/jobs.py:51: No type or annotation for parameter 'job' WARNING - griffe: netbox/netbox/jobs.py:150: No type or annotation for parameter 'instance' WARNING - griffe: netbox/netbox/jobs.py:151: No type or annotation for parameter 'schedule_at' WARNING - griffe: netbox/netbox/jobs.py:152: No type or annotation for parameter 'interval' WARNING - griffe: netbox/extras/dashboard/widgets.py:145: No type or annotation for parameter 'request' WARNING - griffe: netbox/utilities/forms/fields/fields.py:43: No type or annotation for parameter 'slug_source' WARNING - griffe: netbox/utilities/forms/rendering.py:24: No type or annotation for parameter 'items' WARNING - griffe: netbox/utilities/forms/rendering.py:25: No type or annotation for parameter 'name' WARNING - griffe: netbox/utilities/forms/rendering.py:37: No type or annotation for parameter 'fields' WARNING - griffe: netbox/utilities/forms/rendering.py:38: No type or annotation for parameter 'label' WARNING - griffe: netbox/utilities/forms/rendering.py:50: No type or annotation for parameter 'fieldsets' WARNING - griffe: netbox/utilities/forms/rendering.py:82: No type or annotation for parameter 'name' WARNING - griffe: netbox/netbox/models/features.py:74: No type or annotation for parameter 'exclude' WARNING - griffe: netbox/netbox/models/features.py:379: No type or annotation for parameter 'inherited' WARNING - griffe: netbox/netbox/models/features.py:215: No type or annotation for parameter 'omit_hidden' WARNING - griffe: netbox/netbox/search/__init__.py:97: No type or annotation for parameter 'instance' WARNING - griffe: netbox/netbox/search/__init__.py:98: No type or annotation for parameter 'custom_fields' WARNING - griffe: netbox/netbox/tables/columns.py:139: No type or annotation for parameter 'export_raw' WARNING - griffe: netbox/utilities/tables.py:67: No type or annotation for parameter 'column' WARNING - griffe: netbox/utilities/tables.py:68: No type or annotation for parameter 'name' WARNING - griffe: netbox/utilities/tables.py:69: No type or annotation for parameter 'tables' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:60: No type or annotation for parameter 'value' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:61: No type or annotation for parameter 'bg_color' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:62: No type or annotation for parameter 'show_empty' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:77: No type or annotation for parameter 'value' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:78: No type or annotation for parameter 'show_false' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:79: No type or annotation for parameter 'true' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:80: No type or annotation for parameter 'false' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:40: No type or annotation for parameter 'customfield' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:41: No type or annotation for parameter 'value' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:25: No type or annotation for parameter 'value' WARNING - griffe: netbox/utilities/templatetags/builtins/tags.py:26: No type or annotation for parameter 'viewname' WARNING - griffe: netbox/utilities/templatetags/builtins/filters.py:97: No type or annotation for parameter 'model' WARNING - griffe: netbox/utilities/templatetags/builtins/filters.py:98: No type or annotation for parameter 'attr' WARNING - griffe: netbox/utilities/templatetags/builtins/filters.py:120: No type or annotation for parameter 'value' WARNING - griffe: netbox/utilities/templatetags/builtins/filters.py:121: No type or annotation for parameter 'separator' WARNING - griffe: netbox/utilities/views.py:297: No type or annotation for parameter 'model' WARNING - griffe: netbox/utilities/views.py:298: No type or annotation for parameter 'name' WARNING - griffe: netbox/utilities/views.py:300: No type or annotation for parameter 'path' WARNING - griffe: netbox/utilities/views.py:301: No type or annotation for parameter 'detail' WARNING - griffe: netbox/utilities/views.py:302: No type or annotation for parameter 'kwargs' WARNING - griffe: netbox/utilities/urls.py:16: No type or annotation for parameter 'app_label' WARNING - griffe: netbox/utilities/urls.py:17: No type or annotation for parameter 'model_name' WARNING - griffe: netbox/utilities/urls.py:18: No type or annotation for parameter 'detail' WARNING - griffe: netbox/netbox/views/generic/base.py:32: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/base.py:55: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/base.py:56: No type or annotation for parameter 'instance' WARNING - griffe: netbox/netbox/views/generic/object_views.py:206: No type or annotation for parameter 'obj' WARNING - griffe: netbox/netbox/views/generic/object_views.py:207: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/object_views.py:208: No type or annotation for parameter 'url_args' WARNING - griffe: netbox/netbox/views/generic/object_views.py:209: No type or annotation for parameter 'url_kwargs' WARNING - griffe: netbox/netbox/views/generic/object_views.py:106: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/object_views.py:107: No type or annotation for parameter 'parent' WARNING - griffe: netbox/netbox/views/generic/object_views.py:118: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/object_views.py:119: No type or annotation for parameter 'queryset' WARNING - griffe: netbox/netbox/views/generic/object_views.py:120: No type or annotation for parameter 'parent' WARNING - griffe: netbox/netbox/views/generic/base.py:83: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/base.py:97: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/bulk_views.py:83: No type or annotation for parameter 'table' WARNING - griffe: netbox/netbox/views/generic/bulk_views.py:84: No type or annotation for parameter 'columns' WARNING - griffe: netbox/netbox/views/generic/bulk_views.py:85: No type or annotation for parameter 'filename' WARNING - griffe: netbox/netbox/views/generic/bulk_views.py:108: No type or annotation for parameter 'template' WARNING - griffe: netbox/netbox/views/generic/bulk_views.py:109: No type or annotation for parameter 'request' WARNING - griffe: netbox/netbox/views/generic/bulk_views.py:400: No type or annotation for parameter 'object_form' WARNING - griffe: netbox/netbox/views/generic/bulk_views.py:401: No type or annotation for parameter 'request' WARNING - griffe: netbox/utilities/views.py:209: No type or annotation for parameter 'label' WARNING - griffe: netbox/utilities/views.py:210: No type or annotation for parameter 'visible' WARNING - griffe: netbox/utilities/views.py:213: No type or annotation for parameter 'badge' WARNING - griffe: netbox/utilities/views.py:215: No type or annotation for parameter 'weight' WARNING - griffe: netbox/utilities/views.py:216: No type or annotation for parameter 'permission' WARNING - griffe: netbox/utilities/views.py:217: No type or annotation for parameter 'hide_if_empty' ``` </details> These warnings need to be investigated and either resolved or suppressed. ### Justification The deprecation warnings indicate that something may break in a future update. The griffe warnings are noisy and may cause confusion.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 21:45:52 +01:00
adam closed this issue 2025-12-29 21:45:52 +01:00
Author
Owner

@pawamoy commented on GitHub (Aug 14, 2025):

Most of the deprecation warnings will disappear once you upgrade your mkdocstrings and mkdocstrings-python dependencies 🙂

@pawamoy commented on GitHub (Aug 14, 2025): Most of the deprecation warnings will disappear once you upgrade your mkdocstrings and mkdocstrings-python dependencies 🙂
Author
Owner

@pawamoy commented on GitHub (Aug 14, 2025):

You can now also hide the "no type or annotation" Griffe warnings with the warn_missing_types: false option in mkdocs.yml (see https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_options). But it would be better for docs purposes to actually add either type annotation in signatures, or provide the type in the docstring, within parentheses. See https://mkdocstrings.github.io/griffe/reference/docstrings/#google-section-parameters.

@pawamoy commented on GitHub (Aug 14, 2025): You can now also hide the "no type or annotation" Griffe warnings with the `warn_missing_types: false` option in mkdocs.yml (see https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_options). But it would be better for docs purposes to actually add either type annotation in signatures, or provide the type in the docstring, within parentheses. See https://mkdocstrings.github.io/griffe/reference/docstrings/#google-section-parameters.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#11482