Skip to content

topmark.filetypes.factory

topmark / filetypes / factory

Factories for creating FileType instances.

This module centralizes small helpers that build FileType objects with sensible defaults and a clear identity model.

Rationale
  • FileType identity is (namespace, local_key).
  • TopMark reserves the namespace TOPMARK_NAMESPACE for built-in file types.
  • Call sites should not repeat boilerplate such as converting None to empty lists.

The helpers here are intentionally lightweight and side-effect free: they return FileType instances but do not register them.

make_filetype_factory 

make_filetype_factory(*, namespace)

Return a FileType constructor that pre-binds a namespace.

This is useful for plugin authors and internal topical modules that want to define multiple file types in the same namespace without repeating the namespace=... argument.

Parameters:

Name Type Description Default
namespace str

The namespace to assign to all constructed FileType objects.

 required

Returns:

Type Description
Callable[..., FileType]

A callable with the same keyword-only parameters as make_builtin_filetype,
Callable[..., FileType]

except that namespace is fixed.
Notes

This helper does not register the file type; it only constructs it. Registration happens when file types are loaded into a registry.

Source code in src/topmark/filetypes/factory.py 
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
def make_filetype_factory(*, namespace: str) -> Callable[..., FileType]:
    """Return a `FileType` constructor that pre-binds a namespace.

    This is useful for plugin authors and internal topical modules that want to
    define multiple file types in the same namespace without repeating the
    `namespace=...` argument.

    Args:
        namespace: The namespace to assign to all constructed `FileType` objects.

    Returns:
        A callable with the same keyword-only parameters as `make_builtin_filetype`,
        except that `namespace` is fixed.

    Notes:
        This helper does **not** register the file type; it only constructs it.
        Registration happens when file types are loaded into a registry.
    """

    def _make(
        *,
        local_key: str,
        description: str,
        extensions: list[str] | None = None,
        filenames: list[str] | None = None,
        patterns: list[str] | None = None,
        skip_processing: bool = False,
        content_matcher: ContentMatcher | None = None,
        content_gate: ContentGate = ContentGate.NEVER,
        header_policy: FileTypeHeaderPolicy | None = None,
        pre_insert_checker: InsertChecker | None = None,
    ) -> FileType:
        return FileType(
            namespace=namespace,
            local_key=local_key,
            extensions=extensions if extensions is not None else [],
            filenames=filenames if filenames is not None else [],
            patterns=patterns if patterns is not None else [],
            description=description,
            header_policy=header_policy or FileTypeHeaderPolicy(),
            skip_processing=skip_processing,
            content_matcher=content_matcher,
            content_gate=content_gate,
            pre_insert_checker=pre_insert_checker,
        )

    return _make