xref: /aosp_15_r20/external/federated-compute/fcp/tensorflow/delete_file.py (revision 14675a029014e728ec732f129a32e299b2da0601)
1# Copyright 2022 Google LLC
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 the `delete_file` operation.
15
16This wraps the generated ops and ensures that necessary shared libraries
17are loaded.
18"""
19
20import tensorflow as tf
21
22from fcp.tensorflow import gen_delete_file_py
23
24_delete_file_so = tf.load_op_library(
25    tf.compat.v1.resource_loader.get_path_to_datafile('./_delete_file_op.so'))
26
27
28def delete_file(filename: tf.Tensor) -> tf.Operation:
29  """Delete file if the filename exists.
30
31  Args:
32    filename: The filename to delete.
33
34  Returns:
35    The created `Operation`.
36  """
37  return gen_delete_file_py.delete_file(filename)
38
39
40def delete_dir(dirname: tf.Tensor, recursively: bool = False) -> tf.Operation:
41  """Delete directory if the dirname exists.
42
43  Args:
44    dirname: The directory to delete.
45    recursively: If true the op attempts to delete also the content.
46
47  Returns:
48    The created `Operation`.
49  """
50  return gen_delete_file_py.delete_dir(dirname, recursively)
51