filecmp.dircmp does not allow non-shallow comparisons #57141

kesmit · 2011-09-07T16:01:36Z

BPO	12932
Nosy	@terryjreedy, @rbtcollins, @merwok, @regebro, @mitar, @cjerdonek
Files	issue12932.diff: Add input parameter 'shallow' to dircmp.

^{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 2011-09-07.16:01:35.750>
labels = ['type-feature', 'library']
title = 'filecmp.dircmp does not allow non-shallow comparisons'
updated_at = <Date 2018-01-03.09:42:28.161>
user = 'https://bugs.python.org/kesmit'

bugs.python.org fields:

activity = <Date 2018-01-03.09:42:28.161>
actor = 'mitar'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2011-09-07.16:01:35.750>
creator = 'kesmit'
dependencies = []
files = ['30589']
hgrepos = []
issue_num = 12932
keywords = ['patch']
message_count = 9.0
messages = ['143692', '156736', '160966', '161823', '164648', '166246', '191154', '247695', '247696']
nosy_count = 8.0
nosy_names = ['terry.reedy', 'rbcollins', 'eric.araujo', 'lregebro', 'mitar', 'chris.jerdonek', 'planet36', 'kesmit']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue12932'
versions = ['Python 3.6']

Linked PRs

kesmit · 2011-09-07T16:01:36Z

While filecmp.cmp and filecmp.cmpfiles allow a shallow option to be specified to invoke a more involved comparison of files, filecmp.dircmp does not. It is limited to shallow-only comparisons.

This could be solved quite easily by adding a shallow keyword option to dircmp then changing the phase3 method to the following.

    def phase3(self): # Find out differences between common files
        xx = cmpfiles(self.left, self.right, self.common_files, self.shallow)
        self.same_files, self.diff_files, self.funny_files = xx

merwok · 2012-03-25T06:59:24Z

Thanks for the report. Unfortunately 2.7 is closed to new features and the module is removed in 3.x, so there is nothing to do here.

regebro · 2012-05-17T12:05:52Z

filecmp is still there in Python 3.3 Alpha 3. I can't find any reference to it being deprecated.

terryjreedy · 2012-05-29T00:34:35Z

Lennart, I saw your response on StackOverflow ;-).

cjerdonek · 2012-07-04T14:41:23Z

+1 for this.

Whether or not this feature is implemented, I think the documentation should state that directory comparisons are done using "shallow=True". I created bpo-15250 for this.

cjerdonek · 2012-07-23T19:55:29Z

Allowing dircmp() to accept a file comparison function is another option to consider that may address more needs going forward. shallow=False could be achieved by passing lambda a, b: filecmp.cmp(a, b, shallow=False).

planet36 · 2013-06-14T21:24:17Z

Add input parameter 'shallow' to dircmp.
Use it in phase3 and phase4.
Document it in filecmp.rst.

Did not modify test_filecmp.py.

rbtcollins · 2015-07-30T20:50:14Z

Thanks for the patch @planet36, however I think this is sufficiently large a change that we should also have a test case for it.

I'm also retargeting this to the current open branches for feature work - 3.6.

rbtcollins · 2015-07-30T20:51:20Z

Bah, wrong stage. patch review.

Nov 17, 2022 · 2022-11-17T20:30:10Z

@rbtcollins any update here?

merwok · 2022-11-17T21:28:46Z

You can see that the latest comment is from 2015.

Someone would need to take the patch, apply it to Python main branch, make sure tests, docs and changelog are present, and open a pull request. The devguide has help about that.

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

encukou · 2024-03-06T13:52:02Z

Thanks to everyone involved!

merwok · 2024-03-06T14:47:23Z

Really wish github would send a notif on the issue when a PR is created to solve it!

terryjreedy · 2024-03-07T01:18:13Z

Not a bad idea. Did bpo do so? (I cannot remember either way for sure.)

Given the absence of such notices, the PR author should have requested a review from you. If not already, the devguide should say something about looking for participants (preferably recent) who are members of 'Python' or 'python/core'. (bpo starred our names on comments.)

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

JelleZijlstra · 2024-07-13T20:50:43Z

Should the new parameter be made keyword-only? I feel we usually do that for newly added optional parameters. We have a little bit of time left before the RC phase to change this.

It is our general practice to make new optional parameters keyword-only, even if the existing parameters are all positional-or-keyword. Passing this parameter as positional would look confusing and could be error-prone if additional parameters are added in the future.

JelleZijlstra · 2024-07-14T13:26:52Z

Submitted #121767 to make the new parameter keyword-only.

It is our general practice to make new optional parameters keyword-only, even if the existing parameters are all positional-or-keyword. Passing this parameter as positional would look confusing and could be error-prone if additional parameters are added in the future.

…ythonGH-121767) It is our general practice to make new optional parameters keyword-only, even if the existing parameters are all positional-or-keyword. Passing this parameter as positional would look confusing and could be error-prone if additional parameters are added in the future. (cherry picked from commit 50eec50) Co-authored-by: Jelle Zijlstra <[email protected]>

…GH-121767) (#121777) It is our general practice to make new optional parameters keyword-only, even if the existing parameters are all positional-or-keyword. Passing this parameter as positional would look confusing and could be error-prone if additional parameters are added in the future. (cherry picked from commit 50eec50) Co-authored-by: Jelle Zijlstra <[email protected]>

…ython#121767) It is our general practice to make new optional parameters keyword-only, even if the existing parameters are all positional-or-keyword. Passing this parameter as positional would look confusing and could be error-prone if additional parameters are added in the future.

kesmit mannequin added stdlib Python modules in the Lib dir type-feature A feature request or enhancement labels Sep 7, 2011

merwok closed this as completed Mar 25, 2012

terryjreedy reopened this May 29, 2012

merwok changed the title ~~dircmp does not allow non-shallow comparisons~~ filecmp.dircmp does not allow non-shallow comparisons Jun 1, 2012

ezio-melotti transferred this issue from another repository Apr 10, 2022

aunzat mentioned this issue Sep 16, 2023

gh-57141: Add dircmp shallow option. #109499

Merged

aunzat added a commit to aunzat/cpython that referenced this issue Sep 25, 2023

pythongh-57141: Add dircmp shallow option.

e80c210

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

aunzat added a commit to aunzat/cpython that referenced this issue Sep 26, 2023

pythongh-57141: Add dircmp shallow option.

437b076

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

aunzat added a commit to aunzat/cpython that referenced this issue Sep 27, 2023

pythongh-57141: Add dircmp shallow option.

8671e21

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

encukou pushed a commit that referenced this issue Mar 4, 2024

gh-57141: Add dircmp shallow option (GH-109499)

60743a9

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

woodruffw pushed a commit to woodruffw-forks/cpython that referenced this issue Mar 4, 2024

pythongh-57141: Add dircmp shallow option (pythonGH-109499)

ae69e6c

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

encukou closed this as completed Mar 6, 2024

adorilson pushed a commit to adorilson/cpython that referenced this issue Mar 25, 2024

pythongh-57141: Add dircmp shallow option (pythonGH-109499)

6618d7a

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

diegorusso pushed a commit to diegorusso/cpython that referenced this issue Apr 17, 2024

pythongh-57141: Add dircmp shallow option (pythonGH-109499)

cdf508c

Co-authored-by: Steve Ward <[email protected]> Co-authored-by: Sanyam Khurana <[email protected]>

JelleZijlstra reopened this Jul 13, 2024

JelleZijlstra mentioned this issue Jul 13, 2024

Update dircmp for 3.13 python/typeshed#12337

Merged

bedevere-app bot mentioned this issue Jul 14, 2024

gh-57141: Make shallow argument to filecmp.dircmp keyword-only #121767

Merged

bedevere-app bot mentioned this issue Jul 14, 2024

[3.13] gh-57141: Make shallow argument to filecmp.dircmp keyword-only (GH-121767) #121777

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

filecmp.dircmp does not allow non-shallow comparisons #57141

filecmp.dircmp does not allow non-shallow comparisons #57141

kesmit mannequin commented Sep 7, 2011 •

edited by bedevere-app bot

Loading

kesmit mannequin commented Sep 7, 2011

merwok commented Mar 25, 2012

regebro mannequin commented May 17, 2012

terryjreedy commented May 29, 2012

cjerdonek commented Jul 4, 2012

cjerdonek commented Jul 23, 2012

planet36 mannequin commented Jun 14, 2013

rbtcollins commented Jul 30, 2015

rbtcollins commented Jul 30, 2015

Nov 17, 2022

merwok commented Nov 17, 2022

encukou commented Mar 6, 2024

merwok commented Mar 6, 2024

terryjreedy commented Mar 7, 2024

JelleZijlstra commented Jul 13, 2024

JelleZijlstra commented Jul 14, 2024

filecmp.dircmp does not allow non-shallow comparisons #57141

filecmp.dircmp does not allow non-shallow comparisons #57141

Comments

kesmit mannequin commented Sep 7, 2011 • edited by bedevere-app bot Loading

Linked PRs

kesmit mannequin commented Sep 7, 2011

merwok commented Mar 25, 2012

regebro mannequin commented May 17, 2012

terryjreedy commented May 29, 2012

cjerdonek commented Jul 4, 2012

cjerdonek commented Jul 23, 2012

planet36 mannequin commented Jun 14, 2013

rbtcollins commented Jul 30, 2015

rbtcollins commented Jul 30, 2015

Nov 17, 2022

merwok commented Nov 17, 2022

encukou commented Mar 6, 2024

merwok commented Mar 6, 2024

terryjreedy commented Mar 7, 2024

JelleZijlstra commented Jul 13, 2024

JelleZijlstra commented Jul 14, 2024

kesmit mannequin commented Sep 7, 2011 •

edited by bedevere-app bot

Loading