App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | List of all members
google.appengine.tools.devappserver2.module.InteractiveCommandModule Class Reference
Inheritance diagram for google.appengine.tools.devappserver2.module.InteractiveCommandModule:
google.appengine.tools.devappserver2.module.Module

Public Member Functions

def __init__
 
def balanced_port
 
def quit
 
def restart
 
def send_interactive_command
 
- Public Member Functions inherited from google.appengine.tools.devappserver2.module.Module
def __init__
 
def name
 
def ready
 
def balanced_port
 
def host
 
def balanced_address
 
def max_instance_concurrent_requests
 
def module_configuration
 
def supports_interactive_commands
 
def set_num_instances
 
def get_num_instances
 
def suspend
 
def resume
 
def get_instance_address
 
def get_instance_port
 
def get_instance
 
def supports_individually_addressable_instances
 
def create_interactive_command_module
 
def build_request_environ
 

Additional Inherited Members

- Static Public Member Functions inherited from google.appengine.tools.devappserver2.module.Module
def generate_request_log_id
 
def generate_request_id_hash
 

Detailed Description

A Module that can evaluate user commands.

This module manages a single Instance which is started lazily.

Constructor & Destructor Documentation

def google.appengine.tools.devappserver2.module.InteractiveCommandModule.__init__ (   self,
  module_configuration,
  host,
  balanced_port,
  api_host,
  api_port,
  auth_domain,
  runtime_stderr_loglevel,
  php_config,
  python_config,
  cloud_sql_config,
  vm_config,
  default_version_port,
  port_registry,
  request_data,
  dispatcher,
  use_mtime_file_watcher,
  allow_skipped_files,
  threadsafe_override 
)
Initializer for InteractiveCommandModule.

Args:
  module_configuration: An application_configuration.ModuleConfiguration
  instance storing the configuration data for this module.
  host: A string containing the host that will be used when constructing
  HTTP headers sent to the Instance executing the interactive command
  e.g. "localhost".
  balanced_port: An int specifying the port that will be used when
  constructing HTTP headers sent to the Instance executing the
  interactive command e.g. "localhost".
  api_host: The host that APIServer listens for RPC requests on.
  api_port: The port that APIServer listens for RPC requests on.
  auth_domain: A string containing the auth domain to set in the environment
  variables.
  runtime_stderr_loglevel: An int reprenting the minimum logging level at
  which runtime log messages should be written to stderr. See
  devappserver2.py for possible values.
  php_config: A runtime_config_pb2.PhpConfig instances containing PHP
  runtime-specific configuration. If None then defaults are used.
  python_config: A runtime_config_pb2.PythonConfig instance containing
  Python runtime-specific configuration. If None then defaults are
  used.
  cloud_sql_config: A runtime_config_pb2.CloudSQL instance containing the
  required configuration for local Google Cloud SQL development. If None
  then Cloud SQL will not be available.
  vm_config: A runtime_config_pb2.VMConfig instance containing
  VM runtime-specific configuration. If None all docker-related stuff
  is disabled.
  default_version_port: An int containing the port of the default version.
  port_registry: A dispatcher.PortRegistry used to provide the Dispatcher
  with a mapping of port to Module and Instance.
  request_data: A wsgi_request_info.WSGIRequestInfo that will be provided
  with request information for use by API stubs.
  dispatcher: A Dispatcher instance that can be used to make HTTP requests.
  use_mtime_file_watcher: A bool containing whether to use mtime polling to
  monitor file changes even if other options are available on the
  current platform.
  allow_skipped_files: If True then all files in the application's directory
  are readable, even if they appear in a static handler or "skip_files"
  directive.
  threadsafe_override: If not None, ignore the YAML file value of threadsafe
  and use this value instead.

Member Function Documentation

def google.appengine.tools.devappserver2.module.InteractiveCommandModule.balanced_port (   self)
The port that the balanced HTTP server for the Module is listening on.

The InteractiveCommandModule does not actually listen on this port but it is
used when constructing the "SERVER_PORT" in the WSGI-environment.
def google.appengine.tools.devappserver2.module.InteractiveCommandModule.quit (   self)
Stops the InteractiveCommandModule.
def google.appengine.tools.devappserver2.module.InteractiveCommandModule.restart (   self)
Restarts the module.
def google.appengine.tools.devappserver2.module.InteractiveCommandModule.send_interactive_command (   self,
  command 
)
Sends an interactive command to the module.

Args:
  command: The command to send e.g. "print 5+5".

Returns:
  A string representing the result of the command e.g. "10\n".

Raises:
  InteractiveCommandError: if the command failed for any reason.

The documentation for this class was generated from the following file: