• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

pantsbuild / pants / 19015773527

02 Nov 2025 05:33PM UTC coverage: 17.872% (-62.4%) from 80.3%
19015773527

Pull #22816

github

web-flow
Merge a12d75757 into 6c024e162
Pull Request #22816: Update Pants internal Python to 3.14

4 of 5 new or added lines in 3 files covered. (80.0%)

28452 existing lines in 683 files now uncovered.

9831 of 55007 relevant lines covered (17.87%)

0.18 hits per line

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

0.0
/src/python/pants/backend/tools/preamble/subsystem.py
1
# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
2
# Licensed under the Apache License, Version 2.0 (see LICENSE).
UNCOV
3
from __future__ import annotations
×
4

UNCOV
5
from collections.abc import Sequence
×
6

UNCOV
7
from pants.option.option_types import DictOption, SkipOption
×
UNCOV
8
from pants.option.subsystem import Subsystem
×
UNCOV
9
from pants.source.filespec import FilespecMatcher
×
UNCOV
10
from pants.util.strutil import help_text, softwrap
×
11

12

UNCOV
13
class PreambleSubsystem(Subsystem):
×
UNCOV
14
    options_scope = "preamble"
×
UNCOV
15
    name = "preamble"
×
UNCOV
16
    help = help_text(
×
17
        """
18
        Formats files with a preamble, with the preamble looked up based on path.
19

20
        This is useful for things such as copyright headers or shebang lines.
21

22
        Pants substitutes the following identifiers (following Python's `string.Template` substitutions):
23
        - $year: The current year (only used when actually writing the year to the file).
24
        """
25
    )
26

UNCOV
27
    skip = SkipOption("fmt")
×
28

UNCOV
29
    _template_by_globs = DictOption[str](
×
30
        help=softwrap(
31
            """
32
            Which preamble template to use based on the path globs (relative to the build root).
33

34
            Example:
35

36
                {
37
                    '*.rs': '// Copyright (c) $year\\n// Line 2\\n'
38
                    '*.py:!__init__.py': '# Copyright (c) $year\\n# Line 2\\n',
39
                }
40

41
            It might be helpful to load this config from a JSON or YAML file. To do that, set
42
            `[preamble].config = '@path/to/config.yaml'`, for example.
43
            """
44
        ),
45
        fromfile=True,
46
    )
47

UNCOV
48
    @property
×
UNCOV
49
    def template_by_globs(self) -> dict[tuple[str, ...], str]:
×
50
        return {tuple(key.split(":")): value for key, value in self._template_by_globs.items()}
×
51

UNCOV
52
    def get_template_by_path(self, filepaths: Sequence[str]) -> dict[str, str]:
×
53
        """Returns a mapping from path to (most-relevant) template."""
54
        filepaths_to_test = set(filepaths)
×
55
        template_by_path = {}
×
56
        for globs, template in self.template_by_globs.items():
×
57
            if not filepaths_to_test:
×
58
                break
×
59

60
            matched_filepaths = FilespecMatcher(
×
61
                includes=[
62
                    (glob[2:] if glob.startswith(r"\\!") else glob)
63
                    for glob in globs
64
                    if not glob.startswith("!")
65
                ],
66
                excludes=[glob[1:] for glob in globs if glob.startswith("!")],
67
            ).matches(tuple(filepaths_to_test))
68
            filepaths_to_test -= set(matched_filepaths)
×
69
            for filepath in matched_filepaths:
×
70
                template_by_path[filepath] = template
×
71

72
        return template_by_path
×
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc