Skip to content

Commit

Permalink
Composed block feature with solved nested issue (#325)
Browse files Browse the repository at this point in the history
* added working Save Block fetch data

* global input and output ports saving - added

* added links id fetch and improved getGInputsOutput function

* modified code for following global rules and added link creation refined version

* resolved issue of package name in block dialog box and same name link

* added working frontend side nested dependencies script

* added tested nested synthesis code

* fixed multiple instance issue

* removed print commands

* refined multiple instances script

* resolved the yarn.lock issue
  • Loading branch information
BkPankaj authored Sep 10, 2024
1 parent 061fdef commit fe3026b
Show file tree
Hide file tree
Showing 13 changed files with 693 additions and 108 deletions.
279 changes: 212 additions & 67 deletions backend/synthesis/synthesis.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
from django.contrib.staticfiles.utils import get_files
import json


BLOCK_DIRECTORY = 'modules'

OPTIONAL_FILES = {
Expand All @@ -25,90 +24,236 @@ def get_number_or_default(num, default):

def syntheize_modules(data: dict, zipfile: InMemoryZip) -> Tuple[InMemoryZip, Dict[str, bool]]:
'''Synthesize python code for different blocks as well as user code blocks.
Different blocks present in the project is collected.
Different blocks present in the project are collected.
Parameters of each dependency block as well as constant blocks are collected.
Blocks, parameters and the connections (wires) between the blocks stored in a
JSON file.
'''
# Initialize an empty dictionary for tracking dependencies, blocks, parameters, synhronize_frequency, optional_files
dependencies = {}
blocks = {}
parameters = {}
synhronize_frequency = {}
optional_files = {}
wire_comp = data['design']['graph']['wires'] # Retrieve all wire connections from the design graph
dep_no = {} # Dictionary to store the number of blocks of each type

# Function to process dependencies and extract block information
def process_dependency(dep, zipfile, synhronize_frequency, optional_files, dep_no, parameters, dependencies):
# Iterate over each dependency
for key, dependency in dep.items():

components = dependency['design']['graph']['blocks'] # Retrieve all blocks in the dependency
wire_comp.extend(dependency['design']['graph']['wires']) # Add all wires from the dependency to the main wire list
# Iterate over each block in the dependency
for block in components:

block_id = block['id']
block_type = block['type']

# Check if the block is of type 'basic.code'
if block_type == 'basic.code':

script = block['data']['code'] # Retrieve the script code from the block's data
script_name = dependency['package']['name'] # Retrieve the script name from the dependency package
synhronize_frequency[block_id] = get_number_or_default(block['data'].get('frequency', 30), 30) # Set the synchronization frequency, defaulting to 30

# Check if the script name is already in optional files
if script_name in optional_files:
optional_files[script_name] = True # Mark the script as required in optional files

script_name += dependency['package']['version'].replace('.', '') # Append version number to the script name, removing dots

# Increment the count for this script type or initialize it
if script_name in dep_no:
dep_no[script_name] += 1
else:
dep_no[script_name] = 1


script_name += str(dep_no[script_name]) # Add the block count to the script name
dependencies[key] = script_name # Map the key to the script name in dependencies


zipfile.append(f'{BLOCK_DIRECTORY}/{script_name}.py', script) # Add the script to the zipfile
blocks[block_id] = {'name': script_name, 'type': block_type} # Store block information in the blocks dictionary

# Check if the block is of type 'basic.constant'
elif block_type == 'basic.constant':
parameters[block_id] = parameters.get(block_id, []) # Initialize parameter list for the block if not already present

# Append block's parameter data to the parameters dictionary
parameters[block_id].append({
'id': block['id'],
'name': block['data']['name'],
'value': block['data']['value']}
)

dep_no = {} # Dictionary to store the number of blocks of each type

for key, dependency in data['dependencies'].items():

components = dependency['design']['graph']['blocks']

for block in components:
if block['type'] == 'basic.code':
# If code, generate python file.
script = block['data']['code']
# The file name is stored in script_name here
script_name = dependency['package']['name']
synhronize_frequency[key] = get_number_or_default(block['data'].get('frequency', 30), 30)
# Mark the optional files required by the current block, if needed.
if script_name in OPTIONAL_FILES:
optional_files[script_name] = True

# The version name is simply added to the name of the file
script_name += dependency['package']['version'].replace('.', '')

# If the block already exists, then add 1 to the number to be appended to it
if script_name in dep_no:
dep_no[script_name] += 1
else:
dep_no[script_name] = 1

# Add the block number to the end of the block's name
script_name += str(dep_no[script_name])

dependencies[key] = script_name

# Python file is created
zipfile.append(f'{BLOCK_DIRECTORY}/{script_name}.py', script)

elif block['type'] == 'basic.constant':
# If constant, it is a parameter.
# Since this is a parameter for a dependency block we make the dependency type block
# as the key. This is later used to identify which parameter belongs to which dependency
# block
parameters[key] = parameters.get(key, [])
parameters[key].append({
'id': block['id'],
'name': block['data']['name'],
'value': block['data']['value']}
)

count = 1
# Recursively process nested dependencies if present
if 'dependencies' in dependency and dependency['dependencies']:
process_dependency(dependency['dependencies'], zipfile, synhronize_frequency, optional_files, dep_no, parameters, dependencies)

# Process the top-level dependencies from the data
if 'dependencies' in data:
process_dependency(data['dependencies'], zipfile, synhronize_frequency, optional_files, dep_no, parameters, dependencies)


count = 1 # Initialize a counter for naming blocks


# Iterate over the blocks in the main design graph
for block in data['design']['graph']['blocks']:
block_id, block_type = block['id'], block['type']
if block_type == 'basic.code':
# If code, generate python file.
code_name = "Code_"+str(count)
count += 1
script = block['data']['code']
synhronize_frequency[block_id] = get_number_or_default(block['data'].get('frequency', 30), 30)
zipfile.append(f'{BLOCK_DIRECTORY}/{code_name}.py', script)
blocks[block_id] = {'name': code_name, 'type': block_type}
elif block_type == 'basic.constant':
# If constant, it is a parameter.
# Since this is a parameter at project level, we make the key as constant block ID
parameters[block_id] = [{'name': block['data']['name'], 'value': block['data']['value']}]
else:
# TODO: Check how input and output blocks behave.
# This behaviour is for Package blocks only
blocks[block_id] = {'name': dependencies[block_type], 'type': block_type}

if 'source' not in block and 'target' not in block: # Skip blocks that have a 'source' or 'target' property

block_id, block_type = block['id'], block['type']
# Check if the block is of type 'basic.code'
if block_type == 'basic.code':

code_name = "Code_" + str(count) # Generate a unique code name for the block
count += 1 # Increment the block counter
script = block['data']['code'] # Retrieve the script code from the block's data

# Set the synchronization frequency, defaulting to 30
synhronize_frequency[block_id] = get_number_or_default(block['data'].get('frequency', 30), 30)
zipfile.append(f'{BLOCK_DIRECTORY}/{code_name}.py', script) # Add the script to the zipfile with the generated code name
blocks[block_id] = {'name': code_name, 'type': block_type} # Store block information in the blocks dictionary

# Check if the block is of type 'basic.constant'
elif block_type == 'basic.constant':
# Add block's parameter data to the parameters dictionary
parameters[block_id] = [{'name': block['data']['name'], 'value': block['data']['value']}]


valid_wires = [] # Initialize a list to store valid wire connections


# Iterate over all wires in the wire component list
for wire in wire_comp:

# Retrieve source and target block IDs for the wire
source_id = wire['source']['block']
target_id = wire['target']['block']

# Check if the source and target blocks are in the blocks or parameters dictionary
source_in_blocks = source_id in blocks
source_in_parameters = source_id in parameters
target_in_blocks = target_id in blocks
target_in_parameters = target_id in parameters

# Validate wires based on presence in blocks or parameters dictionaries
if (source_in_blocks and target_in_blocks) or \
(source_in_parameters and target_in_parameters) or \
(source_in_blocks and target_in_parameters) or \
(source_in_parameters and target_in_blocks):
# If valid, add the wire to the valid_wires list
valid_wires.append(wire)
else:
# Mark source and target as 'absent' if not in blocks or parameters
if source_id not in blocks and source_id not in parameters:
wire['source']['ob'] = 'absent'
if target_id not in blocks and target_id not in parameters:
wire['target']['ob'] = 'absent'
# Add the wire to the valid_wires list
valid_wires.append(wire)

# Function to process wires and handle absent blocks
def process_wires(valid_wires):
# Initialize dictionaries to track source and target ports
wire_check_source = {}
wire_check_target = {}

# Initialize a counter for iteration
count = 0
# Set a flag to detect changes
changes_detected = True

# Continue processing while changes are detected
while changes_detected:
changes_detected = False

data = {'blocks': blocks, 'parameters': parameters, 'synchronize_frequency': synhronize_frequency, 'wires': data['design']['graph']['wires']}
# Iterate over valid wires in reverse order
for i in range(len(valid_wires) - 1, -1, -1):
wire = valid_wires[i]
remove_wire = False # Flag to determine if the wire should be removed

count += 1 # Increment the counter

# Check if the source port is 'input-out'
if wire['source']['port'] == 'input-out':
port_name = wire['source']['block']
# Check if the target is marked 'absent'
if 'ob' in wire['target'] and wire['target']['ob'] == 'absent':
# Add target details to wire_check_source with 'input-out' port
wire_check_source[port_name] = wire['target'].copy()
wire_check_source[port_name]['port'] = port_name
else:
# Add target details to wire_check_source
wire_check_source[port_name] = wire['target']
# Mark the wire for removal
remove_wire = True

# Check if the target port is 'output-in'
if wire['target']['port'] == 'output-in':
port_name = wire['target']['block']
# Check if the source is marked 'absent'
if 'ob' in wire['source'] and wire['source']['ob'] == 'absent':
# Add source details to wire_check_target with 'output-in' port
wire_check_target[port_name] = wire['source'].copy()
wire_check_target[port_name]['port'] = port_name
else:
# Add source details to wire_check_target
wire_check_target[port_name] = wire['source']
# Mark the wire for removal
remove_wire = True

# Remove the wire from valid_wires if marked for removal
if remove_wire:
del valid_wires[i]
changes_detected = True # Set flag to true since changes were made

# Iterate over the valid wires to update ports
for i, wire in enumerate(valid_wires):
# Check if the source port name has 36 characters
if len(wire['source'].get('port', '')) == 36:
port_name = wire['source']['port']
# Update source with wire_check_target details if present
if port_name in wire_check_target:
valid_wires[i]['source'] = wire_check_target[port_name]
# Update port name if 'absent' flag is present
if 'ob' in valid_wires[i]['source']:
valid_wires[i]['source']['port'] = port_name

# Check if the target port name has 36 characters
if len(wire['target'].get('port', '')) == 36:
port_name = wire['target']['port']
# Update target with wire_check_source details if present
if port_name in wire_check_source:
valid_wires[i]['target'] = wire_check_source[port_name]
# Update port name if 'absent' flag is present
if 'ob' in valid_wires[i]['target']:
valid_wires[i]['target']['port'] = port_name

# Return the processed list of valid wires
return valid_wires

# Process the wires to handle 'absent' blocks
processed_wires = process_wires(valid_wires)

# Create a final data dictionary with blocks, parameters, frequencies, and wires
data = {
'blocks': blocks,
'parameters': parameters,
'synchronize_frequency': synhronize_frequency,
'wires': processed_wires
}
# Add the data dictionary as a JSON file in the zipfile
zipfile.append('data.json', json.dumps(data))

# Return the updated zipfile and optional files dictionary
return zipfile, optional_files


def synthesize_executioner(zipfile: InMemoryZip, optional_files: Dict[str, bool]) -> InMemoryZip:
'''Synthesize python code necessary to run the blocks.
All these files are present in django static directory.
Expand Down
30 changes: 24 additions & 6 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"closest": "0.0.1",
"dagre": "^0.8.5",
"lodash": "^4.17.21",
"lodash.clonedeep": "^4.5.0",
"pathfinding": "^0.4.18",
"paths-js": "^0.4.11",
"react": "^17.0.2",
Expand Down Expand Up @@ -56,5 +57,8 @@
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"@types/lodash.clonedeep": "^4.5.9"
}
}
Loading

0 comments on commit fe3026b

Please sign in to comment.