bpo-36876: Add a tool that identifies unsupported global C variables.#15877

ericsnowcurrently

This PR does 2 things:

make the globals checker tool more robust and maintainable
add a test that invokes the checker and fails if any unsupported globals have been added

For now the test is marked as a known failure. I'll be working to fix all of unsupported globals, at which point I'll unmark the test.

Note that this PR adds code to Tools/c-analyzer or adds new tests. The only existing code I touch is where I factor out an existing testing helper from tests for another tool.

https://bugs.python.org/issue36876

vstinner

115 commits, 51 files changes, and wow, that's a huge PR.

vstinner

" bpo-36876: Make sure no new globals get added."

So far, the C API don't provide any solution for function "static PyObject *local_global_var = ...;" :-)

ericsnowcurrently

Yeah, it's a lot, but it's all under Tools/. :) Also, I've updated the title to be more clear.

ericsnowcurrently

FYI, all the failures are strictly with patchcheck, which is complaining about whitespace in some files. I cannot reproduce that locally.

bedevere-bot

@ericsnowcurrently: Please replace # with GH- in the commit message next time. Thanks!

the-knights-who-say-ni added the CLA signed label Sep 10, 2019

bedevere-bot added the awaiting core review label Sep 10, 2019

ericsnowcurrently added the skip news label Sep 10, 2019

ericsnowcurrently force-pushed the globals-checker branch from 23e9d06 to de1f50f Compare September 11, 2019 11:06

ericsnowcurrently changed the title bpo-36876: Make sure no new globals get added. bpo-36876: Add a tool that identifies unsupported global C variables. Sep 11, 2019

ericsnowcurrently force-pushed the globals-checker branch from de1f50f to 569c57e Compare September 11, 2019 12:19

ericsnowcurrently merged commit ee536b2 into python:master Sep 11, 2019

ericsnowcurrently deleted the globals-checker branch September 11, 2019 18:49

bedevere-bot removed the awaiting core review label Sep 11, 2019

ericsnowcurrently added 16 commits September 11, 2019 22:12

Bootstrap the "c-statics" script under the test suite.

9cdba01

Stub out the "check" and "show" commands.

cfdf57f

Add a README.

716b13d

Fix a filename.

ff1b447

Run the full check as part of the test suite.

7e7d52d

Frame out the functional tests.

74d03d4

Ignore the argparse output in tests.

34d2c7c

Move relevant tests to test_cg/.

e8e2227

Add StaticVar.

69541bf

Add a fake find.statics().

cab1fc8

Add show.basic().

4bf5299

Implement cmd_show().

c74360f

Add a note about the normalized vartype format.

b94833d

Do not run tests for find.statics() yet.

6fecaad

Implement cmd_check().

8a53e69

Add scan.iter_statics().

98d3737

ericsnowcurrently added 27 commits September 11, 2019 22:13

Distinguish "static" vars in output.

48b2460

Special-case variables named "id".

c0a631b

Fix a test.

3989a69

Print totals.

8118454

Fail if we couldn't find any of the symbols.

cae5e3a

Factor out _check_results().

87ebe87

Fill in gaps in known.tsv.

91e4fb1

Mark _Py_IDENTIFIER() as unsupported.

21c4175

Keep "static" in output.

a245849

Fix a typo in __main__.py.

1437d56

Honor provided dirnames.

7feea9d

Fix tests.

ae23801

Deal with default dirnames properly.

26aaccb

Supporting hiding objects in output.

4aaad5f

Recognize more object types.

3d36cfc

Ignore known non-statics.

b7420d5

Always support "static const" (non-object) variables.

da151a7

"statics" -> "globals".

6470eb1

Maybe limit the variables in known.tsv.

1233cf9

Generate the ignored.tsv file.

fc6c97e

Ignore variables with benign races.

6f8a223

Mark more variables as PyObject.

6c1db44

Consider private, non-static globals.

5888d48

Update ignored global variables.

cdeb1d9

Skip the check where "nm" isn't available.

569c57e

Ignore REPL-related variables.

7b0745f

Fix whitespace.

b5dd31b

DinoV pushed a commit to DinoV/cpython that referenced this pull request Sep 12, 2019

bpo-36876: Add a tool that identifies unsupported global C variables. (… …

7654be1

…python#15877)

ericsnowcurrently mentioned this pull request Apr 10, 2022

[subinterpreters] Global C variables are a problem #81057

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

bpo-36876: Add a tool that identifies unsupported global C variables.#15877