pyclean.modern.should_ignore() - Code Metrics - Inspection of "Remove skipIf decorators covering older Pythons" - bittner/pyclean - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 0e4daa...60f4da )

by Peter

created 2025-10-16 01:47 UTC

pyclean.modern.should_ignore() B

↳ Parent: pyclean.modern

Complexity

Conditions

Size

Total Lines	29
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	15
nop	2
dl	0
loc	29
rs	7.3333
c	0
b	0
f	0

# SPDX-FileCopyrightText: 2020 Peter Bittner <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

"""
Modern, cross-platform, pure-Python pyclean implementation.
"""

import logging
import os
from pathlib import Path

BYTECODE_FILES = ['.pyc', '.pyo']
BYTECODE_DIRS = ['__pycache__']
DEBRIS_TOPICS = {
    'cache': [
        '.cache/**/*',
        '.cache/',
    ],
    'coverage': [
        '.coverage',
        'coverage.json',
        'coverage.lcov',
        'coverage.xml',
        'htmlcov/**/*',
        'htmlcov/',
    ],
    'jupyter': [
        '.ipynb_checkpoints/**/*',
        '.ipynb_checkpoints/',
    ],
    'mypy': [
        '.mypy_cache/**/*',
        '.mypy_cache/',
    ],
    'package': [
        'build/bdist.*/**/*',
        'build/bdist.*/',
        'build/lib/**/*',
        'build/lib/',
        'build/',
        'dist/**/*',
        'dist/',
        'sdist/**/*',
        'sdist/',
        '*.egg-info/**/*',
        '*.egg-info/',
    ],
    'pytest': [
        '.pytest_cache/**/*',
        '.pytest_cache/',
        'pytestdebug.log',
    ],
    'ruff': [
        '.ruff_cache/**/*',
        '.ruff_cache/',
    ],
    'tox': [
        '.tox/**/*',
        '.tox/',
    ],
}


class CleanupRunner:
    """Module-level configuration and value store."""

    def __init__(self):
        """Cleanup runner with optional dry-run behavior."""
        self.unlink = None
        self.rmdir = None
        self.ignore = None
        self.unlink_count = None
        self.unlink_failed = None
        self.rmdir_count = None
        self.rmdir_failed = None

    def configure(self, args):
        """Set up runner according to command line options."""
        self.unlink = print_filename if args.dry_run else remove_file
        self.rmdir = print_dirname if args.dry_run else remove_directory
        self.ignore = args.ignore
        self.unlink_count = 0
        self.unlink_failed = 0
        self.rmdir_count = 0
        self.rmdir_failed = 0


log = logging.getLogger(__name__)
Runner = CleanupRunner()


def normalize(path_pattern: str) -> str:
    """
    Normalize path separators in a pattern for cross-platform support.

    On Windows, both forward slash and backslash are valid path separators.
    On Unix/Posix, only forward slash is valid (backslash can be part of filename).
    """
    return path_pattern.replace(os.sep, os.altsep or os.sep)


def should_ignore(path: Path, ignore_patterns: list[str]) -> bool:
    """
    Check if a path should be ignored based on ignore patterns.

    Patterns can be:
    - Simple names like 'bar': matches any directory with that name
    - Paths like 'foo/bar': matches 'bar' directory inside 'foo' directory
      and also ignores everything inside that directory
    """
    if not ignore_patterns:
        return False

    for pattern in ignore_patterns:
        # Check if pattern has multiple components (is a path with separators)
        pattern_parts = Path(normalize(pattern)).parts
        if len(pattern_parts) > 1:
            # Pattern contains path separator - match relative path
            # Path must have at least as many parts as the pattern
            if len(path.parts) < len(pattern_parts):
                continue
            # Check if pattern matches anywhere in the path hierarchy
            for i in range(len(path.parts) - len(pattern_parts) + 1):
                path_slice = path.parts[i : i + len(pattern_parts)]
                if path_slice == pattern_parts:
                    return True
        # Simple name - match the directory name anywhere
        elif path.name == pattern:
            return True
    return False


def remove_file(fileobj):
    """Attempt to delete a file object for real."""
    log.debug('Deleting file: %s', fileobj)
    try:
        fileobj.unlink()
        Runner.unlink_count += 1
    except OSError as err:
        log.debug('File not deleted. %s', err)
        Runner.unlink_failed += 1


def remove_directory(dirobj):
    """Attempt to remove a directory object for real."""
    log.debug('Removing directory: %s', dirobj)
    try:
        dirobj.rmdir()
        Runner.rmdir_count += 1
    except OSError as err:
        log.debug('Directory not removed. %s', err)
        Runner.rmdir_failed += 1


def print_filename(fileobj):
    """Only display the file name, used with --dry-run."""
    log.debug('Would delete file: %s', fileobj)
    Runner.unlink_count += 1


def print_dirname(dirobj):
    """Only display the directory name, used with --dry-run."""
    log.debug('Would delete directory: %s', dirobj)
    Runner.rmdir_count += 1


def pyclean(args):
    """Cross-platform cleaning of Python bytecode."""
    Runner.configure(args)

    for dir_name in args.directory:
        dir_path = Path(dir_name)

        log.info('Cleaning directory %s', dir_path)
        descend_and_clean(dir_path, BYTECODE_FILES, BYTECODE_DIRS)

        for topic in args.debris:
            remove_debris_for(topic, dir_path)

        remove_freeform_targets(args.erase, args.yes, dir_path)

    log.info(
        'Total %d files, %d directories %s.',
        Runner.unlink_count,
        Runner.rmdir_count,
        'would be removed' if args.dry_run else 'removed',
    )

    if Runner.unlink_failed or Runner.rmdir_failed:
        log.debug(
            '%d files, %d directories %s not be removed.',
            Runner.unlink_failed,
            Runner.rmdir_failed,
            'would' if args.dry_run else 'could',
        )

    # Suggest --debris option if it wasn't used
    if not args.debris:
        suggest_debris_option(args)


def descend_and_clean(directory, file_types, dir_names):
    """
    Walk and descend a directory tree, cleaning up files of a certain type
    along the way. Only delete directories if they are empty, in the end.
    """
    for child in sorted(directory.iterdir()):
        if child.is_file():
            if child.suffix in file_types:
                Runner.unlink(child)
        elif child.is_dir():
            if should_ignore(child, Runner.ignore):
                log.debug('Skipping %s', child)
            else:
                descend_and_clean(child, file_types, dir_names)

            if child.name in dir_names:
                Runner.rmdir(child)
        else:
            log.debug('Ignoring %s (neither a file nor a folder)', child)


def remove_debris_for(topic, directory):
    """
    Clean up debris for a specific topic.
    """
    log.debug('Scanning for debris of %s ...', topic.title())

    for path_glob in DEBRIS_TOPICS[topic]:
        delete_filesystem_objects(directory, path_glob, recursive=True)


def remove_freeform_targets(glob_patterns, yes, directory):
    """
    Remove free-form targets using globbing.

    This is **potentially dangerous** since users can delete everything
    anywhere in their file system, including the entire project they're
    working on. For this reason, the implementation imposes the following
    (user experience-related) restrictions:

    - Deleting (directories) is not recursive, directory contents must be
      explicitly specified using globbing (e.g. ``dirname/**/*``).
    - The user is responsible for the deletion order, so that a directory
      is empty when it is attempted to be deleted.
    - A confirmation prompt for the deletion of every single file system
      object is shown (unless the ``--yes`` option is used, in addition).
    """
    for path_glob in glob_patterns:
        log.debug('Erase file system objects matching: %s', path_glob)
        delete_filesystem_objects(directory, path_glob, prompt=not yes)


def delete_filesystem_objects(directory, path_glob, prompt=False, recursive=False):
    """
    Identifies all pathnames matching a specific glob pattern, and attempts
    to delete them in the proper order, optionally asking for confirmation.

    Implementation Note: We sort the file system objects in *reverse order*
    and first delete *all files* before removing directories. This way we
    make sure that the directories that are deepest down in the hierarchy
    are empty (for both files & directories) when we attempt to remove them.
    """
    all_names = sorted(directory.glob(path_glob), reverse=True)
    dirs = (name for name in all_names if name.is_dir() and not name.is_symlink())

    files = (name for name in all_names if not name.is_dir() or name.is_symlink())

    for file_object in files:
        file_type = 'symlink' if file_object.is_symlink() else 'file'
        if prompt and not confirm('Delete %s %s' % (file_type, file_object)):
            Runner.unlink_failed += 1
            continue
        Runner.unlink(file_object)

    for dir_object in dirs:
        if prompt and not confirm('Remove empty directory %s' % dir_object):
            Runner.rmdir_failed += 1
            continue
        Runner.rmdir(dir_object)

    if recursive:
        subdirs = (Path(name.path) for name in os.scandir(directory) if name.is_dir())
        for subdir in subdirs:
            if should_ignore(subdir, Runner.ignore):
                log.debug('Skipping %s', subdir)
            else:
                delete_filesystem_objects(subdir, path_glob, prompt, recursive)


def confirm(message):
    """An interactive confirmation prompt."""
    try:
        answer = input('%s? ' % message)
        return answer.strip().lower() in ['y', 'yes']
    except KeyboardInterrupt:
        msg = 'Aborted by user.'
        raise SystemExit(msg)


def detect_debris_in_directory(directory):
    """
    Scan a directory for debris artifacts and return a list of detected topics.
    """
    detected_topics = []

    for topic, patterns in DEBRIS_TOPICS.items():
        for pattern in patterns:
            # Skip patterns that are for recursive cleanup (contain **)
            if '**' in pattern:
                continue
            # Check if the pattern matches anything in the directory
            matches = list(directory.glob(pattern))
            if matches:
                detected_topics.append(topic)
                break  # Found at least one match for this topic, move to next

    return detected_topics


def suggest_debris_option(args):
    """
    Suggest using the --debris option when it wasn't used.
    Optionally provide targeted suggestions based on detected artifacts.
    """
    # Collect all detected debris topics across all directories
    all_detected = set()
    for dir_name in args.directory:
        dir_path = Path(dir_name)
        if dir_path.exists():
            detected = detect_debris_in_directory(dir_path)
            all_detected.update(detected)

    if all_detected:
        # Provide targeted suggestion
        topics_str = ' '.join(sorted(all_detected))
        log.info(
            'Hint: Use --debris to also clean up build artifacts. Detected: %s',
            topics_str,
        )
    else:
        # Provide general suggestion
        log.info(
            'Hint: Use --debris to also clean up build artifacts '
            'from common Python development tools.',
        )


1			# SPDX-FileCopyrightText: 2020 Peter Bittner <[email protected]>
2			#
3			# SPDX-License-Identifier: GPL-3.0-or-later
4
5			"""
6			Modern, cross-platform, pure-Python pyclean implementation.
7			"""
8
9			import logging
10			import os
11			from pathlib import Path
12
13			BYTECODE_FILES = ['.pyc', '.pyo']
14			BYTECODE_DIRS = ['__pycache__']
15			DEBRIS_TOPICS = {
16			'cache': [
17			'.cache/*/',
18			'.cache/',
19			],
20			'coverage': [
21			'.coverage',
22			'coverage.json',
23			'coverage.lcov',
24			'coverage.xml',
25			'htmlcov/*/',
26			'htmlcov/',
27			],
28			'jupyter': [
29			'.ipynb_checkpoints/*/',
30			'.ipynb_checkpoints/',
31			],
32			'mypy': [
33			'.mypy_cache/*/',
34			'.mypy_cache/',
35			],
36			'package': [
37			'build/bdist.//',
38			'build/bdist.*/',
39			'build/lib/*/',
40			'build/lib/',
41			'build/',
42			'dist/*/',
43			'dist/',
44			'sdist/*/',
45			'sdist/',
46			'.egg-info//',
47			'*.egg-info/',
48			],
49			'pytest': [
50			'.pytest_cache/*/',
51			'.pytest_cache/',
52			'pytestdebug.log',
53			],
54			'ruff': [
55			'.ruff_cache/*/',
56			'.ruff_cache/',
57			],
58			'tox': [
59			'.tox/*/',
60			'.tox/',
61			],
62			}
63
64
65			class CleanupRunner:
66			"""Module-level configuration and value store."""
67
68			def __init__(self):
69			"""Cleanup runner with optional dry-run behavior."""
70			self.unlink = None
71			self.rmdir = None
72			self.ignore = None
73			self.unlink_count = None
74			self.unlink_failed = None
75			self.rmdir_count = None
76			self.rmdir_failed = None
77
78			def configure(self, args):
79			"""Set up runner according to command line options."""
80			self.unlink = print_filename if args.dry_run else remove_file
81			self.rmdir = print_dirname if args.dry_run else remove_directory
82			self.ignore = args.ignore
83			self.unlink_count = 0
84			self.unlink_failed = 0
85			self.rmdir_count = 0
86			self.rmdir_failed = 0
87
88
89			log = logging.getLogger(__name__)
90			Runner = CleanupRunner()
91
92
93			def normalize(path_pattern: str) -> str:
94			"""
95			Normalize path separators in a pattern for cross-platform support.
96
97			On Windows, both forward slash and backslash are valid path separators.
98			On Unix/Posix, only forward slash is valid (backslash can be part of filename).
99			"""
100			return path_pattern.replace(os.sep, os.altsep or os.sep)
101
102
103			def should_ignore(path: Path, ignore_patterns: list[str]) -> bool:
104			"""
105			Check if a path should be ignored based on ignore patterns.
106
107			Patterns can be:
108			- Simple names like 'bar': matches any directory with that name
109			- Paths like 'foo/bar': matches 'bar' directory inside 'foo' directory
110			and also ignores everything inside that directory
111			"""
112			if not ignore_patterns:
113			return False
114
115			for pattern in ignore_patterns:
116			# Check if pattern has multiple components (is a path with separators)
117			pattern_parts = Path(normalize(pattern)).parts
118			if len(pattern_parts) > 1:
119			# Pattern contains path separator - match relative path
120			# Path must have at least as many parts as the pattern
121			if len(path.parts) < len(pattern_parts):
122			continue
123			# Check if pattern matches anywhere in the path hierarchy
124			for i in range(len(path.parts) - len(pattern_parts) + 1):
125			path_slice = path.parts[i : i + len(pattern_parts)]
126			if path_slice == pattern_parts:
127			return True
128			# Simple name - match the directory name anywhere
129			elif path.name == pattern:
130			return True
131			return False
132
133
134			def remove_file(fileobj):
135			"""Attempt to delete a file object for real."""
136			log.debug('Deleting file: %s', fileobj)
137			try:
138			fileobj.unlink()
139			Runner.unlink_count += 1
140			except OSError as err:
141			log.debug('File not deleted. %s', err)
142			Runner.unlink_failed += 1
143
144
145			def remove_directory(dirobj):
146			"""Attempt to remove a directory object for real."""
147			log.debug('Removing directory: %s', dirobj)
148			try:
149			dirobj.rmdir()
150			Runner.rmdir_count += 1
151			except OSError as err:
152			log.debug('Directory not removed. %s', err)
153			Runner.rmdir_failed += 1
154
155
156			def print_filename(fileobj):
157			"""Only display the file name, used with --dry-run."""
158			log.debug('Would delete file: %s', fileobj)
159			Runner.unlink_count += 1
160
161
162			def print_dirname(dirobj):
163			"""Only display the directory name, used with --dry-run."""
164			log.debug('Would delete directory: %s', dirobj)
165			Runner.rmdir_count += 1
166
167
168			def pyclean(args):
169			"""Cross-platform cleaning of Python bytecode."""
170			Runner.configure(args)
171
172			for dir_name in args.directory:
173			dir_path = Path(dir_name)
174
175			log.info('Cleaning directory %s', dir_path)
176			descend_and_clean(dir_path, BYTECODE_FILES, BYTECODE_DIRS)
177
178			for topic in args.debris:
179			remove_debris_for(topic, dir_path)
180
181			remove_freeform_targets(args.erase, args.yes, dir_path)
182
183			log.info(
184			'Total %d files, %d directories %s.',
185			Runner.unlink_count,
186			Runner.rmdir_count,
187			'would be removed' if args.dry_run else 'removed',
188			)
189
190			if Runner.unlink_failed or Runner.rmdir_failed:
191			log.debug(
192			'%d files, %d directories %s not be removed.',
193			Runner.unlink_failed,
194			Runner.rmdir_failed,
195			'would' if args.dry_run else 'could',
196			)
197
198			# Suggest --debris option if it wasn't used
199			if not args.debris:
200			suggest_debris_option(args)
201
202
203			def descend_and_clean(directory, file_types, dir_names):
204			"""
205			Walk and descend a directory tree, cleaning up files of a certain type
206			along the way. Only delete directories if they are empty, in the end.
207			"""
208			for child in sorted(directory.iterdir()):
209			if child.is_file():
210			if child.suffix in file_types:
211			Runner.unlink(child)
212			elif child.is_dir():
213			if should_ignore(child, Runner.ignore):
214			log.debug('Skipping %s', child)
215			else:
216			descend_and_clean(child, file_types, dir_names)
217
218			if child.name in dir_names:
219			Runner.rmdir(child)
220			else:
221			log.debug('Ignoring %s (neither a file nor a folder)', child)
222
223
224			def remove_debris_for(topic, directory):
225			"""
226			Clean up debris for a specific topic.
227			"""
228			log.debug('Scanning for debris of %s ...', topic.title())
229
230			for path_glob in DEBRIS_TOPICS[topic]:
231			delete_filesystem_objects(directory, path_glob, recursive=True)
232
233
234			def remove_freeform_targets(glob_patterns, yes, directory):
235			"""
236			Remove free-form targets using globbing.
237
238			This is potentially dangerous since users can delete everything
239			anywhere in their file system, including the entire project they're
240			working on. For this reason, the implementation imposes the following
241			(user experience-related) restrictions:
242
243			- Deleting (directories) is not recursive, directory contents must be
244			explicitly specified using globbing (e.g. ``dirname/*/``).
245			- The user is responsible for the deletion order, so that a directory
246			is empty when it is attempted to be deleted.
247			- A confirmation prompt for the deletion of every single file system
248			object is shown (unless the ``--yes`` option is used, in addition).
249			"""
250			for path_glob in glob_patterns:
251			log.debug('Erase file system objects matching: %s', path_glob)
252			delete_filesystem_objects(directory, path_glob, prompt=not yes)
253
254
255			def delete_filesystem_objects(directory, path_glob, prompt=False, recursive=False):
256			"""
257			Identifies all pathnames matching a specific glob pattern, and attempts
258			to delete them in the proper order, optionally asking for confirmation.
259
260			Implementation Note: We sort the file system objects in reverse order
261			and first delete all files before removing directories. This way we
262			make sure that the directories that are deepest down in the hierarchy
263			are empty (for both files & directories) when we attempt to remove them.
264			"""
265			all_names = sorted(directory.glob(path_glob), reverse=True)
266			dirs = (name for name in all_names if name.is_dir() and not name.is_symlink())
			0 ignored issues – show Comprehensibility Best Practice introduced 2023-01-27 09:22 UTC by Report Bug Copy Issue Report The variable `name` does not seem to be defined. Loading history...
267			files = (name for name in all_names if not name.is_dir() or name.is_symlink())
268
269			for file_object in files:
270			file_type = 'symlink' if file_object.is_symlink() else 'file'
271			if prompt and not confirm('Delete %s %s' % (file_type, file_object)):
272			Runner.unlink_failed += 1
273			continue
274			Runner.unlink(file_object)
275
276			for dir_object in dirs:
277			if prompt and not confirm('Remove empty directory %s' % dir_object):
278			Runner.rmdir_failed += 1
279			continue
280			Runner.rmdir(dir_object)
281
282			if recursive:
283			subdirs = (Path(name.path) for name in os.scandir(directory) if name.is_dir())
284			for subdir in subdirs:
285			if should_ignore(subdir, Runner.ignore):
286			log.debug('Skipping %s', subdir)
287			else:
288			delete_filesystem_objects(subdir, path_glob, prompt, recursive)
289
290
291			def confirm(message):
292			"""An interactive confirmation prompt."""
293			try:
294			answer = input('%s? ' % message)
295			return answer.strip().lower() in ['y', 'yes']
296			except KeyboardInterrupt:
297			msg = 'Aborted by user.'
298			raise SystemExit(msg)
299
300
301			def detect_debris_in_directory(directory):
302			"""
303			Scan a directory for debris artifacts and return a list of detected topics.
304			"""
305			detected_topics = []
306
307			for topic, patterns in DEBRIS_TOPICS.items():
308			for pattern in patterns:
309			# Skip patterns that are for recursive cleanup (contain **)
310			if '**' in pattern:
311			continue
312			# Check if the pattern matches anything in the directory
313			matches = list(directory.glob(pattern))
314			if matches:
315			detected_topics.append(topic)
316			break # Found at least one match for this topic, move to next
317
318			return detected_topics
319
320
321			def suggest_debris_option(args):
322			"""
323			Suggest using the --debris option when it wasn't used.
324			Optionally provide targeted suggestions based on detected artifacts.
325			"""
326			# Collect all detected debris topics across all directories
327			all_detected = set()
328			for dir_name in args.directory:
329			dir_path = Path(dir_name)
330			if dir_path.exists():
331			detected = detect_debris_in_directory(dir_path)
332			all_detected.update(detected)
333
334			if all_detected:
335			# Provide targeted suggestion
336			topics_str = ' '.join(sorted(all_detected))
337			log.info(
338			'Hint: Use --debris to also clean up build artifacts. Detected: %s',
339			topics_str,
340			)
341			else:
342			# Provide general suggestion
343			log.info(
344			'Hint: Use --debris to also clean up build artifacts '
345			'from common Python development tools.',
346			)
347

bittner / pyclean

Push — main ( 0e4daa...60f4da )

pyclean.modern.should_ignore() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like