xref: /aosp_15_r20/external/perfetto/python/tools/presubmit_utils.py (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1#!/usr/bin/env python3
2# Copyright (C) 2023 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8#      http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15"""
16Enforce import rules for https://ui.perfetto.dev.
17Directory structure encodes ideas about the expected dependency graph
18of the code in those directories. Both in a fuzzy sense: we expect code
19withing a directory to have high cohesion within the directory and low
20coupling (aka fewer imports) outside of the directory - but also
21concrete rules:
22- "base should not depend on the fronted"
23- "plugins should only directly depend on the public API"
24- "we should not have circular dependencies"
25
26Without enforcement exceptions to this rule quickly slip in. This
27script allows such rules to be enforced at presubmit time.
28"""
29