Skip to content

kraken.std.protobuf

kraken.std.protobuf

Lint and format Protobuf files with buf. Requires that buf is preinstalled.

BufFormatTask

Bases: Task

Format Protobuf files with buf.

Source code in kraken/std/protobuf/__init__.py 
10
11
12
13
14
15
16
17
18
19
class BufFormatTask(Task):
    """Format Protobuf files with `buf`."""

    description = "Format Protobuf files with buf."

    def execute(self) -> TaskStatus | None:
        command = ["buf", "format", "-w"]
        result = sp.call(command, cwd=self.project.directory / "proto")

        return TaskStatus.from_exit_code(command, result)

BufLintTask

Bases: Task

Lint Protobuf files with buf.

Source code in kraken/std/protobuf/__init__.py 
22
23
24
25
26
27
28
29
30
31
class BufLintTask(Task):
    """Lint Protobuf files with `buf`."""

    description = "Lint Protobuf files with buf."

    def execute(self) -> TaskStatus | None:
        command = ["buf", "lint"]
        result = sp.call(command, cwd=self.project.directory / "proto")

        return TaskStatus.from_exit_code(command, result)

buf_format 

buf_format(
    *,
    name: str = "buf.format",
    project: Project | None = None
) -> BufFormatTask

Format Protobuf files with buf.

Source code in kraken/std/protobuf/__init__.py 
34
35
36
37
def buf_format(*, name: str = "buf.format", project: Project | None = None) -> BufFormatTask:
    """Format Protobuf files with `buf`."""
    project = project or Project.current()
    return project.task(name, BufFormatTask, group="fmt")

buf_lint 

buf_lint(
    *,
    name: str = "buf.lint",
    project: Project | None = None
) -> BufLintTask

Lint Protobuf files with buf.

Source code in kraken/std/protobuf/__init__.py 
40
41
42
43
def buf_lint(*, name: str = "buf.lint", project: Project | None = None) -> BufLintTask:
    """Lint Protobuf files with `buf`."""
    project = project or Project.current()
    return project.task(name, BufLintTask, group="lint")