"Argument Clinic How-To" misses generate_global_objects step

@larryhastings

Documentation

Right now our How-To Clinic guide does not mention that it is required to run python Tools/scripts/generate_global_objects.py command to generate global objects used by _Py_ID(), like in here:

    #define NUM_KEYWORDS 1
    static struct {
        PyGC_Head _this_is_not_used;
        PyObject_VAR_HEAD
        PyObject *ob_item[NUM_KEYWORDS];
    } _kwtuple = {
        .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
        .ob_item = { &_Py_ID(only_keys), },   // <--- Here!
    };
    #undef NUM_KEYWORDS

With this command the build fails.
I will send a PR to update docs today.

CC @larryhastings :)

pythongh-97956: Mention `generate_global_objects.py` in `AC How-To`

generate_global_objects.py is new, Argument Clinic is many years older. It sounds like the generate_global_objects.py authors should have added this documentation when they added this new feature.

gh-97956: Mention `generate_global_objects.py` in `AC How-To` (#97957)

Merge branch 'main' into typewatch

pythongh-97956: Mention `generate_global_objects.py` in `AC How-To` (p…

Done! ✅

python/cpython#97956: Mention `generate_global_objects.py` in `AC How…

Navigation Menu

Repository navigation

"Argument Clinic How-To" misses `generate_global_objects` step #97956

Documentation

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

"Argument Clinic How-To" misses generate_global_objects step #97956

Description

Documentation

Activity

larryhastings commented on Oct 6, 2022

sobolevn commented on Oct 12, 2022

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

"Argument Clinic How-To" misses `generate_global_objects` step #97956