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

os.path.is*() may return False if path can't be accessed #59426

Closed
giampaolo opened this issue Jun 29, 2012 · 7 comments
Closed

os.path.is*() may return False if path can't be accessed #59426

giampaolo opened this issue Jun 29, 2012 · 7 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir

Comments

@giampaolo
Copy link
Contributor

BPO 15221
Nosy @birkenfeld, @ncoghlan, @pitrou, @giampaolo, @tiran, @ezio-melotti, @cameron-simpson, @merwok, @Mariatta, @csabella
PRs
  • bpo-15221: Doc change to os.path.is*() methods to highlight os.path.exists() #5185
  • [3.6] bpo-15221: Update os.path.is*() documentation (GH-5185) #5186
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2018-01-15.05:46:30.085>
created_at = <Date 2012-06-29.00:19:48.231>
labels = ['3.7', 'docs']
title = "os.path.is*() may return False if path can't be accessed"
updated_at = <Date 2018-01-15.05:46:30.084>
user = 'https://github.com/giampaolo'

    bugs.python.org fields:

    activity = <Date 2018-01-15.05:46:30.084>
actor = 'Mariatta'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-01-15.05:46:30.085>
closer = 'Mariatta'
components = ['Documentation']
creation = <Date 2012-06-29.00:19:48.231>
creator = 'giampaolo.rodola'
dependencies = []
files = []
hgrepos = []
issue_num = 15221
keywords = ['patch']
message_count = 7.0
messages = ['164307', '164309', '164312', '309939', '309946', '309950', '309951']
nosy_count = 11.0
nosy_names = ['georg.brandl', 'ncoghlan', 'pitrou', 'giampaolo.rodola', 'christian.heimes', 'ezio.melotti', 'cameron', 'eric.araujo', 'docs@python', 'Mariatta', 'cheryl.sabella']
pr_nums = ['5185', '5186']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue15221'
versions = ['Python 3.7']
    @giampaolo
    Copy link
    Contributor Author

    It seems a doc fix is the best way to go, in which case I leave this one to a native English speaker:
    http://mail.python.org/pipermail/python-dev/2012-June/120788.html

    Alternatively a new 'strict' parameter has been proposed as a workaround:
    http://mail.python.org/pipermail/python-dev/2012-June/120800.html

    @giampaolo giampaolo added the docs Documentation in the Doc dir label Jun 29, 2012
    @pitrou
    Copy link
    Member

    pitrou commented Jun 29, 2012

    -1 on a "strict" parameter. This is a pointless obfuscation of the API.

    @ncoghlan
    Copy link
    Contributor

    The os.path.exists() docs already cover all the gory details of when it may be false due to limited permissions. The is* docs refer to this by their use of the word "existing", but that's probably too subtle.

    I suggest adding an extra sentence to the docs of all affected functions:

    "This always returns False if os.path.exists(path) returns False."

    @csabella
    Copy link
    Contributor

    I created a PR for this by making the word 'existing' a link to 'os.path.exists' since Nick mentioned that that word already implied the definition.

    @csabella csabella added the 3.7 (EOL) end of life label Jan 14, 2018
    @Mariatta
    Copy link
    Member

    New changeset b3dd18d by Mariatta (Cheryl Sabella) in branch 'master':
    bpo-15221: Update os.path.is*() documentation (GH-5185)
    b3dd18d

    @Mariatta
    Copy link
    Member

    New changeset bb80645 by Mariatta (Miss Islington (bot)) in branch '3.6':
    bpo-15221: Update os.path.is*() documentation (GH-5185) (GH-5186)
    bb80645

    @Mariatta
    Copy link
    Member

    Thanks!

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    5 participants
    @giampaolo @ncoghlan @pitrou @Mariatta @csabella