• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright 2018 The gRPC Authors
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://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,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14"""Provides setuptools command classes for the GRPC Python setup process."""
15
16import os
17import shutil
18
19import setuptools
20
21ROOT_DIR = os.path.abspath(os.path.dirname(os.path.abspath(__file__)))
22CHANNELZ_PROTO = os.path.join(
23    ROOT_DIR, "../../proto/grpc/channelz/channelz.proto"
24)
25LICENSE = os.path.join(ROOT_DIR, "../../../LICENSE")
26
27
28class Preprocess(setuptools.Command):
29    """Command to copy proto modules from grpc/src/proto and LICENSE from
30    the root directory"""
31
32    description = ""
33    user_options = []
34
35    def initialize_options(self):
36        pass
37
38    def finalize_options(self):
39        pass
40
41    def run(self):
42        if os.path.isfile(CHANNELZ_PROTO):
43            shutil.copyfile(
44                CHANNELZ_PROTO,
45                os.path.join(ROOT_DIR, "grpc_channelz/v1/channelz.proto"),
46            )
47        if os.path.isfile(LICENSE):
48            shutil.copyfile(LICENSE, os.path.join(ROOT_DIR, "LICENSE"))
49
50
51class BuildPackageProtos(setuptools.Command):
52    """Command to generate project *_pb2.py modules from proto files."""
53
54    description = "build grpc protobuf modules"
55    user_options = []
56
57    def initialize_options(self):
58        pass
59
60    def finalize_options(self):
61        pass
62
63    def run(self):
64        # due to limitations of the proto generator, we require that only *one*
65        # directory is provided as an 'include' directory. We assume it's the '' key
66        # to `self.distribution.package_dir` (and get a key error if it's not
67        # there).
68        from grpc_tools import command
69
70        command.build_package_protos(self.distribution.package_dir[""])
71