Function _is_arg_name

fire/docstrings.py:302–319

Returns whether name is a valid arg name. This is used to prevent multiple words (plaintext) from being misinterpreted as an argument name. Any line that doesn't match the pattern for a valid argument is treated as not being an argument. Args: name: The name of the potential arg. Ret

(name)

def _is_arg_name(name):
  """Returns whether name is a valid arg name.

  This is used to prevent multiple words (plaintext) from being misinterpreted
  as an argument name. Any line that doesn't match the pattern for a valid
  argument is treated as not being an argument.

  Args:
    name: The name of the potential arg.
  Returns:
    True if name looks like an arg name, False otherwise.
  """
  name = name.strip()
  # arg_pattern is a letter or underscore followed by
  # zero or more letters, numbers, or underscores.
  arg_pattern = r'^[a-zA-Z_]\w*$'
  re.match(arg_pattern, name)
  return re.match(arg_pattern, name) is not None


def _as_arg_name_and_type(text):