GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GH-73991: Split "Directory and file operations" section in shutil docs by barneygale · Pull Request #119159 · python/cpython

Conversation

@barneygale

@barneygale barneygale commented May 18, 2024 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Split "Directory and file operations" section in five:

  1. "Copying files"
  2. "Recursively copying, moving and removing"
  3. "Querying disk usage"
  4. "Changing file ownership"
  5. "Finding executables"

The "Platform-dependent efficient copy operations" information is moved to "Copying files". The examples of copytree() and rmtree() are moved into their function docs.

This should be slightly easier to navigate for users, and draws more of a distinction between the lower-level file copying functions and the higher-level copytree() / rmtree() / move() functions.

  • Issue: Support moving across filesystems in pathlib.Path, as shutil.move() does #73991

📚 Documentation preview 📚: https://cpython-previews--119159.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@barneygale
pythonGH-73991: Split "Directory and file operations" section in shut…
262f5ea 
…il docs

Split "Directory and file operations" section in five:

1. "Copying files"
2. "Recursively copying, moving and removing"
3. "Querying disk usage"
4. "Changing file ownership"
5. "Finding executables"

The "Platform-dependent efficient copy operations" information is moved to
"Copying files". The examples of `copytree()` and `rmtree()` are moved into
their function docs.

This should be slightly easier to navigate for users, and draws more of a
distinction between the lower-level file copying functions and the
higher-level `copytree()` / `rmtree()` / `move()` functions.
@barneygale
barneygale requested a review from pfmoore May 18, 2024 21:19
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting core review labels May 18, 2024
@bedevere-app bedevere-app Bot mentioned this pull request May 18, 2024
Support moving across filesystems in pathlib.Path, as shutil.move() does #73991
Closed
pfmoore
pfmoore reviewed May 18, 2024
View reviewed changes
Comment thread Doc/library/shutil.rst
return [] # nothing will be ignored

copytree(source, destination, ignore=_logpath)

@pfmoore pfmoore May 18, 2024

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Taken in isolation, this example seems weird, as it's not actually ignoring anything. I'd suggest keeping the ignore_patterns example from the original text as well, and describe this example as something like:

You don't have to ignore anything, if you simply want to run some code for every directory that gets processed. For example, this snippet uses the ignore argument to add a logging call::

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
pfmoore
pfmoore reviewed May 18, 2024
View reviewed changes

@pfmoore pfmoore left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Apart from the one comment I made (I accidentally clicked "add a single comment" rather than "Start a review" 🙁) this LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@barneygale

barneygale commented Aug 26, 2024

Copy link
Copy Markdown
Contributor Author

Withdrawing this PR. With the work on GH-73991 at its end, we actually didn't need to touch shutil.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@barneygale barneygale closed this Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pfmoore pfmoore pfmoore left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

awaiting core review docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@barneygale @pfmoore
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.