Upgrade gsutil to 3.4

third_party/gsutil/gslib/addlhelp/dev.py

+# Copyright 2012 Google Inc.
+#
+# 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>OVERVIEW</B>
+  We're open to incorporating gsutil code changes authored by users. Here
+  are some guidelines:
+
+  1. If you found a bug or have an idea for a feature enhancement, we suggest
+     you check http://code.google.com/p/gsutil/issues/list to see if it has
+     already been reported by another user. From there you can also add yourself
+     to the Cc list for an issue, so you will find out about any developments.
+
+  2. It's usually worthwhile to send email to gs-team@google.com about your
+     idea before sending actual code. Often we can discuss the idea and help
+     propose things that could save you later revision work.
+
+  3. We tend to avoid adding command line options that are of use to only
+     a very small fraction of users, especially if there's some other way
+     to accommodate such needs. Adding such options complicates the code and
+     also adds overhead to users having to read through an "alphabet soup"
+     list of option documentation.
+
+  4. While gsutil has a number of features specific to Google Cloud Storage,
+     it can also be used with other cloud storage providers. We're open to
+     including changes for making gsutil support features specific to other
+     providers, as long as those changes don't make gsutil work worse for Google
+     Cloud Storage. If you do make such changes we recommend including someone
+     with knowledge of the specific provider as a code reviewer (see below).
+
+  5. Please make sure to run all tests against your modified code. To
+     do this, change directories into the gsutil top-level directory and run:
+
+      export PYTHONPATH=./boto:$PYTHONPATH
+      ./gslib/test_commands.py
+      ./gslib/test_thread_pool.py
+      ./gslib/test_wildcard_iterator.py
+
+     The above tests run quickly, as they run against an in-memory mock
+     storage service implementation. We have an additional set of tests
+     that take longer because they send requests to the production service;
+     please also run these tests:
+
+       ./gsutil test
+
+  6. Please consider contributing test code for your change, especially if the
+     change impacts any of the core gsutil code (like the gsutil cp command).
+
+  7. When it's time to send us code, please use the Rietveld code review tool
+     rather than simply sending us a code patch. Do this as follows:
+      - check out the gsutil code from at
+        http://code.google.com/p/gsutil/source/checkout and apply your changes
+        in the checked out directory.
+      - download the "upload.py" script from
+        http://code.google.com/p/rietveld/wiki/UploadPyUsage
+      - run upload.py from the above gsutil svn directory.
+      - click the codereview.appspot.com link it generates, click "Edit Issue",
+        and add mfschwartz@google.com as a reviewer, and Cc gs-team@google.com.
+      - click Publish+Mail Comments.
+""")
+
+
+
+class CommandOptions(HelpProvider):
+  """Additional help about Access Control Lists."""
+
+  help_spec = {
+    # Name of command or auxiliary help info for which this help applies.
+    HELP_NAME : 'dev',
+    # List of help name aliases.
+    HELP_NAME_ALIASES : ['development', 'developer', 'code', 'mods',
+                         'software'],
+    # Type of help:
+    HELP_TYPE : HelpType.ADDITIONAL_HELP,
+    # One line summary of this help.
+    HELP_ONE_LINE_SUMMARY : 'Making modifications to gsutil',
+    # The full help text.
+    HELP_TEXT : _detailed_help_text,
+  }