tfx.orchestration.experimental.interactive.notebook_extensions.skip.SkipMagics

Base class for implementing magic functions.

Shell functions which can be reached as %function_name. All magic functions should accept a string, which they can parse for their own needs. This can make some functions easier to type, eg %cd ../ vs. %cd("../")

Classes providing magic functions need to subclass this class, and they MUST:

  • Use the method decorators @line_magic and @cell_magic to decorate individual methods as magic functions, AND

  • Use the class decorator @magics_class to ensure that the magic methods are properly registered at the instance level upon instance initialization.

See :mod:magic_functions for examples of actual implementation classes.

cross_validation_lock A contextmanager for running a block with our cross validation lock set to True.

At the end of the block, the lock's value is restored to its value prior to entering the block.

Methods

add_traits

Dynamically add trait attributes to the HasTraits instance.

arg_err

Print docstring if incorrect arguments were passed

class_config_rst_doc

Generate rST documentation for this class' config options.

Excludes traits defined on parent classes.

class_config_section

Get the config section for this class.

Parameters

classes : list, optional The list of other classes in the config file. Used to reduce redundant information.

class_get_help

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.

class_get_trait_help

Get the helptext string for a single trait.

:param inst: If given, it's current trait values will be used in place of the class default. :param helptext: If not given, uses the help attribute of the current trait.

class_own_trait_events

Get a dict of all event handlers defined on this class, not a parent.

Works like event_handlers, except for excluding traits from parents.

class_own_traits

Get a dict of all the traitlets defined on this class, not a parent.

Works like class_traits, except for excluding traits from parents.

class_print_help

Get the help string for a single trait and print it.

class_trait_names

Get a list of all the names of this class' traits.

This method is just like the :meth:trait_names method, but is unbound.

class_traits

Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

This method is just like the :meth:traits method, but is unbound.

The TraitTypes returned don't know anything about the values that the various HasTrait's instances are holding.

The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should take a single value as an argument and return a boolean. If any function returns False, then the trait is not included in the output. If a metadata key doesn't exist, None will be passed to the function.

default_option

Make an entry in the options_table for fn, with value optstr

format_latex

Format a string for latex inclusion.

has_trait

Returns True if the object has a trait with the specified name.

hold_trait_notifications

Context manager for bundling trait change notifications and cross validation.

Use this when doing multiple trait assignments (init, config), to avoid race conditions in trait notifiers requesting other trait values. All trait notifications will fire after all values have been assigned.

notify_change

Notify observers of a change event

observe

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Parameters

handler : callable A callable that is called when a trait changes. Its signature should be handler(change), where change is a dictionary. The change dictionary at least holds a 'type' key.

* ``type``: the type of notification.
Other keys may be passed depending on the value of 'type'. In the
case where type is 'change', we also have the following keys:
* ``owner`` : the HasTraits instance
* ``old`` : the old value of the modified trait attribute
* ``new`` : the new value of the modified trait attribute
* ``name`` : the name of the modified trait attribute.

names : list, str, All If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name. type : str, All (default: 'change') The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

on_trait_change

DEPRECATED: 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).

If remove is True and handler is not specified, all change handlers for the specified name are uninstalled.

Parameters

handler : callable, None A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new), handler(name, old, new), or handler(name, old, new, self). name : list, str, None If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name. remove : bool If False (the default), then install the handler. If True then unintall it.

parse_options

Parse options passed to an argument string.

The interface is similar to that of :func:getopt.getopt, but it returns a :class:~IPython.utils.struct.Struct with the options as keys and the stripped argument string still as a string.

arg_str is quoted as a true sys.argv vector by using shlex.split. This allows us to easily expand variables, glob files, quote arguments, etc.

Parameters

arg_str : str The arguments to parse.

opt_str : str The options specification.

mode : str, default 'string' If given as 'list', the argument string is returned as a list (split on whitespace) instead of a string.

list_all : bool, default False Put all option values in lists. Normally only options appearing more than once are put in a list.

posix : bool, default True Whether to split the input line in POSIX mode or not, as per the conventions outlined in the :mod:shlex module from the standard library.

section_names

return section names as a list

set_trait

Forcibly sets trait attribute, including read-only attributes.

setup_instance

This is called before self.init is called.

skip_for_export

View source

trait_defaults

Return a trait's default value or a dictionary of them

Notes

Dynamically generated default values may depend on the current state of the object.

trait_events

Get a dict of all the event handlers of this class.

Parameters

name : str (default: None) The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

Returns

The event handlers associated with a trait name, or all event handlers.

trait_has_value

Returns True if the specified trait has a value.

This will return false even if getattr would return a dynamically generated default value. These default values will be recognized as existing only after they have been generated.

Example

.. code-block:: python class MyClass(HasTraits): i = Int()

mc = MyClass()
assert not mc.trait_has_value("i")
mc.i # generates a default value
assert mc.trait_has_value("i")

trait_metadata

Get metadata values for trait by key.

trait_names

Get a list of all the names of this class' traits.

trait_values

A dict of trait names and their values.

The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should take a single value as an argument and return a boolean. If any function returns False, then the trait is not included in the output. If a metadata key doesn't exist, None will be passed to the function.

Returns

A dict of trait names and their values.

Notes

Trait values are retrieved via getattr, any exceptions raised by traits or the operations they may trigger will result in the absence of a trait value in the result dict.

traits

Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

The TraitTypes returned don't know anything about the values that the various HasTrait's instances are holding.

The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should take a single value as an argument and return a boolean. If any function returns False, then the trait is not included in the output. If a metadata key doesn't exist, None will be passed to the function.

unobserve

Remove a trait change handler.

This is used to unregister handlers to trait change notifications.

Parameters

handler : callable The callable called when a trait attribute changes. names : list, str, All (default: All) The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes. type : str or All (default: 'change') The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

unobserve_all

Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

update_config

Update config and load the new values

Class Variables

  • config
  • magics
  • options_table = None
  • parent
  • registered = True
  • shell = None