pyclean.gitclean.execute_git_clean() - Code Metrics - Inspection of "Align style of module docstring across modules" - bittner/pyclean - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 9b73b1...666399 )

by Peter

created 2025-11-05 23:56 UTC

pyclean.gitclean.execute_git_clean() A

↳ Parent: pyclean.gitclean

Complexity

Conditions

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	11
dl	0
loc	17
rs	9.85
c	0
b	0
f	0
cc	3
nop	2

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

"""Git integration for cleaning untracked files."""

import logging
import subprocess

GIT_FATAL_ERROR = 128

log = logging.getLogger(__name__)


def build_git_clean_command(
    ignore_patterns: list[str],
    dry_run=False,
    force=False,
) -> list[str]:
    """
    Build the git clean command with appropriate flags.
    """
    exclude = (item for pattern in ignore_patterns for item in ['-e', pattern])

    mode = '-n' if dry_run else '-f' if force else '-i'
    return ['git', 'clean', '-dx', *exclude, mode]


def execute_git_clean(directory, args):
    """
    Execute git clean in the specified directory.
    """
    log.info('Executing git clean...')
    cmd = build_git_clean_command(args.ignore, dry_run=args.dry_run, force=args.yes)

    log.debug('Run: %s', ' '.join(cmd))
    result = subprocess.run(cmd, cwd=directory, check=False)  # noqa: S603

    if result.returncode == GIT_FATAL_ERROR:
        log.warning(
            'Directory %s is not under version control. Skipping git clean.',
            directory,
        )
    elif result.returncode:
        raise SystemExit(result.returncode)


1			# SPDX-FileCopyrightText: 2020 Peter Bittner <[email protected]>
2			#
3			# SPDX-License-Identifier: GPL-3.0-or-later
4
5			"""Git integration for cleaning untracked files."""
6
7			import logging
8			import subprocess
9
10			GIT_FATAL_ERROR = 128
11
12			log = logging.getLogger(__name__)
13
14
15			def build_git_clean_command(
16			ignore_patterns: list[str],
17			dry_run=False,
18			force=False,
19			) -> list[str]:
20			"""
21			Build the git clean command with appropriate flags.
22			"""
23			exclude = (item for pattern in ignore_patterns for item in ['-e', pattern])
			0 ignored issues – show Comprehensibility Best Practice introduced 2025-11-04 22:24 UTC by Report Bug Copy Issue Report The variable `item` does not seem to be defined. Loading history...
24			mode = '-n' if dry_run else '-f' if force else '-i'
25			return ['git', 'clean', '-dx', *exclude, mode]
26
27
28			def execute_git_clean(directory, args):
29			"""
30			Execute git clean in the specified directory.
31			"""
32			log.info('Executing git clean...')
33			cmd = build_git_clean_command(args.ignore, dry_run=args.dry_run, force=args.yes)
34
35			log.debug('Run: %s', ' '.join(cmd))
36			result = subprocess.run(cmd, cwd=directory, check=False) # noqa: S603
37
38			if result.returncode == GIT_FATAL_ERROR:
39			log.warning(
40			'Directory %s is not under version control. Skipping git clean.',
41			directory,
42			)
43			elif result.returncode:
44			raise SystemExit(result.returncode)
45

bittner / pyclean

Push — main ( 9b73b1...666399 )

pyclean.gitclean.execute_git_clean() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like