[DOC] Snippet code to str methods #24666

adorilson · 2021-02-28T00:34:12Z

This PR improvements the str method documentation, adding snippet code in the follows methods and other minor improvements:

capitalize
casefold
center
count
encode
endswith
expandtabs
find
index
isalnum
isalpha
isascii
isdecimal
isdigit
isidentifier
islower
isnumeric
isprintable
isspace
istitle
join
ljust
lower
lstrip
maketrans
partition
replace
rindex
rjust
rpartition
rsplit
rstrip
startswith
swapcase
translate
upper

Move faulthandler._fatal_error() to _testcapi.fatal_error().

* Replace buffered fprintf() with unbuffered _Py_write_noraise() in Py_FatalError(). * _Py_DumpHexadecimal() now accepts uintptr_t.

The Py_FatalError() function and the faulthandler module now dump the list of extension modules on a fatal error. Add _Py_DumpExtensionModules() and _PyModule_IsExtension() internal functions.

…ctypes param reprs. (24239)

…24252)

When stdin is a TTY, the test added in commit c13d899 is expected to fail. However, when it failed, it did not close its file descriptors. This is flagged by the refleak tests (but only when stdin is a TTY, which doesn't seem to be the case on CI).

…r validity (pythonGH-24253)

…4257)

Add a private list of all stdlib modules: _Py_module_names. * Add Tools/scripts/generate_module_names.py script. * Makefile: Add "make regen-module-names" command. * setup.py: Add --list-module-names option. * GitHub Action and Travis CI also runs "make regen-module-names", not ony "make regen-all", to ensure that the module names remains up to date.

)

…honGH-24161)

…ythonGH-22635)

)

…onGH-23978)

…tack for column numbers (pythonGH-24266)

* addCleanupClass -> addClassCleanup * doCleanupsClass -> doClassCleanups

…pythonGH-24172)

…4210) Add --with-wheel-pkg-dir=PATH option to the ./configure script. If specified, the ensurepip module looks for setuptools and pip wheel packages in this directory: if both are present, these wheel packages are used instead of ensurepip bundled wheel packages. Some Linux distribution packaging policies recommend against bundling dependencies. For example, Fedora installs wheel packages in the /usr/share/python-wheels/ directory and don't install the ensurepip._bundled package. ensurepip: Remove unused runpy import.

pythonGH-24273) Automerge-Triggered-By: GH:pablogsal

…nGH-19346) Automerge-Triggered-By: GH:isidentical

@vstinner

@vstinner [noticed on python-dev](https://mail.python.org/archives/list/[email protected]/thread/O3T7SK3BGMFWMLCQXDODZJSBL42AUWTR/) that there is no what's new or porting entry for removal of asyncio ``loop`` parameter. This patch adds a basic guide. Co-Authored-By: Kyle Stanley <[email protected]>

bidst_wheel -> bdist_wheel Automerge-Triggered-By: GH:Mariatta

This reverts commit 0064c92.

adorilson · 2021-05-13T17:02:11Z

The docs build failed, but I did not get the error. In my PC this build works properly.

MaxwellDupre · 2022-04-05T16:31:48Z

Docs wont build with your changes/setup. I can compile the Docs from the current main.
The error I get is:
omplex.rst:49:Error in declarator or parameters
Error in declarator or parameters
Invalid C declaration: Expected identifier, got user-defined keyword: complex. Remove it from c_extra_keywords to allow it as identifier.
Currently c_extra_keywords is ['alignas', 'alignof', 'bool', 'complex', 'imaginary', 'noreturn', 'static_assert', 'thread_local']. [error at 39]
Py_complex _Py_c_neg(Py_complex complex)
---------------------------------------^
make: *** [Makefile:51: build] Error 2

NB I see the first change in Doc/library/array.rst does not exist in current Python 3 docs. Hence you will need to see if this is still relevant.

ghost · 2022-10-11T13:09:47Z

The following commit authors need to sign the Contributor License Agreement:

Click the button to sign:

adorilson · 2022-10-11T14:05:50Z

Docs wont build with your changes/setup. I can compile the Docs from the current main. The error I get is: omplex.rst:49:Error in declarator or parameters Error in declarator or parameters Invalid C declaration: Expected identifier, got user-defined keyword: complex. Remove it from c_extra_keywords to allow it as identifier. Currently c_extra_keywords is ['alignas', 'alignof', 'bool', 'complex', 'imaginary', 'noreturn', 'static_assert', 'thread_local']. [error at 39] Py_complex _Py_c_neg(Py_complex complex) ---------------------------------------^ make: *** [Makefile:51: build] Error 2

I just building in my PC and this works perfectly. I have synchronized with upstream before.

NB I see the first change in Doc/library/array.rst does not exist in current Python 3 docs. Hence you will need to see if this is still relevant.

I doesn't touched in this file. Only Doc/library/stdtypes.rst.

slateny · 2022-10-12T23:01:51Z

Can you rebase the branch / cherry-pick the commits so it doesn't grab all the 1k+ commits from main? I'm also not too sure about adding so many examples as it would make the page a bit bloated, but I'll let someone else comment on them.

adorilson · 2023-06-11T20:55:36Z

I have made the requested changes; please review again

bedevere-bot · 2023-06-11T20:55:40Z

Thanks for making the requested changes!

: please review the changes made to this pull request.

adorilson · 2023-06-11T20:56:08Z

In fact, the change was in a new branch/PR #105670

AlexWaygood · 2023-06-11T21:03:59Z

closing in favour of #105670

the-knights-who-say-ni added the CLA signed label Feb 28, 2021

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Feb 28, 2021

vstinner and others added 27 commits March 10, 2021 21:37

bpo-42923: Add Py_FatalError() test in test_capi (pythonGH-24240)

632d30e

Move faulthandler._fatal_error() to _testcapi.fatal_error().

bpo-42923: Py_FatalError() avoids fprintf() (pythonGH-24242)

f6c2d4c

* Replace buffered fprintf() with unbuffered _Py_write_noraise() in Py_FatalError(). * _Py_DumpHexadecimal() now accepts uintptr_t.

bpo-42944 Fix Random.sample when counts is not None (pythonGH-24235)

c284e07

bpo-42923: Dump extension modules on fatal error (pythonGH-24207)

16a980b

The Py_FatalError() function and the faulthandler module now dump the list of extension modules on a fatal error. Add _Py_DumpExtensionModules() and _PyModule_IsExtension() internal functions.

bpo-36143: make regen-all now also runs regen-keyword (pythonGH-24245)

f2819ef

closes bpo-42938: Replace snprintf with Python unicode formatting in …

509e63d

…ctypes param reprs. (24239)

Add a paragraph about allocation domains to the C-API docs (pythonGH-…

9fda44a

…24252)

Add a clarification for the object-domain allocators regarding pointe…

9105681

…r validity (pythonGH-24253)

bpo-41713: Remove PyOS_InitInterrupts() from python3dll.c (pythonGH-2…

e2fa37e

…4257)

bpo-42923: _Py_DumpExtensionModules() ignores stdlib ext (pythonGH-24254

39a8efe

)

bpo-42864: Improve error messages regarding unclosed parentheses (pyt…

f775cbf

…honGH-24161)

bpo-41995: Handle allocation failure in _tracemalloc and _zoneinfo (p…

8b3feec

…ythonGH-22635)

bpo-42005: profile and cProfile catch BrokenPipeError (pythonGH-22643)

cbefbd3

Doc: os.path.abspath and Path.resolve are also different (pythonGH-23276

9048e33

)

bpo-41798: Allocate unicodedata CAPI on the heap (pythonGH-24128)

32e99a8

bpo-42048: Clinic Howto: Document AC's defining_class converter (pyth…

b662ac1

…onGH-23978)

bpo-42864: Fix compiler warning in the tokenizer with the new paren s…

71d7a14

…tack for column numbers (pythonGH-24266)

Fix typos in unittest documentation (pythonGH-24194)

c4837f1

* addCleanupClass -> addClassCleanup * doCleanupsClass -> doClassCleanups

bpo-42780: Fix set_inheritable() for O_PATH file descriptors on Linux (…

750eb0f

…pythonGH-24172)

bpo-42323: Fix math.nextafter() for NaN on AIX (pythonGH-24265)

3e11523

bpo-42864: Simplify the tokenizer exceptions after generic SyntaxError (

9fc5b96

pythonGH-24273) Automerge-Triggered-By: GH:pablogsal

bpo-40176: Improve error messages for unclosed string literals (pytho…

08dcce9

…nGH-19346) Automerge-Triggered-By: GH:isidentical

Fix typo in what's new. bidst_wheel -> bdist_wheel (pythonGH-24234)

2d9df10

bidst_wheel -> bdist_wheel Automerge-Triggered-By: GH:Mariatta

the-knights-who-say-ni added the CLA signed label May 12, 2021

adorilson added 12 commits May 12, 2021 19:29

[Doc] Added snippet code to str.partition method

bad6e90

[Doc] Added snippet code to str.replace method

73f3a73

[Doc] Added snippet code to str.rfind method

78d118b

[Doc] Added snippet code to str.rindex method

8c1f058

[Doc] Added snippet code to str.rpartition method

fa84890

mend

0064c92

Revert "mend"

1888446

This reverts commit 0064c92.

[DOC] minor change

eebd56b

[Doc] Added snippet code to str.rsplit method

8ea5204

[Doc] Added snippet code to str.startswith method

b4a68da

[Doc] Added snippet code to str.swapcase method

992a7d7

[Doc] Added snippet code to str.upper method

58b11f1

ezio-melotti removed the CLA signed label Jul 13, 2022

github-actions bot removed the stale Stale PR or inactive for long period of time. label Aug 4, 2022

Merge branch 'main' into str_methods

a2c17ac

Merge branch 'python:main' into str_methods

180f61c

Merge branch 'python:main' into str_methods

7dc5c2b

bedevere-bot added awaiting change review and removed awaiting review labels Jun 11, 2023

AlexWaygood closed this Jun 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[DOC] Snippet code to str methods #24666

[DOC] Snippet code to str methods #24666

Uh oh!

adorilson commented Feb 28, 2021 •

edited

Loading

Uh oh!

adorilson commented May 13, 2021

Uh oh!

MaxwellDupre commented Apr 5, 2022

Uh oh!

ghost commented Oct 11, 2022 •

edited by ghost

Loading

Uh oh!

adorilson commented Oct 11, 2022

Uh oh!

slateny commented Oct 12, 2022

Uh oh!

adorilson commented Jun 11, 2023

Uh oh!

bedevere-bot commented Jun 11, 2023

Uh oh!

adorilson commented Jun 11, 2023

Uh oh!

AlexWaygood commented Jun 11, 2023

Uh oh!

Uh oh!

Uh oh!

[DOC] Snippet code to str methods #24666

[DOC] Snippet code to str methods #24666

Uh oh!

Conversation

adorilson commented Feb 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adorilson commented May 13, 2021

Uh oh!

MaxwellDupre commented Apr 5, 2022

Uh oh!

ghost commented Oct 11, 2022 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adorilson commented Oct 11, 2022

Uh oh!

slateny commented Oct 12, 2022

Uh oh!

adorilson commented Jun 11, 2023

Uh oh!

bedevere-bot commented Jun 11, 2023

Uh oh!

adorilson commented Jun 11, 2023

Uh oh!

AlexWaygood commented Jun 11, 2023

Uh oh!

Uh oh!

adorilson commented Feb 28, 2021 •

edited

Loading

ghost commented Oct 11, 2022 •

edited by ghost

Loading