Inheritance diagram for IPython.parallel.apps.ipclusterapp:
The ipcluster application.
Authors:
Bases: IPython.config.application.Application
An instance of a Python dict.
Get the config class config section
Get the help string for this class in ReST format.
If inst is given, it’s current trait values will be used in place of class defaults.
Get the help string for a single trait.
If inst is given, it’s current trait values will be used in place of the class default.
Get the help string for a single trait and print it.
Get a list of all the names of this classes traits.
This method is just like the trait_names() method, but is unbound.
Get a list of all the traits of this class.
This method is just like the traits() method, but is unbound.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
An instance of a Python list.
unset _instance for this class and singleton parents.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
An instance of a Python list.
An instance of a Python dict.
flatten flags and aliases, so cl-args override as expected.
This prevents issues such as an alias pointing to InteractiveShell, but a config file setting the same trait in TerminalInteraciveShell getting inappropriate priority over the command-line arg.
Only aliases with exactly one descendent in the class list will be promoted.
generate default config file from Configurables
Start logging for this application.
The default is to log to stdout using a StreaHandler. The log level starts at loggin.WARN, but this can be adjusted by setting the log_level attribute.
Do the basic steps to configure me.
Override in subclasses.
Initialize a subcommand with argv.
Has an instance been created?
Returns a global instance of this class.
This method create a new instance if none have previously been created and returns a previously created instance is one already exists.
The arguments and keyword arguments passed to this method are passed on to the __init__() method of the class upon instantiation.
Examples
Create a singleton class using instance, and retrieve it:
>>> from IPython.config.configurable import SingletonConfigurable
>>> class Foo(SingletonConfigurable): pass
>>> foo = Foo.instance()
>>> foo == Foo.instance()
True
Create a subclass that is retrived using the base class instance:
>>> class Bar(SingletonConfigurable): pass
>>> class Bam(Bar): pass
>>> bam = Bam.instance()
>>> bam == Bar.instance()
True
A trait for unicode strings.
Load a .py based config file by filename and path.
An enum that whose value must be in a given sequence.
Setup a handler to be called when a trait changes.
This is used to setup dynamic notifications of trait changes.
Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).
Parameters : | handler : callable
name : list, str, None
remove : bool
|
---|
A trait for unicode strings.
Parse the command line arguments.
Print the alias part of the help.
Print the application description.
Print usage and examples.
This usage string goes at the end of the command line help string and should contain examples of the application’s usage.
Print the flag part of the help.
Print the help for each Configurable class in self.classes.
If classes=False (the default), only flags and aliases are printed.
Print the subcommand part of the help.
Print the version string.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
A trait for unicode strings.
Get metadata values for trait by key.
Get a list of all the names of this classes traits.
Get a list of all the traits of this class.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
Fire the traits events when the config is updated.
A trait for unicode strings.
Bases: IPython.parallel.apps.baseapp.BaseParallelApplication
An instance of a Python dict.
A boolean (True, False) trait.
import and instantiate a Launcher based on importstring
A trait for unicode strings.
Get the config class config section
Get the help string for this class in ReST format.
If inst is given, it’s current trait values will be used in place of class defaults.
Get the help string for a single trait.
If inst is given, it’s current trait values will be used in place of the class default.
Get the help string for a single trait and print it.
Get a list of all the names of this classes traits.
This method is just like the trait_names() method, but is unbound.
Get a list of all the traits of this class.
This method is just like the traits() method, but is unbound.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
An instance of a Python list.
A boolean (True, False) trait.
unset _instance for this class and singleton parents.
A trait for unicode strings.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
A trait for unicode strings.
An instance of a Python list.
A boolean (True, False) trait.
An instance of a Python list.
A boolean (True, False) trait.
alias of ParallelCrashHandler
A boolean (True, False) trait.
An integer trait.
Longs that are unnecessary (<= sys.maxint) are cast to ints.
A string holding a valid dotted object name in Python, such as A.b3._c
this is sys.excepthook after init_crashhandler
set self.verbose_crash=True to use our full crashhandler, instead of a regular traceback with a short message (crash_handler_lite)
An instance of a Python list.
An instance of a Python dict.
flatten flags and aliases, so cl-args override as expected.
This prevents issues such as an alias pointing to InteractiveShell, but a config file setting the same trait in TerminalInteraciveShell getting inappropriate priority over the command-line arg.
Only aliases with exactly one descendent in the class list will be promoted.
generate default config file from Configurables
Get the pid from the pid file.
If the pid file doesn’t exist a PIDFileError is raised.
[optionally] copy default config files into profile dir.
Create a crash handler, typically setting sys.excepthook to it.
Start logging for this application.
The default is to log to stdout using a StreaHandler. The log level starts at loggin.WARN, but this can be adjusted by setting the log_level attribute.
initialize the profile dir
Initialize a subcommand with argv.
Has an instance been created?
Returns a global instance of this class.
This method create a new instance if none have previously been created and returns a previously created instance is one already exists.
The arguments and keyword arguments passed to this method are passed on to the __init__() method of the class upon instantiation.
Examples
Create a singleton class using instance, and retrieve it:
>>> from IPython.config.configurable import SingletonConfigurable
>>> class Foo(SingletonConfigurable): pass
>>> foo = Foo.instance()
>>> foo == Foo.instance()
True
Create a subclass that is retrived using the base class instance:
>>> class Bar(SingletonConfigurable): pass
>>> class Bam(Bar): pass
>>> bam = Bam.instance()
>>> bam == Bar.instance()
True
A trait for unicode strings.
A trait for unicode strings.
Load the config file.
By default, errors in loading config are handled, and a warning printed on screen. For testing, the suppress_errors option is set to False, so errors will make tests fail.
An enum that whose value must be in a given sequence.
A boolean (True, False) trait.
A trait for unicode strings.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
An integer trait.
Longs that are unnecessary (<= sys.maxint) are cast to ints.
Setup a handler to be called when a trait changes.
This is used to setup dynamic notifications of trait changes.
Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).
Parameters : | handler : callable
name : list, str, None
remove : bool
|
---|
A trait for unicode strings.
A boolean (True, False) trait.
Parse the command line arguments.
Print the alias part of the help.
Print the application description.
Print usage and examples.
This usage string goes at the end of the command line help string and should contain examples of the application’s usage.
Print the flag part of the help.
Print the help for each Configurable class in self.classes.
If classes=False (the default), only flags and aliases are printed.
Print the subcommand part of the help.
Print the version string.
A trait for unicode strings.
Remove the pid file.
This should be called at shutdown by registering a callback with reactor.addSystemEventTrigger(). This needs to return None.
auto generate default config file, and stage it into the profile.
Start the app for the engines subcommand.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
A trait for unicode strings.
An instance of a Python dict.
Get metadata values for trait by key.
Get a list of all the names of this classes traits.
Get a list of all the traits of this class.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
Fire the traits events when the config is updated.
A boolean (True, False) trait.
A trait for unicode strings.
A trait for unicode strings.
Create a .pid file in the pid_dir with my pid.
This must be called after pre_construct, which sets self.pid_dir. This raises PIDFileError if the pid file exists already.
Bases: IPython.parallel.apps.ipclusterapp.IPClusterEngines
An instance of a Python dict.
A boolean (True, False) trait.
import and instantiate a Launcher based on importstring
A trait for unicode strings.
Get the config class config section
Get the help string for this class in ReST format.
If inst is given, it’s current trait values will be used in place of class defaults.
Get the help string for a single trait.
If inst is given, it’s current trait values will be used in place of the class default.
Get the help string for a single trait and print it.
Get a list of all the names of this classes traits.
This method is just like the trait_names() method, but is unbound.
Get a list of all the traits of this class.
This method is just like the traits() method, but is unbound.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
An instance of a Python list.
A boolean (True, False) trait.
unset _instance for this class and singleton parents.
A trait for unicode strings.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
A trait for unicode strings.
An instance of a Python list.
A boolean (True, False) trait.
An instance of a Python list.
A string holding a valid dotted object name in Python, such as A.b3._c
A boolean (True, False) trait.
alias of ParallelCrashHandler
A boolean (True, False) trait.
A casting version of the float trait.
An integer trait.
Longs that are unnecessary (<= sys.maxint) are cast to ints.
A string holding a valid dotted object name in Python, such as A.b3._c
prevent parent.engines_stopped from stopping everything on engine shutdown
this is sys.excepthook after init_crashhandler
set self.verbose_crash=True to use our full crashhandler, instead of a regular traceback with a short message (crash_handler_lite)
An instance of a Python list.
An instance of a Python dict.
flatten flags and aliases, so cl-args override as expected.
This prevents issues such as an alias pointing to InteractiveShell, but a config file setting the same trait in TerminalInteraciveShell getting inappropriate priority over the command-line arg.
Only aliases with exactly one descendent in the class list will be promoted.
generate default config file from Configurables
Get the pid from the pid file.
If the pid file doesn’t exist a PIDFileError is raised.
[optionally] copy default config files into profile dir.
Create a crash handler, typically setting sys.excepthook to it.
Start logging for this application.
The default is to log to stdout using a StreaHandler. The log level starts at loggin.WARN, but this can be adjusted by setting the log_level attribute.
initialize the profile dir
Initialize a subcommand with argv.
Has an instance been created?
Returns a global instance of this class.
This method create a new instance if none have previously been created and returns a previously created instance is one already exists.
The arguments and keyword arguments passed to this method are passed on to the __init__() method of the class upon instantiation.
Examples
Create a singleton class using instance, and retrieve it:
>>> from IPython.config.configurable import SingletonConfigurable
>>> class Foo(SingletonConfigurable): pass
>>> foo = Foo.instance()
>>> foo == Foo.instance()
True
Create a subclass that is retrived using the base class instance:
>>> class Bar(SingletonConfigurable): pass
>>> class Bam(Bar): pass
>>> bam = Bam.instance()
>>> bam == Bar.instance()
True
A trait for unicode strings.
A trait for unicode strings.
Load the config file.
By default, errors in loading config are handled, and a warning printed on screen. For testing, the suppress_errors option is set to False, so errors will make tests fail.
An enum that whose value must be in a given sequence.
A boolean (True, False) trait.
A trait for unicode strings.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
An integer trait.
Longs that are unnecessary (<= sys.maxint) are cast to ints.
Setup a handler to be called when a trait changes.
This is used to setup dynamic notifications of trait changes.
Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).
Parameters : | handler : callable
name : list, str, None
remove : bool
|
---|
A trait for unicode strings.
A boolean (True, False) trait.
Parse the command line arguments.
Print the alias part of the help.
Print the application description.
Print usage and examples.
This usage string goes at the end of the command line help string and should contain examples of the application’s usage.
Print the flag part of the help.
Print the help for each Configurable class in self.classes.
If classes=False (the default), only flags and aliases are printed.
Print the subcommand part of the help.
Print the version string.
A trait for unicode strings.
Remove the pid file.
This should be called at shutdown by registering a callback with reactor.addSystemEventTrigger(). This needs to return None.
A boolean (True, False) trait.
auto generate default config file, and stage it into the profile.
Start the app for the start subcommand.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
A trait for unicode strings.
An instance of a Python dict.
Get metadata values for trait by key.
Get a list of all the names of this classes traits.
Get a list of all the traits of this class.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
Fire the traits events when the config is updated.
A boolean (True, False) trait.
A trait for unicode strings.
A trait for unicode strings.
Create a .pid file in the pid_dir with my pid.
This must be called after pre_construct, which sets self.pid_dir. This raises PIDFileError if the pid file exists already.
Bases: IPython.parallel.apps.baseapp.BaseParallelApplication
An instance of a Python dict.
A boolean (True, False) trait.
A trait for unicode strings.
Get the config class config section
Get the help string for this class in ReST format.
If inst is given, it’s current trait values will be used in place of class defaults.
Get the help string for a single trait.
If inst is given, it’s current trait values will be used in place of the class default.
Get the help string for a single trait and print it.
Get a list of all the names of this classes traits.
This method is just like the trait_names() method, but is unbound.
Get a list of all the traits of this class.
This method is just like the traits() method, but is unbound.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
An instance of a Python list.
A boolean (True, False) trait.
unset _instance for this class and singleton parents.
A trait for unicode strings.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
A trait for unicode strings.
An instance of a Python list.
A boolean (True, False) trait.
An instance of a Python list.
A boolean (True, False) trait.
alias of ParallelCrashHandler
this is sys.excepthook after init_crashhandler
set self.verbose_crash=True to use our full crashhandler, instead of a regular traceback with a short message (crash_handler_lite)
An instance of a Python list.
An instance of a Python dict.
flatten flags and aliases, so cl-args override as expected.
This prevents issues such as an alias pointing to InteractiveShell, but a config file setting the same trait in TerminalInteraciveShell getting inappropriate priority over the command-line arg.
Only aliases with exactly one descendent in the class list will be promoted.
generate default config file from Configurables
Get the pid from the pid file.
If the pid file doesn’t exist a PIDFileError is raised.
[optionally] copy default config files into profile dir.
Create a crash handler, typically setting sys.excepthook to it.
Start logging for this application.
The default is to log to stdout using a StreaHandler. The log level starts at loggin.WARN, but this can be adjusted by setting the log_level attribute.
initialize the profile dir
initialize the app
Initialize a subcommand with argv.
Has an instance been created?
Returns a global instance of this class.
This method create a new instance if none have previously been created and returns a previously created instance is one already exists.
The arguments and keyword arguments passed to this method are passed on to the __init__() method of the class upon instantiation.
Examples
Create a singleton class using instance, and retrieve it:
>>> from IPython.config.configurable import SingletonConfigurable
>>> class Foo(SingletonConfigurable): pass
>>> foo = Foo.instance()
>>> foo == Foo.instance()
True
Create a subclass that is retrived using the base class instance:
>>> class Bar(SingletonConfigurable): pass
>>> class Bam(Bar): pass
>>> bam = Bam.instance()
>>> bam == Bar.instance()
True
A trait for unicode strings.
A trait for unicode strings.
Load the config file.
By default, errors in loading config are handled, and a warning printed on screen. For testing, the suppress_errors option is set to False, so errors will make tests fail.
An enum that whose value must be in a given sequence.
A boolean (True, False) trait.
A trait for unicode strings.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
Setup a handler to be called when a trait changes.
This is used to setup dynamic notifications of trait changes.
Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).
Parameters : | handler : callable
name : list, str, None
remove : bool
|
---|
A trait for unicode strings.
A boolean (True, False) trait.
Parse the command line arguments.
Print the alias part of the help.
Print the application description.
Print usage and examples.
This usage string goes at the end of the command line help string and should contain examples of the application’s usage.
Print the flag part of the help.
Print the help for each Configurable class in self.classes.
If classes=False (the default), only flags and aliases are printed.
Print the subcommand part of the help.
Print the version string.
A trait for unicode strings.
Remove the pid file.
This should be called at shutdown by registering a callback with reactor.addSystemEventTrigger(). This needs to return None.
An integer trait.
Longs that are unnecessary (<= sys.maxint) are cast to ints.
auto generate default config file, and stage it into the profile.
Start the app for the stop subcommand.
A trait whose value must be an instance of a specified class.
The value can also be an instance of a subclass of the specified class.
A trait for unicode strings.
An instance of a Python dict.
Get metadata values for trait by key.
Get a list of all the names of this classes traits.
Get a list of all the traits of this class.
The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.
This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.
Fire the traits events when the config is updated.
A boolean (True, False) trait.
A trait for unicode strings.
A trait for unicode strings.
Create a .pid file in the pid_dir with my pid.
This must be called after pre_construct, which sets self.pid_dir. This raises PIDFileError if the pid file exists already.