Added gsutil to depot tools

third_party/gsutil/gslib/addlhelp/command_opts.py

+# Copyright 2012 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from gslib.help_provider import HELP_NAME
+from gslib.help_provider import HELP_NAME_ALIASES
+from gslib.help_provider import HELP_ONE_LINE_SUMMARY
+from gslib.help_provider import HelpProvider
+from gslib.help_provider import HELP_TEXT
+from gslib.help_provider import HelpType
+from gslib.help_provider import HELP_TYPE
+
+_detailed_help_text = ("""
+<B>SYNOPSIS</B>
+  Top-level gsutil Options
+
+
+<B>DESCRIPTION</B>
+  gsutil supports separate options for the top-level gsutil command and
+  the individual sub-commands (like cp, rm, etc.) The top-level options
+  control behavior of gsutil that apply across commands. For example, in
+  the command:
+
+    gsutil -m cp -p file gs://bucket/obj
+
+  the -m option applies to gsutil, while the -p option applies to the cp
+  sub-command.
+
+
+<B>OPTIONS</B>
+  -d          Shows HTTP requests/headers.
+
+  -D          Shows HTTP requests/headers plus additional debug info needed when
+              posting support requests.
+
+  -DD         Shows HTTP requests/headers plus additional debug info plus HTTP
+              upstream payload.
+
+  -h          Allows you to specify additional HTTP headers, for example:
+
+                gsutil -h "Cache-Control:public,max-age=3600" \\
+                       -h "Content-Type:text/html" cp ...
+
+              Note that you need to quote the headers/values that
+              contain spaces (such as "Content-Disposition: attachment;
+              filename=filename.ext"), to avoid having the shell split them
+              into separate arguments.
+
+              Note that because the -h option allows you to specify any HTTP
+              header, it is both powerful and potentially dangerous:
+                - It is powerful because it allows you to specify headers that
+                  gsutil doesn't currently know about (e.g., to request
+                  service features from a different storage service provider
+                  than Google); or to override the values gsutil would normally
+                  send with different values.
+                - It is potentially dangerous because you can specify headers
+                  that cause gsutil to send invalid requests, or that in
+                  other ways change the behavior of requests.
+              Thus, you should be sure you understand the underlying storage
+              service HTTP API (and what impact the headers you specify will
+              have) before using the gsutil -h option.
+
+              See also "gsutil help setmeta" for the ability to set metadata
+              fields on objects after they have been uploaded.
+
+  -m          Causes supported operations (cp, mv, rm, setacl, setmeta) to run
+              in parallel. This can significantly improve performance if you are
+              uploading, downloading, moving, removing, or changing ACLs on
+              a large number of files over a fast network connection.
+
+              gsutil performs the specified operation using a combination of
+              multi-threading and multi-processing, using a number of threads
+              and processors determined by the parallel_thread_count and
+              parallel_process_count values set in the boto configuration
+              file. You might want to experiment with these value, as the
+              best value can vary based on a number of factors, including
+              network speed, number of CPUs, and available memory.
+
+              Using the -m option may make your performance worse if you
+              are using a slower network, such as the typical network speeds
+              offered by non-business home network plans.
+
+              If a download or upload operation using parallel transfer fails
+              before the entire transfer is complete (e.g. failing after 300 of
+              1000 files have been transferred), you will need to restart the
+              entire transfer.
+
+  -s          Tells gsutil to use a simulated storage provider (for testing).
+""")
+
+
+class CommandOptions(HelpProvider):
+  """Additional help about gsutil command-level options."""
+
+  help_spec = {
+    # Name of command or auxiliary help info for which this help applies.
+    HELP_NAME : 'options',
+    # List of help name aliases.
+    HELP_NAME_ALIASES : ['arg', 'args', 'cli', 'opt', 'opts'],
+    # Type of help:
+    HELP_TYPE : HelpType.ADDITIONAL_HELP,
+    # One line summary of this help.
+    HELP_ONE_LINE_SUMMARY : 'gsutil-level command line options',
+    # The full help text.
+    HELP_TEXT : _detailed_help_text,
+  }