Within the documentation, there are some really important security considerations for standard library modules. e.g. subprocess, ssl, pickle, xml.

There is currently no "index" of these, so you have to go hunting for them. They're easter eggs within the docs. There isn't a unique admonition type either, so you have to search across many criteria.

In particular for security researchers, it would be useful to consolidate and signpost these security best-practices in one index.

PR to follow,

Asked on gh:

> this is a "security guidance for standard library modules" index?

(I'm not sure to understand the question exactly)

I think it could be usefull from a reviewer point of view to have such index so he can iterate over it and check point by point if the code is OK.

In this case, linking to all notes like "beware, wrong usage of this could lead to security issues" looks what's needed in this index.

Anthony: did you opened the issue with this in mind or any other usages?

I agree that a helpful entry in the index would be a nice addition. Christian would be the person to start with since he probably has ideas what would be useful too.

I think that we could make this easier with a custom directive that’s rendered into the appropriate markup during build and auto-generates the index page with links to all links.  No error-prone manual update needed!

+1

There are more features that should have security considerations, e.g. builtin functions like eval and exec.

New changeset c5c5326d4799fe4ae566aff32ed3461af95859cc by Anthony Shaw in branch 'main':
bpo-39498 Start linking the security warnings in the stdlib modules (GH-18272)
https://github.com/python/cpython/commit/c5c5326d4799fe4ae566aff32ed3461af95859cc

New changeset d657da8155cc9611b901ea052f3eac28f99122b4 by Miss Islington (bot) in branch '3.10':
bpo-39498 Start linking the security warnings in the stdlib modules (GH-18272)
https://github.com/python/cpython/commit/d657da8155cc9611b901ea052f3eac28f99122b4

New changeset fcbe8c63d78b5dd59470b5808d898b87d8ba0350 by Miss Islington (bot) in branch '3.9':
bpo-39498 Start linking the security warnings in the stdlib modules (GH-18272) (GH-27699)
https://github.com/python/cpython/commit/fcbe8c63d78b5dd59470b5808d898b87d8ba0350