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.

Sign up for GitHub

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

Jump to bottom

gh-96288: Add a sentence to os.mkdir's docstring. #96271

Merged
merged 6 commits into from
Oct 7, 2022
Merged

gh-96288: Add a sentence to os.mkdir's docstring. #96271

merged 6 commits into from
Oct 7, 2022

Conversation

hagai-helman
Copy link
Contributor

@hagai-helman hagai-helman commented Aug 25, 2022 •
edited by bedevere-bot
Loading

A clarification about the use of umask (copied from the os module documentation) is added to the docstring of os.mkdir.

The behavior described may be unexpected for some (for example, this is not the behavior of GNU's mkdir command - when a mode is explicitly given to it, it overrides the umask). When one is unaware of this behavior, it can lead to bugs that are difficult to notice or trace. For these two reasons, I suggest it is mentioned in the docstring.

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@cpython-cla-bot
Copy link

cpython-cla-bot bot commented Aug 25, 2022 •
edited
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

mdboom
mdboom requested changes Aug 25, 2022
View reviewed changes
Copy link
Contributor

@mdboom mdboom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is editing the docstring in generated output.

Modules/clinic/posixmodule.c.h Show resolved Hide resolved
@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@hagai-helman hagai-helman mentioned this pull request Aug 25, 2022
Closed
@hagai-helman hagai-helman changed the title Add a sentence to os.mkdir's docstring. gh-96288: Add a sentence to os.mkdir's docstring. Aug 25, 2022
@JelleZijlstra
Copy link
Member

The change looks good (sorry for the wait!) but there's a merge conflict in the AC output. Could you merge main in and re-generate the AC output file?

@JelleZijlstra JelleZijlstra self-assigned this Oct 7, 2022
@JelleZijlstra JelleZijlstra added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 7, 2022
@JelleZijlstra JelleZijlstra merged commit 1523c9e into python:main Oct 7, 2022
@miss-islington
Copy link
Contributor

Thanks @hagai-helman for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @hagai-helman and @JelleZijlstra, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 1523c9e9d47e7d67e4889987ff0f38eb7b881fdd 3.11

@miss-islington
Copy link
Contributor

Sorry @hagai-helman and @JelleZijlstra, I had trouble checking out the 3.10 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 1523c9e9d47e7d67e4889987ff0f38eb7b881fdd 3.10

JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this pull request Oct 7, 2022
@hagai-helman @JelleZijlstra
[3.11] pythongh-96288: Add a sentence to os.mkdir's docstring. (pyt…
47141fe 
…honGH-96271).

(cherry picked from commit 1523c9e)

Co-authored-by: Hagai Helman Tov <hagai.helman@gmail.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 7, 2022
@bedevere-bot
Copy link

GH-98065 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 7, 2022
@bedevere-bot
Copy link

GH-98066 is a backport of this pull request to the 3.10 branch.

JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this pull request Oct 7, 2022
@hagai-helman @JelleZijlstra
[3.10] pythongh-96288: Add a sentence to os.mkdir's docstring. (pyt…
4c29f0f 
…honGH-96271).

(cherry picked from commit 1523c9e)

Co-authored-by: Hagai Helman Tov <hagai.helman@gmail.com>
JelleZijlstra added a commit that referenced this pull request Oct 8, 2022
@JelleZijlstra @hagai-helman
[3.10] gh-96288: Add a sentence to os.mkdir's docstring. (GH-96271). (
2090eeb 
#98066)

(cherry picked from commit 1523c9e)

Co-authored-by: Hagai Helman Tov <hagai.helman@gmail.com>
JelleZijlstra added a commit that referenced this pull request Oct 8, 2022
@JelleZijlstra @hagai-helman
[3.11] gh-96288: Add a sentence to os.mkdir's docstring. (GH-96271). (
1573211 
#98065)

(cherry picked from commit 1523c9e)

Co-authored-by: Hagai Helman Tov <hagai.helman@gmail.com>
carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
27a4980 
* 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)
  ...
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@hagai-helman @mpage
pythongh-96288: Add a sentence to os.mkdir's docstring. (python#96271)
b9bd94d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdboom mdboom mdboom requested changes

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

Assignees

@JelleZijlstra JelleZijlstra

Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@hagai-helman @bedevere-bot @JelleZijlstra @miss-islington @mdboom @AlexWaygood