20632486505

Committed 01 Jan 2026 04:21AM UTC coverage: 43.231% (-37.1%) from 80.281%

Build # 20632486505

Build Type

Pull #22962

github

Committed by

web-flow

Commit Message

Merge 08d5c63b0 into f52ab6675

Pull Request Pull Request #22962: Bump the gha-deps group across 1 directory with 6 updates

Run Details

26122 of 60424 relevant lines covered (43.23%)

0.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

21.74

/src/python/pants/fs/fs.py

# Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

import hashlib
import os

# The max filename length for HFS+, extX and NTFS is 255, but many systems also have limits on the
# total path length (made up of multiple filenames), so we include some additional buffer.
_MAX_FILENAME_LENGTH = 100


def safe_filename(name, extension=None, digest=None, max_length=_MAX_FILENAME_LENGTH):
    """Creates filename from name and extension ensuring that the final length is within the
    max_length constraint.

    By default the length is capped to work on most filesystems and the fallback to achieve
    shortening is a sha1 hash of the proposed name.

    Raises ValueError if the proposed name is not a simple filename but a file path.
    Also raises ValueError when the name is simple but cannot be satisfactorily shortened with the
    given digest.

    :API: public

    name:       the proposed filename without extension
    extension:  an optional extension to append to the filename
    digest:     the digest to fall back on for too-long name, extension concatenations - should
                support the hashlib digest api of update(string) and hexdigest
    max_length: the maximum desired file name length
    """
    if os.path.basename(name) != name:
        raise ValueError(f"Name must be a filename, handed a path: {name}")

    ext = extension or ""
    filename = name + ext
    if len(filename) <= max_length:
        return filename
    else:
        digest = digest or hashlib.sha1()
        digest.update(filename.encode())
        hexdigest = digest.hexdigest()[:16]

        # Prefix and suffix length: max length less 2 periods, the extension length, and the digest length.
        ps_len = max(0, (max_length - (2 + len(ext) + len(hexdigest))) // 2)
        sep = "." if ps_len > 0 else ""
        prefix = name[:ps_len]
        suffix = name[-ps_len:] if ps_len > 0 else ""

        safe_name = f"{prefix}{sep}{hexdigest}{sep}{suffix}{ext}"
        if len(safe_name) > max_length:
            raise ValueError(
                f"Digest {digest} failed to produce a filename <= {max_length} characters for {filename} - got {safe_name}"
            )
        return safe_name


def safe_filename_from_path(path, **kwargs):
    """As for `safe_filename`, but takes a path.

    First converts it into a name by replacing separator characters, and then calls safe_filename.
    """
    return safe_filename(path.strip(os.path.sep).replace(os.path.sep, "."), **kwargs)

1	# Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	import hashlib	2✔
5	import os	2✔
6
7	# The max filename length for HFS+, extX and NTFS is 255, but many systems also have limits on the
8	# total path length (made up of multiple filenames), so we include some additional buffer.
9	_MAX_FILENAME_LENGTH = 100	2✔
10
11
12	def safe_filename(name, extension=None, digest=None, max_length=_MAX_FILENAME_LENGTH):	2✔
13	"""Creates filename from name and extension ensuring that the final length is within the
14	max_length constraint.
15
16	By default the length is capped to work on most filesystems and the fallback to achieve
17	shortening is a sha1 hash of the proposed name.
18
19	Raises ValueError if the proposed name is not a simple filename but a file path.
20	Also raises ValueError when the name is simple but cannot be satisfactorily shortened with the
21	given digest.
22
23	:API: public
24
25	name: the proposed filename without extension
26	extension: an optional extension to append to the filename
27	digest: the digest to fall back on for too-long name, extension concatenations - should
28	support the hashlib digest api of update(string) and hexdigest
29	max_length: the maximum desired file name length
30	"""
31	if os.path.basename(name) != name:	×
32	raise ValueError(f"Name must be a filename, handed a path: {name}")	×
33
34	ext = extension or ""	×
35	filename = name + ext	×
36	if len(filename) <= max_length:	×
37	return filename	×
38	else:
39	digest = digest or hashlib.sha1()	×
40	digest.update(filename.encode())	×
41	hexdigest = digest.hexdigest()[:16]	×
42
43	# Prefix and suffix length: max length less 2 periods, the extension length, and the digest length.
44	ps_len = max(0, (max_length - (2 + len(ext) + len(hexdigest))) // 2)	×
45	sep = "." if ps_len > 0 else ""	×
46	prefix = name[:ps_len]	×
47	suffix = name[-ps_len:] if ps_len > 0 else ""	×
48
49	safe_name = f"{prefix}{sep}{hexdigest}{sep}{suffix}{ext}"	×
50	if len(safe_name) > max_length:	×
51	raise ValueError(	×
52	f"Digest {digest} failed to produce a filename <= {max_length} characters for {filename} - got {safe_name}"
53	)
54	return safe_name	×
55
56
57	def safe_filename_from_path(path, **kwargs):	2✔
58	"""As for `safe_filename`, but takes a path.
59
60	First converts it into a name by replacing separator characters, and then calls safe_filename.
61	"""
62	return safe_filename(path.strip(os.path.sep).replace(os.path.sep, "."), **kwargs)	×

pantsbuild / pants / 20632486505

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous