Changeset 11419:719c8b4b6b69 in orange


Ignore:
Timestamp:
03/21/13 15:31:53 (13 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Fixed docstrings for scheme subpackage.

Files:
7 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/scheme/__init__.py

    r11367 r11419  
    66The scheme package implements and defines the underlying workflow model. 
    77 
    8 The :class:`Scheme` class represents the workflow and is composed of a set 
    9 of :class:`SchemeNode` connected with :class:`SchemeLink`, defining an 
     8The :class:`.Scheme` class represents the workflow and is composed of a set 
     9of :class:`.SchemeNode` connected with :class:`.SchemeLink`, defining an 
    1010directed acyclic graph (DAG). Additionally instances of 
    11 :class:`SchemeArrowAnnotation` or :class:`SchemeTextAnnotation` can be 
     11:class:`.SchemeArrowAnnotation` or :class:`.SchemeTextAnnotation` can be 
    1212inserted into the scheme. 
    1313 
  • Orange/OrangeCanvas/scheme/link.py

    r11367 r11419  
    7171    """ 
    7272 
     73    #: The link enabled state has changed 
    7374    enabled_changed = Signal(bool) 
     75 
     76    #: The link dynamic enabled state has changed. 
    7477    dynamic_enabled_changed = Signal(bool) 
    7578 
  • Orange/OrangeCanvas/scheme/node.py

    r11367 r11419  
    8080                         (name, self.description.name)) 
    8181 
    82     # The title of the node has changed 
     82    #: The title of the node has changed 
    8383    title_changed = Signal(unicode) 
    8484 
     
    9393    def title(self): 
    9494        """ 
    95         Return the node title. 
     95        The node title. 
    9696        """ 
    9797        return self.__title 
     
    9999    title = Property(unicode, fset=set_title, fget=title) 
    100100 
    101     # Position of the node in the scheme has changed 
     101    #: Position of the node in the scheme has changed 
    102102    position_changed = Signal(tuple) 
    103103 
     
    118118    position = Property(tuple, fset=set_position, fget=position) 
    119119 
    120     # Node's progress value has changed. 
     120    #: Node's progress value has changed. 
    121121    progress_changed = Signal(float) 
    122122 
     
    131131    def progress(self): 
    132132        """ 
    133         Return the current progress value. -1 if progress is not set. 
     133        The current progress value. -1 if progress is not set. 
    134134        """ 
    135135        return self.__progress 
     
    137137    progress = Property(float, fset=set_progress, fget=progress) 
    138138 
    139     # Node's processing state has changed. 
     139    #: Node's processing state has changed. 
    140140    processing_state_changed = Signal(int) 
    141141 
     
    150150    def processing_state(self): 
    151151        """ 
    152         Return the node processing state, 0 for not processing, 1 the 
    153         node is busy. 
    154  
     152        The node processing state, 0 for not processing, 1 the node is busy. 
    155153        """ 
    156154        return self.__processing_state 
  • Orange/OrangeCanvas/scheme/scheme.py

    r11391 r11419  
    3030from .readwrite import scheme_to_ows_stream, parse_scheme 
    3131 
    32 from ..registry import WidgetDescription 
     32from ..registry import WidgetDescription, InputSignal, OutputSignal 
    3333 
    3434log = logging.getLogger(__name__) 
     
    201201        See also 
    202202        -------- 
    203         SchemeNode, Scheme.add_node 
     203        .SchemeNode, Scheme.add_node 
    204204 
    205205        """ 
     
    275275                 sink_node, sink_channel): 
    276276        """ 
    277         Create a new SchemeLink and add it to the scheme. 
    278  
    279         Same as:: 
    280  
    281             scheme.add_link(SchemeLink(source_node, source_channel, 
    282                                        sink_node, sink_channel)) 
     277        Create a new :class:`.SchemeLink` from arguments and add it to 
     278        the scheme. The new link is returned. 
    283279 
    284280        Parameters 
     
    286282        source_node : :class:`.SchemeNode` 
    287283            Source node of the new link. 
    288         source_channel : :class:`OutputSignal` 
     284        source_channel : :class:`.OutputSignal` 
    289285            Source channel of the new node. The instance must be from 
    290             `source_node.output_channels()` 
     286            ``source_node.output_channels()`` 
    291287        sink_node : :class:`.SchemeNode` 
    292288            Sink node of the new link. 
    293         sink_channel : :class:`InputSignal` 
     289        sink_channel : :class:`.InputSignal` 
    294290            Sink channel of the new node. The instance must be from 
    295             `sink_node.input_channels()` 
     291            ``sink_node.input_channels()`` 
    296292 
    297293        See also 
    298294        -------- 
    299         SchemeLink, Scheme.add_link 
     295        .SchemeLink, Scheme.add_link 
    300296 
    301297        """ 
     
    328324    def check_connect(self, link): 
    329325        """ 
    330         Check if the `link` can be added to the scheme. 
     326        Check if the `link` can be added to the scheme and raise an 
     327        appropriate exception. 
    331328 
    332329        Can raise: 
    333330            - :class:`TypeError` if `link` is not an instance of 
    334331              :class:`.SchemeLink` 
    335             - :class:`SchemeCycleError` if the `link` would introduce a cycle 
    336             - :class:`IncompatibleChannelTypeError` if the channel types are 
     332            - :class:`.SchemeCycleError` if the `link` would introduce a cycle 
     333            - :class:`.IncompatibleChannelTypeError` if the channel types are 
    337334              not compatible 
    338             - :class:`SinkChannelError` if a sink channel has a `Single` flag 
     335            - :class:`.SinkChannelError` if a sink channel has a `Single` flag 
    339336              specification and the channel is already connected. 
    340             - :class:`DuplicatedLinkError` if a `link` duplicates an already 
     337            - :class:`.DuplicatedLinkError` if a `link` duplicates an already 
    341338              present link. 
    342339 
     
    375372    def creates_cycle(self, link): 
    376373        """ 
    377         Would the `link` if added to the scheme introduce a cycle. 
     374        Return `True` if `link` would introduce a cycle in the scheme. 
     375 
     376        Parameters 
     377        ---------- 
     378        link : :class:`.SchemeLink` 
     379 
    378380        """ 
    379381        check_type(link, SchemeLink) 
     
    385387    def compatible_channels(self, link): 
    386388        """ 
    387         Do the channels in `link` have compatible types. 
     389        Return `True` if the channels in `link` have compatible types. 
     390 
     391        Parameters 
     392        ---------- 
     393        link : :class:`.SchemeLink` 
     394 
    388395        """ 
    389396        check_type(link, SchemeLink) 
     
    391398 
    392399    def can_connect(self, link): 
     400        """ 
     401        Return `True` if `link` can be added to the scheme. 
     402 
     403        See also 
     404        -------- 
     405        Scheme.check_connect 
     406 
     407        """ 
     408        check_type(link, SchemeLink) 
    393409        try: 
    394410            self.check_connect(link) 
    395411            return True 
    396         except (SchemeCycleError, IncompatibleChannelTypeError): 
     412        except (SchemeCycleError, IncompatibleChannelTypeError, 
     413                SinkChannelError, DuplicatedLinkError): 
    397414            return False 
    398         except Exception: 
    399             raise 
    400415 
    401416    def upstream_nodes(self, start_node): 
    402417        """ 
    403         Return a set of all nodes upstream from `start_node`. 
     418        Return a set of all nodes upstream from `start_node` (i.e. 
     419        all ancestor nodes). 
     420 
     421        Parameters 
     422        ---------- 
     423        start_node : :class:`.SchemeNode` 
     424 
    404425        """ 
    405426        visited = set() 
     
    419440        """ 
    420441        Return a set of all nodes downstream from `start_node`. 
     442 
     443        Parameters 
     444        ---------- 
     445        start_node : :class:`.SchemeNode` 
     446 
    421447        """ 
    422448        visited = set() 
     
    438464        of the child in the workflow). Both nodes must be in the scheme. 
    439465 
     466        Parameters 
     467        ---------- 
     468        node : :class:`.SchemeNode` 
     469        child : :class:`.SchemeNode` 
     470 
    440471        """ 
    441472        return child in self.downstream_nodes(node) 
     
    455486    def input_links(self, node): 
    456487        """ 
    457         Return all input links connected to the `node` instance. 
     488        Return a list of all input links (:class:`.SchemeLink`) connected 
     489        to the `node` instance. 
     490 
    458491        """ 
    459492        return self.find_links(sink_node=node) 
     
    461494    def output_links(self, node): 
    462495        """ 
    463         Return all output links connected to the `node` instance. 
     496        Return a list of all output links (:class:`.SchemeLink`) connected 
     497        to the `node` instance. 
     498 
    464499        """ 
    465500        return self.find_links(source_node=node) 
  • docs/canvas/scheme.link.rst

    r11367 r11419  
    1010.. autoclass:: SchemeLink 
    1111   :members: 
     12   :exclude-members: 
     13      enabled_changed, 
     14      dynamic_enabled_changed 
    1215   :member-order: bysource 
    1316   :show-inheritance: 
     17 
     18   .. autoattribute:: enabled_changed(enabled) 
     19 
     20   .. autoattribute:: dynamic_enabled_changed(enabled) 
  • docs/canvas/scheme.node.rst

    r11367 r11419  
    1010.. autoclass:: SchemeNode 
    1111   :members: 
     12   :exclude-members: 
     13      title_changed, 
     14      position_changed, 
     15      progress_changed, 
     16      processing_state_changed 
    1217   :member-order: bysource 
    1318   :show-inheritance: 
     
    1621 
    1722   .. autoattribute:: position_changed((x, y)) 
     23 
     24   .. autoattribute:: progress_changed(progress) 
     25 
     26   .. autoattribute:: processing_state_changed(state) 
  • docs/canvas/scheme.scheme.rst

    r11367 r11419  
    4343 
    4444      Signal emitted when a `annotation` is removed from the scheme. 
     45 
     46 
     47.. autoclass:: SchemeCycleError 
     48   :show-inheritance: 
     49 
     50 
     51.. autoclass:: IncompatibleChannelTypeError 
     52   :show-inheritance: 
     53 
     54 
     55.. autoclass:: SinkChannelError 
     56   :show-inheritance: 
     57 
     58 
     59.. autoclass:: DuplicatedLinkError 
     60   :show-inheritance: 
Note: See TracChangeset for help on using the changeset viewer.