summaryrefslogtreecommitdiffstats
path: root/src/debputy/plugin/api/feature_set.py
blob: 65523613dc552ce753adc105b6ee7bbc688e2683 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
import dataclasses
from typing import Dict, List, Tuple, Sequence, Any

from debputy.manifest_parser.declarative_parser import ParserGenerator
from debputy.plugin.api.impl_types import (
    DebputyPluginMetadata,
    PackagerProvidedFileClassSpec,
    MetadataOrMaintscriptDetector,
    TTP,
    DispatchingTableParser,
    TP,
    SUPPORTED_DISPATCHABLE_TABLE_PARSERS,
    DispatchingObjectParser,
    SUPPORTED_DISPATCHABLE_OBJECT_PARSERS,
    PluginProvidedManifestVariable,
    PluginProvidedPackageProcessor,
    PluginProvidedDiscardRule,
    ServiceManagerDetails,
    PluginProvidedKnownPackagingFile,
    PluginProvidedTypeMapping,
)


@dataclasses.dataclass(slots=True)
class PluginProvidedFeatureSet:
    plugin_data: Dict[str, DebputyPluginMetadata] = dataclasses.field(
        default_factory=dict
    )
    packager_provided_files: Dict[str, PackagerProvidedFileClassSpec] = (
        dataclasses.field(default_factory=dict)
    )
    metadata_maintscript_detectors: Dict[str, List[MetadataOrMaintscriptDetector]] = (
        dataclasses.field(default_factory=dict)
    )
    dispatchable_table_parsers: Dict[TTP, "DispatchingTableParser[TP]"] = (
        dataclasses.field(
            default_factory=lambda: {
                rt: DispatchingTableParser(rt, path)
                for rt, path in SUPPORTED_DISPATCHABLE_TABLE_PARSERS.items()
            }
        )
    )
    dispatchable_object_parsers: Dict[str, "DispatchingObjectParser"] = (
        dataclasses.field(
            default_factory=lambda: {
                path: DispatchingObjectParser(path, parser_documentation=ref_doc)
                for path, ref_doc in SUPPORTED_DISPATCHABLE_OBJECT_PARSERS.items()
            }
        )
    )
    manifest_variables: Dict[str, PluginProvidedManifestVariable] = dataclasses.field(
        default_factory=dict
    )
    all_package_processors: Dict[Tuple[str, str], PluginProvidedPackageProcessor] = (
        dataclasses.field(default_factory=dict)
    )
    auto_discard_rules: Dict[str, PluginProvidedDiscardRule] = dataclasses.field(
        default_factory=dict
    )
    service_managers: Dict[str, ServiceManagerDetails] = dataclasses.field(
        default_factory=dict
    )
    known_packaging_files: Dict[str, PluginProvidedKnownPackagingFile] = (
        dataclasses.field(default_factory=dict)
    )
    mapped_types: Dict[Any, PluginProvidedTypeMapping] = dataclasses.field(
        default_factory=dict
    )
    manifest_parser_generator: ParserGenerator = dataclasses.field(
        default_factory=ParserGenerator
    )

    def package_processors_in_order(self) -> Sequence[PluginProvidedPackageProcessor]:
        order = []
        delayed = []
        for plugin_processor in self.all_package_processors.values():
            if not plugin_processor.dependencies:
                order.append(plugin_processor)
            else:
                delayed.append(plugin_processor)

        # At the time of writing, insert order will work as a plugin cannot declare
        # dependencies out of order in the current version.  However, we want to
        # ensure dependencies are taken a bit seriously, so we ensure that processors
        # without dependencies are run first.  This should weed out anything that
        # needs dependencies but do not add them.
        #
        # It is still far from as any dependency issues will be hidden if you just
        # add a single dependency.
        order.extend(delayed)
        return order