xref: /aosp_15_r20/external/pigweed/pw_package/py/pw_package/packages/nanopb.py (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1# Copyright 2020 The Pigweed Authors
2#
3# Licensed under the Apache License, Version 2.0 (the "License"); you may not
4# use this file except in compliance with the License. You may obtain a copy of
5# the License at
6#
7#     https://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12# License for the specific language governing permissions and limitations under
13# the License.
14"""Install and check status of nanopb."""
15
16import pathlib
17from typing import Sequence
18
19import pw_package.git_repo
20import pw_package.package_manager
21
22
23class NanoPB(pw_package.git_repo.GitRepo):
24    """Install and check status of nanopb."""
25
26    def __init__(self, *args, **kwargs):
27        # pylint: disable=line-too-long
28        super().__init__(
29            *args,
30            name='nanopb',
31            url='https://pigweed.googlesource.com/third_party/github/nanopb/nanopb',
32            commit='2b48a361786dfb1f63d229840217a93aae064667',
33            **kwargs,
34        )
35        # pylint: enable=line-too-long
36
37    def info(self, path: pathlib.Path) -> Sequence[str]:
38        return (
39            f'{self.name} installed in: {path}',
40            "Enable by running 'gn args out' and adding this line:",
41            f'  dir_pw_third_party_nanopb = "{path}"',
42        )
43