Skip to content

pathlib: Highlight pathlib operator behavior with anchored paths #87691

Closed
Closed
pathlib: Highlight pathlib operator behavior with anchored paths#87691
Labels
3.9 (EOL)end of lifedocsDocumentation in the Doc dirtopic-pathlib

Description

@diegoe
diegoe
mannequin
opened on Mar 17, 2021
BPO 43525
Nosy @diegoe
PRs
  • bpo-43525: Highlight pathlib operator behavior with anchored paths #24900
    		•

    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 = None
created_at = <Date 2021-03-17.04:04:55.025>
labels = ['3.9', 'docs']
title = 'pathlib: Highlight pathlib operator behavior with anchored paths'
updated_at = <Date 2021-03-17.04:24:30.717>
user = 'https://github.com/diegoe'

    bugs.python.org fields:

    activity = <Date 2021-03-17.04:24:30.717>
actor = 'diegoe'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-03-17.04:04:55.025>
creator = 'diegoe'
dependencies = []
files = []
hgrepos = []
issue_num = 43525
keywords = ['patch']
message_count = 1.0
messages = ['388904']
nosy_count = 2.0
nosy_names = ['docs@python', 'diegoe']
pr_nums = ['24900']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue43525'
versions = ['Python 3.9']

    Linked PRs

    Activity

    1. diegoe commented on Mar 17, 2021

      @diegoe
      diegoemannequin
      on Mar 17, 2021
      MannequinAuthor

      In the '/' operator documentation for pathlib, the behavior for anchored paths is not described:

      https://docs.python.org/3/library/pathlib.html#operators

      The behavior (prefer the second/right-hand root/anchor) is only explained in the PurePath class:

      https://docs.python.org/3/library/pathlib.html#pathlib.PurePath

      I ran into this while helping migrate a code base that was using "naive" concatenation of strings, so this:

      PROJECT_DIR = ROOT_DIR + "/project-name"

      was migrated to:

      PROJECT_DIR = ROOT_DIR / "/project-name"

      Note that, of course, we missed the leading "/".

      Although the docs _do_ describe the behavior somewhere else, I believe it's worth being redundant in the operator section.

      I believe it's a reasonable mistake to warn new users against, specially since "naive" concatenation is a common "ugly" pattern that many would be migrating from. Plus, a leading "/" is easy to miss, which would only compound the confusion if you are seeing your path "omit the (left-hand) Path object" (because the anchored string took precedence).

    2. diegoe
      added
      3.9 (EOL)end of life
      on Mar 17, 2021
    3. diegoe
      assigned
      docspython
      on Mar 17, 2021
    4. diegoe
      added
      docsDocumentation in the Doc dir
      3.9 (EOL)end of life
      on Mar 17, 2021
    5. diegoe
      assigned
      docspython
      on Mar 17, 2021
    6. diegoe
      added
      docsDocumentation in the Doc dir
      on Mar 17, 2021
    7. diegoe
      changed the title [-]pathlib: Highlight operator behavior with anchored paths[/-] [+]pathlib: Highlight pathlib operator behavior with anchored paths[/+] on Mar 17, 2021
    8. diegoe
      changed the title [-]pathlib: Highlight operator behavior with anchored paths[/-] [+]pathlib: Highlight pathlib operator behavior with anchored paths[/+] on Mar 17, 2021
    9. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    10. brettcannon
      added
      topic-pathlib
      on Jun 21, 2022
    11. hauntsaninja
      added a commit that references this issue on Jan 4, 2023

      pythongh-87691: provide an absolute pathlib example under operator

      d866f2b
    12. miss-islington
      added 5 commits that reference this issue on Jan 5, 2023

      gh-87691: add an absolute path pathlib example in / operator docs (GH…

      1ae619c

      pythongh-87691: add an absolute path pathlib example in / operator do…

      9c6dcfa

      pythongh-87691: add an absolute path pathlib example in / operator do…

      37dfd49

      gh-87691: add an absolute path pathlib example in / operator docs (GH…

      7586100

      gh-87691: add an absolute path pathlib example in / operator docs (GH…

      4bdc57a
    13. hauntsaninja
      added 2 commits that reference this issue on Jan 5, 2023

      pythongh-87691: clarify use of anchor and segment in pathlib docs

      e5e1b94

      gh-87691: clarify use of anchor in pathlib docs (#100782)

      2f2fa03
    14. miss-islington
      added 4 commits that reference this issue on Jan 6, 2023

      pythongh-87691: clarify use of anchor in pathlib docs (pythonGH-100782)

      8f33a94

      pythongh-87691: clarify use of anchor in pathlib docs (pythonGH-100782)

      20980ec

      gh-87691: clarify use of anchor in pathlib docs (GH-100782)

      f5fa2c1

      gh-87691: clarify use of anchor in pathlib docs (GH-100782)

      d6b8413
    15. hauntsaninja
      closed this as completedon Jan 6, 2023
    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

      3.9 (EOL)end of lifedocsDocumentation in the Doc dirtopic-pathlib

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions