base ¤
Base module for handlers.
This module contains the base classes for implementing handlers.
Classes:
-
BaseHandler
–The base handler class.
-
CollectionError
–An exception raised when some collection of data failed.
-
Handlers
–A collection of handlers.
-
ThemeNotSupported
–An exception raised to tell a theme is not supported.
Functions:
-
do_any
–Check if at least one of the item in the sequence evaluates to true.
BaseHandler ¤
The base handler class.
Inherit from this class to implement a handler.
You will have to implement the collect
and render
methods. You can also implement the teardown
method, and override the update_env
method, to add more filters to the Jinja environment, making them available in your Jinja templates.
To define a fallback theme, add a fallback_theme
class-variable. To add custom CSS, add an extra_css
variable or create an 'style.css' file beside the templates.
If the given theme is not supported (it does not exist), it will look for a fallback_theme
attribute in self
to use as a fallback theme.
Parameters:
-
handler
(str
) –The name of the handler.
-
theme
(str
) –The name of theme to use.
-
custom_templates
(str | None
, default:None
) –Directory containing custom templates.
Methods:
-
collect
–Collect data given an identifier and user configuration.
-
do_convert_markdown
–Render Markdown text; for use inside templates.
-
do_heading
–Render an HTML heading and register it for the table of contents. For use inside templates.
-
get_anchors
–Return the possible identifiers (HTML anchors) for a collected item.
-
get_extended_templates_dirs
–Load template extensions for the given handler, return their templates directories.
-
get_headings
–Return and clear the headings gathered so far.
-
get_templates_dir
–Return the path to the handler's templates directory.
-
load_inventory
–Yield items and their URLs from an inventory file streamed from
in_file
. -
render
–Render a template using provided data and configuration options.
-
teardown
–Teardown the handler.
-
update_env
–Update the Jinja environment.
Attributes:
-
domain
(str
) –The handler's domain, used to register objects in the inventory, for example "py".
-
enable_inventory
(bool
) –Whether the inventory creation is enabled.
-
extra_css
–Extra CSS.
-
fallback_config
(dict
) –Fallback configuration when searching anchors for identifiers.
-
fallback_theme
(str
) –Fallback theme to use when a template isn't found in the configured theme.
-
name
(str
) –The handler's name, for example "python".
Source code in src/mkdocstrings/handlers/base.py
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
|
domain class-attribute
instance-attribute
¤
domain: str = 'default'
The handler's domain, used to register objects in the inventory, for example "py".
enable_inventory class-attribute
instance-attribute
¤
enable_inventory: bool = False
Whether the inventory creation is enabled.
fallback_config class-attribute
¤
fallback_config: dict = {}
Fallback configuration when searching anchors for identifiers.
fallback_theme class-attribute
instance-attribute
¤
fallback_theme: str = ''
Fallback theme to use when a template isn't found in the configured theme.
collect ¤
collect(
identifier: str, config: MutableMapping[str, Any]
) -> CollectorItem
Collect data given an identifier and user configuration.
In the implementation, you typically call a subprocess that returns JSON, and load that JSON again into a Python dictionary for example, though the implementation is completely free.
Parameters:
-
identifier
(str
) –An identifier for which to collect data. For example, in Python, it would be 'mkdocstrings.handlers' to collect documentation about the handlers module. It can be anything that you can feed to the tool of your choice.
-
config
(MutableMapping[str, Any]
) –The handler's configuration options.
Returns:
-
CollectorItem
–Anything you want, as long as you can feed it to the handler's
render
method.
Source code in src/mkdocstrings/handlers/base.py
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
|
do_convert_markdown ¤
do_convert_markdown(
text: str,
heading_level: int,
html_id: str = "",
*,
strip_paragraph: bool = False
) -> Markup
Render Markdown text; for use inside templates.
Parameters:
-
text
(str
) –The text to convert.
-
heading_level
(int
) –The base heading level to start all Markdown headings from.
-
html_id
(str
, default:''
) –The HTML id of the element that's considered the parent of this element.
-
strip_paragraph
(bool
, default:False
) –Whether to exclude the
tag from around the whole output.
Returns:
-
Markup
–An HTML string.
Source code in src/mkdocstrings/handlers/base.py
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
|
do_heading ¤
do_heading(
content: Markup,
heading_level: int,
*,
role: str | None = None,
hidden: bool = False,
toc_label: str | None = None,
**attributes: str
) -> Markup
Render an HTML heading and register it for the table of contents. For use inside templates.
Parameters:
-
content
(Markup
) –The HTML within the heading.
-
heading_level
(int
) –The level of heading (e.g. 3 ->
h3
). -
role
(str | None
, default:None
) –An optional role for the object bound to this heading.
-
hidden
(bool
, default:False
) –If True, only register it for the table of contents, don't render anything.
-
toc_label
(str | None
, default:None
) –The title to use in the table of contents ('data-toc-label' attribute).
-
**attributes
(str
, default:{}
) –Any extra HTML attributes of the heading.
Returns:
-
Markup
–An HTML string.
Source code in src/mkdocstrings/handlers/base.py
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
|
get_anchors ¤
Return the possible identifiers (HTML anchors) for a collected item.
Parameters:
-
data
(CollectorItem
) –The collected data.
Returns:
-
tuple[str, ...]
–The HTML anchors (without '#'), or an empty tuple if this item doesn't have an anchor.
Source code in src/mkdocstrings/handlers/base.py
236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
|
get_extended_templates_dirs ¤
Load template extensions for the given handler, return their templates directories.
Parameters:
-
handler
(str
) –The name of the handler to get the extended templates directory of.
Returns:
Source code in src/mkdocstrings/handlers/base.py
224 225 226 227 228 229 230 231 232 233 234 |
|
get_headings ¤
Return and clear the headings gathered so far.
Returns:
Source code in src/mkdocstrings/handlers/base.py
338 339 340 341 342 343 344 345 346 |
|
get_templates_dir ¤
Return the path to the handler's templates directory.
Override to customize how the templates directory is found.
Parameters:
-
handler
(str | None
, default:None
) –The name of the handler to get the templates directory of.
Raises:
-
ModuleNotFoundError
–When no such handler is installed.
-
FileNotFoundError
–When the templates directory cannot be found.
Returns:
-
Path
–The templates directory path.
Source code in src/mkdocstrings/handlers/base.py
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
|
load_inventory classmethod
¤
load_inventory(
in_file: BinaryIO,
url: str,
base_url: str | None = None,
**kwargs: Any
) -> Iterator[tuple[str, str]]
Yield items and their URLs from an inventory file streamed from in_file
.
Parameters:
-
in_file
(BinaryIO
) –The binary file-like object to read the inventory from.
-
url
(str
) –The URL that this file is being streamed from (used to guess
base_url
). -
base_url
(str | None
, default:None
) –The URL that this inventory's sub-paths are relative to.
-
**kwargs
(Any
, default:{}
) –Ignore additional arguments passed from the config.
Yields:
-
str
–Tuples of (item identifier, item URL).
Source code in src/mkdocstrings/handlers/base.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
|
render ¤
Render a template using provided data and configuration options.
Parameters:
-
data
(CollectorItem
) –The collected data to render.
-
config
(Mapping[str, Any]
) –The handler's configuration options.
Returns:
-
str
–The rendered template as HTML.
Source code in src/mkdocstrings/handlers/base.py
177 178 179 180 181 182 183 184 185 186 187 |
|
teardown ¤
teardown() -> None
Teardown the handler.
This method should be implemented to, for example, terminate a subprocess that was started when creating the handler instance.
Source code in src/mkdocstrings/handlers/base.py
189 190 191 192 193 194 |
|
update_env ¤
update_env(md: Markdown, config: dict) -> None
Update the Jinja environment.
Parameters:
-
md
(Markdown
) –The Markdown instance. Useful to add functions able to convert Markdown into the environment filters.
-
config
(dict
) –Configuration options for
mkdocs
andmkdocstrings
, read frommkdocs.yml
. See the source code of mkdocstrings.plugin.MkdocstringsPlugin.on_config to see what's in this dictionary.
Source code in src/mkdocstrings/handlers/base.py
348 349 350 351 352 353 354 355 356 357 358 359 |
|
Handlers ¤
Handlers(config: dict)
A collection of handlers.
Do not instantiate this directly. The plugin will keep one instance of this for the purpose of caching. Use mkdocstrings.plugin.MkdocstringsPlugin.get_handler for convenient access.
Parameters:
-
config
(dict
) –Configuration options for
mkdocs
andmkdocstrings
, read frommkdocs.yml
. See the source code of mkdocstrings.plugin.MkdocstringsPlugin.on_config to see what's in this dictionary.
Methods:
-
get_anchors
–Return the canonical HTML anchor for the identifier, if any of the seen handlers can collect it.
-
get_handler
–Get a handler thanks to its name.
-
get_handler_config
–Return the global configuration of the given handler.
-
get_handler_name
–Return the handler name defined in an "autodoc" instruction YAML configuration, or the global default handler.
-
teardown
–Teardown all cached handlers and clear the cache.
Attributes:
-
seen_handlers
(Iterable[BaseHandler]
) –Get the handlers that were encountered so far throughout the build.
Source code in src/mkdocstrings/handlers/base.py
380 381 382 383 384 385 386 387 388 389 |
|
seen_handlers property
¤
seen_handlers: Iterable[BaseHandler]
Get the handlers that were encountered so far throughout the build.
Returns:
-
Iterable[BaseHandler]
–An iterable of instances of
BaseHandler
-
Iterable[BaseHandler]
–(usable only to loop through it).
get_anchors ¤
Return the canonical HTML anchor for the identifier, if any of the seen handlers can collect it.
Parameters:
Returns:
-
tuple[str, ...] | set[str]
–A tuple of strings - anchors without '#', or an empty tuple if there isn't any identifier familiar with it.
Source code in src/mkdocstrings/handlers/base.py
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
|
get_handler ¤
get_handler(
name: str, handler_config: dict | None = None
) -> BaseHandler
Get a handler thanks to its name.
This function dynamically imports a module named "mkdocstrings.handlers.NAME", calls its get_handler
method to get an instance of a handler, and caches it in dictionary. It means that during one run (for each reload when serving, or once when building), a handler is instantiated only once, and reused for each "autodoc" instruction asking for it.
Parameters:
-
name
(str
) –The name of the handler. Really, it's the name of the Python module holding it.
-
handler_config
(dict | None
, default:None
) –Configuration passed to the handler.
Returns:
-
BaseHandler
–An instance of a subclass of
BaseHandler
, as instantiated by theget_handler
method of the handler's module.
Source code in src/mkdocstrings/handlers/base.py
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 |
|
get_handler_config ¤
Return the global configuration of the given handler.
Parameters:
-
name
(str
) –The name of the handler to get the global configuration of.
Returns:
-
dict
–The global configuration of the given handler. It can be an empty dictionary.
Source code in src/mkdocstrings/handlers/base.py
424 425 426 427 428 429 430 431 432 433 434 435 436 |
|
get_handler_name ¤
Return the handler name defined in an "autodoc" instruction YAML configuration, or the global default handler.
Parameters:
-
config
(dict
) –A configuration dictionary, obtained from YAML below the "autodoc" instruction.
Returns:
-
str
–The name of the handler to use.
Source code in src/mkdocstrings/handlers/base.py
410 411 412 413 414 415 416 417 418 419 420 421 422 |
|
teardown ¤
teardown() -> None
Teardown all cached handlers and clear the cache.
Source code in src/mkdocstrings/handlers/base.py
477 478 479 480 481 |
|
do_any ¤
Check if at least one of the item in the sequence evaluates to true.
The any
builtin as a filter for Jinja templates.
Parameters:
-
seq
(Sequence
) –An iterable object.
-
attribute
(str | None
, default:None
) –The attribute name to use on each object of the iterable.
Returns:
-
bool
–A boolean telling if any object of the iterable evaluated to True.
Source code in src/mkdocstrings/handlers/base.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
|