xref: /aosp_15_r20/build/bazel/scripts/difftool/diffs/diff.py (revision 7594170e27e0732bc44b93d1440d87a54b6ffe7c)
1#!/usr/bin/env python3
2#
3# Copyright (C) 2022 The Android Open Source Project
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9#   http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License."""
16
17from abc import ABC, abstractmethod
18import pathlib
19from typing import Callable
20
21# given a file, give a list of "information" about it
22ExtractInfo = Callable[[pathlib.Path], list[str]]
23
24class Diff(ABC):
25  @abstractmethod
26  def diff(left_path: pathlib.Path, right_path: pathlib.Path) -> list[str]:
27    """Returns a list of strings describing differences in `.o` files.
28    Returns the empty list if these files are deemed "similar enough".
29    """
30    pass
31