Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
sobolevn opened this issue Oct 6, 2022 · 2 comments
Closed

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

sobolevn opened this issue Oct 6, 2022 · 2 comments
Assignees
Labels
docs Documentation in the Doc dir

Comments

@sobolevn
Copy link
Member

sobolevn commented Oct 6, 2022

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 :)

@sobolevn sobolevn added the docs Documentation in the Doc dir label Oct 6, 2022
@sobolevn sobolevn self-assigned this Oct 6, 2022
sobolevn added a commit to sobolevn/cpython that referenced this issue Oct 6, 2022
@larryhastings
Copy link
Contributor

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.

carljm added a commit to carljm/cpython that referenced this issue Oct 8, 2022
* main: (38 commits)
  pythongh-92886: make test_ast pass with -O (assertions off) (pythonGH-98058)
  pythongh-92886: make test_coroutines pass with -O (assertions off) (pythonGH-98060)
  pythongh-57179: Add note on symlinks for os.walk (python#94799)
  pythongh-94808: Fix regex on exotic platforms (python#98036)
  pythongh-90085: Remove vestigial -t and -c timeit options (python#94941)
  pythonGH-83901: Improve Signature.bind error message for missing keyword-only params (python#95347)
  pythongh-61105: Add default param, note on using cookiejar subclass (python#95427)
  pythongh-96288: Add a sentence to `os.mkdir`'s docstring. (python#96271)
  pythongh-96073: fix backticks in NEWS entry (pythonGH-98056)
  pythongh-92886: [clinic.py] raise exception on invalid input instead of assertion (pythonGH-98051)
  pythongh-97997: Add col_offset field to tokenizer and use that for AST nodes (python#98000)
  pythonGH-88968: Reject socket that is already used as a transport (python#98010)
  pythongh-96346: Use double caching for re._compile() (python#96347)
  pythongh-91708: Revert params note in urllib.parse.urlparse table (python#96699)
  pythongh-96265: Fix some formatting in faq/design.rst (python#96924)
  pythongh-73196: Add namespace/scope clarification for inheritance section (python#92840)
  pythongh-97646: Change `.js` and `.mjs` files mimetype to conform to RFC 9239 (python#97934)
  pythongh-97923: Always run Ubuntu SSL tests with others in CI (python#97940)
  pythongh-97956: Mention `generate_global_objects.py` in `AC How-To` (python#97957)
  pythongh-96959: Update HTTP links which are redirected to HTTPS (python#98039)
  ...
@sobolevn
Copy link
Member Author

Done! ✅

erlend-aasland pushed a commit to erlend-aasland/devguide that referenced this issue Sep 8, 2023
AA-Turner pushed a commit to AA-Turner/devguide that referenced this issue Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

2 participants