granicus.if.org Git - esp-idf/blob - docs/local_util.py

   1 # Utility functions used in conf.py
   2 #
   3 # Copyright 2017 Espressif Systems (Shanghai) PTE LTD
   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
  17 import re
  18 import os
  19 import shutil
  20
  21 def run_cmd_get_output(cmd):
  22     return os.popen(cmd).read().strip()
  23
  24 def files_equal(path_1, path_2):
  25     if not os.path.exists(path_1) or not os.path.exists(path_2):
  26         return False
  27     file_1_contents = ''
  28     with open(path_1, "r") as f_1:
  29         file_1_contents = f_1.read()
  30     file_2_contents = ''
  31     with open(path_2, "r") as f_2:
  32         file_2_contents = f_2.read()
  33     return file_1_contents == file_2_contents
  34
  35 def copy_file_if_modified(src_file_path, dst_file_path):
  36     if not files_equal(src_file_path, dst_file_path):
  37         dst_dir_name = os.path.dirname(dst_file_path)
  38         if not os.path.isdir(dst_dir_name):
  39             os.makedirs(dst_dir_name)
  40         shutil.copy(src_file_path, dst_file_path)
  41
  42 def copy_if_modified(src_path, dst_path):
  43     if os.path.isfile(src_path):
  44         copy_file_if_modified(src_path, dst_path)
  45         return
  46
  47     src_path_len = len(src_path)
  48     for root, dirs, files in os.walk(src_path):
  49         for src_file_name in files:
  50             src_file_path = os.path.join(root, src_file_name)
  51             dst_file_path = os.path.join(dst_path + root[src_path_len:], src_file_name)
  52             copy_file_if_modified(src_file_path, dst_file_path)
  53