Skip to content

dev

dev.dummy

                                                                                
 Documentation                                                                  
                          Module that simulates processing, but uses            
                          hard-coded outputs as a result.                       
                                                                                
 Origin                                                                         
                          Authors   Markus Binsteiner (markus@frkl.io)          
                                                                                
 Context                                                                        
                          Tags         core                                     
                          Labels       package: kiara_modules.core              
                          References   source_repo:                             
                                       https://github.com/DHARPA-Project/kia…   
                                       documentation:                           
                                       https://dharpa.org/kiara_modules.core/   
                                       module_doc:                              
                                       https://dharpa.org/kiara_modules.core…   
                                       source_url:                              
                                       https://github.com/DHARPA-Project/kia…   
                                                                                
 Module config                                                                  
                          Field           Type     Description       Required   
                         ─────────────────────────────────────────────────────  
                          constants       object   Value constants   no         
                                                   for this                     
                                                   module.                      
                          defaults        object   Value defaults    no         
                                                   for this                     
                                                   module.                      
                          documentation   string                     no         
                          input_schema    object   The input         yes        
                                                   schema for this              
                                                   module.                      
                          output_schema   object   The output        yes        
                                                   schema for this              
                                                   module.                      
                          outputs         object   The (dummy)       no         
                                                   output for this              
                                                   module.                      
                          delay           number   The delay in      no         
                                                   seconds from                 
                                                   processing                   
                                                   start to when                
                                                   the (dummy)                  
                                                   outputs are                  
                                                   returned.                    
                                                                                
 Module config          -- no config --                                         
 Python class                                                                   
                          class_name    DummyModule                             
                          module_name   kiara_modules.core.dev                  
                          full_name     kiara_modules.core.dev.DummyModule      
                                                                                
 Processing source code  ─────────────────────────────────────────────────────  
                          def process(self, inputs: ValueSet, outputs: Value…   
                              """Returns the hardcoded output values that ar…   
                                                                                
                              Optionally, this module can simulate processin…   
                              """                                               
                                                                                
                              time.sleep(self.config.get("delay"))  # type: …   
                                                                                
                              output_values: typing.Mapping = self.config.ge…   
                                                                                
                              value_dict = {}                                   
                              for output_name in self.output_names:             
                                  if output_name not in output_values.keys():   
                                      raise NotImplementedError()               
                                      # v = self.output_schemas[output_name]…   
                                      # value_dict[output_name] = v             
                                  else:                                         
                                      value_dict[output_name] = output_value…   
                              outputs.set_values(**value_dict)                  
                                                                                
                         ─────────────────────────────────────────────────────