Skip to content

The docstring for os.mkdir should mention the effect of umask #96288

Closed
@hagai-helman

Description

@hagai-helman
Contributor

Documentation

In os.mkdir, when the argument mode is used, the current umask value is first masked out of it. This behavior is mentioned in the library's documentation, but not in the docstring.

This behavior 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 will be mentioned in the docstring.

My edit suggestion is given in #96271.

Activity

added 2 commits that reference this issue on Oct 7, 2022

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

1523c9e

[3.11] pythongh-96288: Add a sentence to `os.mkdir`'s docstring. (pyt…

added 3 commits that reference this issue on Oct 7, 2022

[3.10] pythongh-96288: Add a sentence to `os.mkdir`'s docstring. (pyt…

[3.10] gh-96288: Add a sentence to `os.mkdir`'s docstring. (GH-96271). (

2090eeb

[3.11] gh-96288: Add a sentence to `os.mkdir`'s docstring. (GH-96271). (

1573211
added a commit that references this issue on Oct 8, 2022
added a commit that references this issue on Oct 11, 2022

pythongh-96288: Add a sentence to `os.mkdir`'s docstring. (python#96271)

hauntsaninja

hauntsaninja commented on Oct 11, 2022

@hauntsaninja
Contributor

Thanks, looks like this has been completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @hauntsaninja@hagai-helman

        Issue actions

          The docstring for `os.mkdir` should mention the effect of umask · Issue #96288 · python/cpython