File Manager

X7ROOT File Manager

Current Path: /opt/gsutil/gslib

📁 ..
📄 README(378 B)
📄 __init__.py(6.3 KB)
📄 __main__.py(33.59 KB)
📁 addlhelp
📄 boto_resumable_upload.py(24.69 KB)
📄 boto_translation.py(85.52 KB)
📄 bucket_listing_ref.py(3.9 KB)
📄 cloud_api.py(40.97 KB)
📄 cloud_api_delegator.py(29.87 KB)
📄 command.py(110.58 KB)
📄 command_argument.py(4.35 KB)
📄 command_runner.py(23.21 KB)
📁 commands
📄 context_config.py(8.36 KB)
📄 cred_types.py(1.15 KB)
📄 cs_api_map.py(3.31 KB)
📄 daisy_chain_wrapper.py(14.39 KB)
📁 data
📄 devshell_auth_plugin.py(1.69 KB)
📄 discard_messages_queue.py(1.29 KB)
📄 exception.py(5.18 KB)
📄 file_part.py(3.39 KB)
📄 gcs_json_api.py(104.02 KB)
📄 gcs_json_credentials.py(20.31 KB)
📄 gcs_json_media.py(28.5 KB)
📄 help_provider.py(4.26 KB)
📄 iamcredentials_api.py(11.72 KB)
📄 impersonation_credentials.py(2.51 KB)
📄 kms_api.py(13.24 KB)
📄 lazy_wrapper.py(2.26 KB)
📄 metrics.py(38.98 KB)
📄 metrics_reporter.py(4.61 KB)
📄 metrics_tuple.py(1.44 KB)
📄 name_expansion.py(29.97 KB)
📄 no_op_auth_plugin.py(1.19 KB)
📄 no_op_credentials.py(1.03 KB)
📄 parallel_tracker_file.py(12.14 KB)
📄 plurality_checkable_iterator.py(4.4 KB)
📄 progress_callback.py(6.08 KB)
📄 project_id.py(1.69 KB)
📄 pubsub_api.py(11.17 KB)
📄 resumable_streaming_upload.py(8.53 KB)
📄 seek_ahead_thread.py(5.11 KB)
📄 sig_handling.py(5.64 KB)
📄 storage_uri_builder.py(2.02 KB)
📄 storage_url.py(16.16 KB)
📄 tab_complete.py(10.77 KB)
📁 tests
📁 third_party
📄 thread_message.py(13.71 KB)
📄 tracker_file.py(24.23 KB)
📄 tz_utc.py(2.2 KB)
📄 ui_controller.py(47.42 KB)
📁 utils
📁 vendored
📄 wildcard_iterator.py(37.73 KB)

Editing: help_provider.py

# -*- coding: utf-8 -*-
# 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.
"""Module defining help types and providers for gsutil commands."""

from __future__ import absolute_import
from __future__ import print_function
from __future__ import division
from __future__ import unicode_literals

import collections
from gslib.exception import CommandException

ALL_HELP_TYPES = ['command_help', 'additional_help']

# Constants enforced by SanityCheck
# Mainly here for help output formatting purposes, can be changed if necessary.
MAX_HELP_NAME_LEN = 17
MIN_ONE_LINE_SUMMARY_LEN = 10
MAX_ONE_LINE_SUMMARY_LEN = 80 - MAX_HELP_NAME_LEN

DESCRIPTION_PREFIX = """
<B>DESCRIPTION</B>"""

SYNOPSIS_PREFIX = """
<B>SYNOPSIS</B>"""

class HelpProvider(object):
  """Interface for providing help."""

# Each subclass of HelpProvider define a property named 'help_spec' that is
  # an instance of the following class.
  HelpSpec = collections.namedtuple(
      'HelpSpec',
      [
          # Name of command or auxiliary help info for which this help applies.
          'help_name',
          # List of help name aliases.
          'help_name_aliases',
          # Type of help.
          'help_type',
          # One line summary of this help.
          'help_one_line_summary',
          # The full help text.
          'help_text',
          # Help text for subcommands of the command's help being specified.
          'subcommand_help_text',
      ])

# Each subclass must override this with an instance of HelpSpec.
  help_spec = None

# This is a static helper instead of a class method because the help loader
# (gslib.commands.help._LoadHelpMaps()) operates on classes not instances.
def SanityCheck(help_provider, help_name_map):
  """Helper for checking that a HelpProvider has minimally adequate content."""
  # Sanity check the content.
  help_name_len = len(help_provider.help_spec.help_name)
  assert (help_name_len > 1 and help_name_len < MAX_HELP_NAME_LEN
         ), 'The help name "{text}" must be less then {max}'.format(
             text=help_provider.help_spec.help_name, max=MAX_HELP_NAME_LEN)
  for hna in help_provider.help_spec.help_name_aliases:
    assert hna
  one_line_summary_len = len(help_provider.help_spec.help_one_line_summary)
  assert (one_line_summary_len >= MIN_ONE_LINE_SUMMARY_LEN), (
      'The one line summary "{text}" with a length of {length} must be ' +
      'more then {min} characters').format(
          text=help_provider.help_spec.help_one_line_summary,
          length=one_line_summary_len,
          min=MIN_ONE_LINE_SUMMARY_LEN)
  assert (one_line_summary_len <= MAX_ONE_LINE_SUMMARY_LEN), (
      'The one line summary "{text}" with a length of {length} must be ' +
      'less then {max} characters').format(
          text=help_provider.help_spec.help_one_line_summary,
          length=one_line_summary_len,
          max=MAX_ONE_LINE_SUMMARY_LEN)
  assert len(help_provider.help_spec.help_text
            ) > 10, 'The length of "{text}" must be less then 10'.format(
                text=help_provider.help_spec.help_text)

# Ensure there are no dupe help names or aliases across commands.
  name_check_list = [help_provider.help_spec.help_name]
  name_check_list.extend(help_provider.help_spec.help_name_aliases)
  for name_or_alias in name_check_list:
    if name_or_alias in help_name_map:
      raise CommandException(
          'Duplicate help name/alias "%s" found while loading help from %s. '
          'That name/alias was already taken by %s' %
          (name_or_alias, help_provider.__module__,
           help_name_map[name_or_alias].__module__))

def CreateHelpText(synopsis, description):
  """Helper for adding help text headers given synopsis and description."""
  return SYNOPSIS_PREFIX + synopsis + DESCRIPTION_PREFIX + description

X7ROOT File Manager

Editing: help_provider.py

Upload File

Create Folder