Skip to content

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

Closed
@hagai-helman

Description

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

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

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

    Issue actions